import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { SendUsersMessagesRequest, SendUsersMessagesResponse } from "../models/models_1"; import type { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link SendUsersMessagesCommand}. */ export interface SendUsersMessagesCommandInput extends SendUsersMessagesRequest { } /** * @public * * The output of {@link SendUsersMessagesCommand}. */ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesResponse, __MetadataBearer { } declare const SendUsersMessagesCommand_base: { new (input: SendUsersMessagesCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: SendUsersMessagesCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates and sends a message to a list of users.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PinpointClient, SendUsersMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import * // const { PinpointClient, SendUsersMessagesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import * // import type { PinpointClientConfig } from "@aws-sdk/client-pinpoint"; * const config = {}; // type is PinpointClientConfig * const client = new PinpointClient(config); * const input = { // SendUsersMessagesRequest * ApplicationId: "STRING_VALUE", // required * SendUsersMessageRequest: { // SendUsersMessageRequest * Context: { // MapOf__string * "": "STRING_VALUE", * }, * MessageConfiguration: { // DirectMessageConfiguration * ADMMessage: { // ADMMessage * Action: "OPEN_APP" || "DEEP_LINK" || "URL", * Body: "STRING_VALUE", * ConsolidationKey: "STRING_VALUE", * Data: { * "": "STRING_VALUE", * }, * ExpiresAfter: "STRING_VALUE", * IconReference: "STRING_VALUE", * ImageIconUrl: "STRING_VALUE", * ImageUrl: "STRING_VALUE", * MD5: "STRING_VALUE", * RawContent: "STRING_VALUE", * SilentPush: true || false, * SmallImageIconUrl: "STRING_VALUE", * Sound: "STRING_VALUE", * Substitutions: { // MapOfListOf__string * "": [ // ListOf__string * "STRING_VALUE", * ], * }, * Title: "STRING_VALUE", * Url: "STRING_VALUE", * }, * APNSMessage: { // APNSMessage * APNSPushType: "STRING_VALUE", * Action: "OPEN_APP" || "DEEP_LINK" || "URL", * Badge: Number("int"), * Body: "STRING_VALUE", * Category: "STRING_VALUE", * CollapseId: "STRING_VALUE", * Data: { * "": "STRING_VALUE", * }, * MediaUrl: "STRING_VALUE", * PreferredAuthenticationMethod: "STRING_VALUE", * Priority: "STRING_VALUE", * RawContent: "STRING_VALUE", * SilentPush: true || false, * Sound: "STRING_VALUE", * Substitutions: { * "": [ * "STRING_VALUE", * ], * }, * ThreadId: "STRING_VALUE", * TimeToLive: Number("int"), * Title: "STRING_VALUE", * Url: "STRING_VALUE", * }, * BaiduMessage: { // BaiduMessage * Action: "OPEN_APP" || "DEEP_LINK" || "URL", * Body: "STRING_VALUE", * Data: { * "": "STRING_VALUE", * }, * IconReference: "STRING_VALUE", * ImageIconUrl: "STRING_VALUE", * ImageUrl: "STRING_VALUE", * RawContent: "STRING_VALUE", * SilentPush: true || false, * SmallImageIconUrl: "STRING_VALUE", * Sound: "STRING_VALUE", * Substitutions: { * "": [ * "STRING_VALUE", * ], * }, * TimeToLive: Number("int"), * Title: "STRING_VALUE", * Url: "STRING_VALUE", * }, * DefaultMessage: { // DefaultMessage * Body: "STRING_VALUE", * Substitutions: { * "": [ * "STRING_VALUE", * ], * }, * }, * DefaultPushNotificationMessage: { // DefaultPushNotificationMessage * Action: "OPEN_APP" || "DEEP_LINK" || "URL", * Body: "STRING_VALUE", * Data: { * "": "STRING_VALUE", * }, * SilentPush: true || false, * Substitutions: { * "": [ * "STRING_VALUE", * ], * }, * Title: "STRING_VALUE", * Url: "STRING_VALUE", * }, * EmailMessage: { // EmailMessage * Body: "STRING_VALUE", * FeedbackForwardingAddress: "STRING_VALUE", * FromAddress: "STRING_VALUE", * RawEmail: { // RawEmail * Data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * }, * ReplyToAddresses: "", * SimpleEmail: { // SimpleEmail * HtmlPart: { // SimpleEmailPart * Charset: "STRING_VALUE", * Data: "STRING_VALUE", * }, * Subject: { * Charset: "STRING_VALUE", * Data: "STRING_VALUE", * }, * TextPart: { * Charset: "STRING_VALUE", * Data: "STRING_VALUE", * }, * Headers: [ // ListOfMessageHeader * { // MessageHeader * Name: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * }, * Substitutions: "", * }, * GCMMessage: { // GCMMessage * Action: "OPEN_APP" || "DEEP_LINK" || "URL", * Body: "STRING_VALUE", * CollapseKey: "STRING_VALUE", * Data: "", * IconReference: "STRING_VALUE", * ImageIconUrl: "STRING_VALUE", * ImageUrl: "STRING_VALUE", * PreferredAuthenticationMethod: "STRING_VALUE", * Priority: "STRING_VALUE", * RawContent: "STRING_VALUE", * RestrictedPackageName: "STRING_VALUE", * SilentPush: true || false, * SmallImageIconUrl: "STRING_VALUE", * Sound: "STRING_VALUE", * Substitutions: "", * TimeToLive: Number("int"), * Title: "STRING_VALUE", * Url: "STRING_VALUE", * }, * SMSMessage: { // SMSMessage * Body: "STRING_VALUE", * Keyword: "STRING_VALUE", * MediaUrl: "STRING_VALUE", * MessageType: "TRANSACTIONAL" || "PROMOTIONAL", * OriginationNumber: "STRING_VALUE", * SenderId: "STRING_VALUE", * Substitutions: "", * EntityId: "STRING_VALUE", * TemplateId: "STRING_VALUE", * }, * VoiceMessage: { // VoiceMessage * Body: "STRING_VALUE", * LanguageCode: "STRING_VALUE", * OriginationNumber: "STRING_VALUE", * Substitutions: "", * VoiceId: "STRING_VALUE", * }, * }, * TemplateConfiguration: { // TemplateConfiguration * EmailTemplate: { // Template * Name: "STRING_VALUE", * Version: "STRING_VALUE", * }, * PushTemplate: { * Name: "STRING_VALUE", * Version: "STRING_VALUE", * }, * SMSTemplate: { * Name: "STRING_VALUE", * Version: "STRING_VALUE", * }, * VoiceTemplate: { * Name: "STRING_VALUE", * Version: "STRING_VALUE", * }, * InAppTemplate: { * Name: "STRING_VALUE", * Version: "STRING_VALUE", * }, * }, * TraceId: "STRING_VALUE", * Users: { // MapOfEndpointSendConfiguration // required * "": { // EndpointSendConfiguration * BodyOverride: "STRING_VALUE", * Context: "", * RawContent: "STRING_VALUE", * Substitutions: "", * TitleOverride: "STRING_VALUE", * }, * }, * }, * }; * const command = new SendUsersMessagesCommand(input); * const response = await client.send(command); * // { // SendUsersMessagesResponse * // SendUsersMessageResponse: { // SendUsersMessageResponse * // ApplicationId: "STRING_VALUE", // required * // RequestId: "STRING_VALUE", * // Result: { // MapOfMapOfEndpointMessageResult * // "": { // MapOfEndpointMessageResult * // "": { // EndpointMessageResult * // Address: "STRING_VALUE", * // DeliveryStatus: "SUCCESSFUL" || "THROTTLED" || "TEMPORARY_FAILURE" || "PERMANENT_FAILURE" || "UNKNOWN_FAILURE" || "OPT_OUT" || "DUPLICATE", // required * // MessageId: "STRING_VALUE", * // StatusCode: Number("int"), // required * // StatusMessage: "STRING_VALUE", * // UpdatedToken: "STRING_VALUE", * // }, * // }, * // }, * // }, * // }; * * ``` * * @param SendUsersMessagesCommandInput - {@link SendUsersMessagesCommandInput} * @returns {@link SendUsersMessagesCommandOutput} * @see {@link SendUsersMessagesCommandInput} for command's `input` shape. * @see {@link SendUsersMessagesCommandOutput} for command's `response` shape. * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

Provides information about an API request or response.

* * @throws {@link ForbiddenException} (client fault) *

Provides information about an API request or response.

* * @throws {@link InternalServerErrorException} (server fault) *

Provides information about an API request or response.

* * @throws {@link MethodNotAllowedException} (client fault) *

Provides information about an API request or response.

* * @throws {@link NotFoundException} (client fault) *

Provides information about an API request or response.

* * @throws {@link PayloadTooLargeException} (client fault) *

Provides information about an API request or response.

* * @throws {@link TooManyRequestsException} (client fault) *

Provides information about an API request or response.

* * @throws {@link PinpointServiceException} *

Base exception class for all service exceptions from Pinpoint service.

* * * @public */ export declare class SendUsersMessagesCommand extends SendUsersMessagesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: SendUsersMessagesRequest; output: SendUsersMessagesResponse; }; sdk: { input: SendUsersMessagesCommandInput; output: SendUsersMessagesCommandOutput; }; }; }