@aws-sdk/client-pinpoint 3.325.0 → 3.326.0

package/dist-types/commands/SendMessagesCommand.d.ts

@@ -232,6 +232,32 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
  * };
  * const command = new SendMessagesCommand(input);
  * const response = await client.send(command);
+ * // { // SendMessagesResponse
+ * //   MessageResponse: { // MessageResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     EndpointResult: { // MapOfEndpointMessageResult
+ * //       "<keys>": { // 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",
+ * //       },
+ * //     },
+ * //     RequestId: "STRING_VALUE",
+ * //     Result: { // MapOfMessageResult
+ * //       "<keys>": { // MessageResult
+ * //         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 SendMessagesCommandInput - {@link SendMessagesCommandInput}
@@ -261,6 +287,8 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class SendMessagesCommand extends $Command<SendMessagesCommandInput, SendMessagesCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/SendOTPMessageCommand.d.ts

@@ -44,6 +44,32 @@ export interface SendOTPMessageCommandOutput extends SendOTPMessageResponse, __M
  * };
  * const command = new SendOTPMessageCommand(input);
  * const response = await client.send(command);
+ * // { // SendOTPMessageResponse
+ * //   MessageResponse: { // MessageResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     EndpointResult: { // MapOfEndpointMessageResult
+ * //       "<keys>": { // 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",
+ * //       },
+ * //     },
+ * //     RequestId: "STRING_VALUE",
+ * //     Result: { // MapOfMessageResult
+ * //       "<keys>": { // MessageResult
+ * //         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 SendOTPMessageCommandInput - {@link SendOTPMessageCommandInput}
@@ -73,6 +99,8 @@ export interface SendOTPMessageCommandOutput extends SendOTPMessageResponse, __M
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class SendOTPMessageCommand extends $Command<SendOTPMessageCommandInput, SendOTPMessageCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/SendUsersMessagesCommand.d.ts

@@ -222,6 +222,25 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
  * };
  * const command = new SendUsersMessagesCommand(input);
  * const response = await client.send(command);
+ * // { // SendUsersMessagesResponse
+ * //   SendUsersMessageResponse: { // SendUsersMessageResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     RequestId: "STRING_VALUE",
+ * //     Result: { // MapOfMapOfEndpointMessageResult
+ * //       "<keys>": { // MapOfEndpointMessageResult
+ * //         "<keys>": { // 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}
@@ -251,6 +270,8 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class SendUsersMessagesCommand extends $Command<SendUsersMessagesCommandInput, SendUsersMessagesCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/TagResourceCommand.d.ts

@@ -36,6 +36,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new TagResourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -44,6 +46,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new UntagResourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -42,6 +44,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UpdateAdmChannelCommand.d.ts

@@ -36,6 +36,21 @@ export interface UpdateAdmChannelCommandOutput extends UpdateAdmChannelResponse,
  * };
  * const command = new UpdateAdmChannelCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateAdmChannelResponse
+ * //   ADMChannelResponse: { // ADMChannelResponse
+ * //     ApplicationId: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE",
+ * //     Enabled: true || false,
+ * //     HasCredential: true || false,
+ * //     Id: "STRING_VALUE",
+ * //     IsArchived: true || false,
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Platform: "STRING_VALUE", // required
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateAdmChannelCommandInput - {@link UpdateAdmChannelCommandInput}
@@ -65,6 +80,8 @@ export interface UpdateAdmChannelCommandOutput extends UpdateAdmChannelResponse,
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UpdateAdmChannelCommand extends $Command<UpdateAdmChannelCommandInput, UpdateAdmChannelCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UpdateApnsChannelCommand.d.ts

@@ -41,6 +41,23 @@ export interface UpdateApnsChannelCommandOutput extends UpdateApnsChannelRespons
  * };
  * const command = new UpdateApnsChannelCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateApnsChannelResponse
+ * //   APNSChannelResponse: { // APNSChannelResponse
+ * //     ApplicationId: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE",
+ * //     DefaultAuthenticationMethod: "STRING_VALUE",
+ * //     Enabled: true || false,
+ * //     HasCredential: true || false,
+ * //     HasTokenKey: true || false,
+ * //     Id: "STRING_VALUE",
+ * //     IsArchived: true || false,
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Platform: "STRING_VALUE", // required
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApnsChannelCommandInput - {@link UpdateApnsChannelCommandInput}
@@ -70,6 +87,8 @@ export interface UpdateApnsChannelCommandOutput extends UpdateApnsChannelRespons
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UpdateApnsChannelCommand extends $Command<UpdateApnsChannelCommandInput, UpdateApnsChannelCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts

@@ -41,6 +41,23 @@ export interface UpdateApnsSandboxChannelCommandOutput extends UpdateApnsSandbox
  * };
  * const command = new UpdateApnsSandboxChannelCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateApnsSandboxChannelResponse
+ * //   APNSSandboxChannelResponse: { // APNSSandboxChannelResponse
+ * //     ApplicationId: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE",
+ * //     DefaultAuthenticationMethod: "STRING_VALUE",
+ * //     Enabled: true || false,
+ * //     HasCredential: true || false,
+ * //     HasTokenKey: true || false,
+ * //     Id: "STRING_VALUE",
+ * //     IsArchived: true || false,
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Platform: "STRING_VALUE", // required
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApnsSandboxChannelCommandInput - {@link UpdateApnsSandboxChannelCommandInput}
@@ -70,6 +87,8 @@ export interface UpdateApnsSandboxChannelCommandOutput extends UpdateApnsSandbox
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UpdateApnsSandboxChannelCommand extends $Command<UpdateApnsSandboxChannelCommandInput, UpdateApnsSandboxChannelCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts

@@ -41,6 +41,23 @@ export interface UpdateApnsVoipChannelCommandOutput extends UpdateApnsVoipChanne
  * };
  * const command = new UpdateApnsVoipChannelCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateApnsVoipChannelResponse
+ * //   APNSVoipChannelResponse: { // APNSVoipChannelResponse
+ * //     ApplicationId: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE",
+ * //     DefaultAuthenticationMethod: "STRING_VALUE",
+ * //     Enabled: true || false,
+ * //     HasCredential: true || false,
+ * //     HasTokenKey: true || false,
+ * //     Id: "STRING_VALUE",
+ * //     IsArchived: true || false,
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Platform: "STRING_VALUE", // required
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApnsVoipChannelCommandInput - {@link UpdateApnsVoipChannelCommandInput}
@@ -70,6 +87,8 @@ export interface UpdateApnsVoipChannelCommandOutput extends UpdateApnsVoipChanne
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UpdateApnsVoipChannelCommand extends $Command<UpdateApnsVoipChannelCommandInput, UpdateApnsVoipChannelCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts

@@ -41,6 +41,23 @@ export interface UpdateApnsVoipSandboxChannelCommandOutput extends UpdateApnsVoi
  * };
  * const command = new UpdateApnsVoipSandboxChannelCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateApnsVoipSandboxChannelResponse
+ * //   APNSVoipSandboxChannelResponse: { // APNSVoipSandboxChannelResponse
+ * //     ApplicationId: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE",
+ * //     DefaultAuthenticationMethod: "STRING_VALUE",
+ * //     Enabled: true || false,
+ * //     HasCredential: true || false,
+ * //     HasTokenKey: true || false,
+ * //     Id: "STRING_VALUE",
+ * //     IsArchived: true || false,
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Platform: "STRING_VALUE", // required
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApnsVoipSandboxChannelCommandInput - {@link UpdateApnsVoipSandboxChannelCommandInput}
@@ -70,6 +87,8 @@ export interface UpdateApnsVoipSandboxChannelCommandOutput extends UpdateApnsVoi
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UpdateApnsVoipSandboxChannelCommand extends $Command<UpdateApnsVoipSandboxChannelCommandInput, UpdateApnsVoipSandboxChannelCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts

@@ -51,6 +51,29 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
  * };
  * const command = new UpdateApplicationSettingsCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateApplicationSettingsResponse
+ * //   ApplicationSettingsResource: { // ApplicationSettingsResource
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     CampaignHook: { // CampaignHook
+ * //       LambdaFunctionName: "STRING_VALUE",
+ * //       Mode: "DELIVERY" || "FILTER",
+ * //       WebUrl: "STRING_VALUE",
+ * //     },
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Limits: { // CampaignLimits
+ * //       Daily: Number("int"),
+ * //       MaximumDuration: Number("int"),
+ * //       MessagesPerSecond: Number("int"),
+ * //       Total: Number("int"),
+ * //       Session: Number("int"),
+ * //     },
+ * //     QuietTime: { // QuietTime
+ * //       End: "STRING_VALUE",
+ * //       Start: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateApplicationSettingsCommandInput - {@link UpdateApplicationSettingsCommandInput}
@@ -80,6 +103,8 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UpdateApplicationSettingsCommand extends $Command<UpdateApplicationSettingsCommandInput, UpdateApplicationSettingsCommandOutput, PinpointClientResolvedConfig> {

package/dist-types/commands/UpdateBaiduChannelCommand.d.ts

@@ -36,6 +36,22 @@ export interface UpdateBaiduChannelCommandOutput extends UpdateBaiduChannelRespo
  * };
  * const command = new UpdateBaiduChannelCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateBaiduChannelResponse
+ * //   BaiduChannelResponse: { // BaiduChannelResponse
+ * //     ApplicationId: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE",
+ * //     Credential: "STRING_VALUE", // required
+ * //     Enabled: true || false,
+ * //     HasCredential: true || false,
+ * //     Id: "STRING_VALUE",
+ * //     IsArchived: true || false,
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Platform: "STRING_VALUE", // required
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateBaiduChannelCommandInput - {@link UpdateBaiduChannelCommandInput}
@@ -65,6 +81,8 @@ export interface UpdateBaiduChannelCommandOutput extends UpdateBaiduChannelRespo
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>Provides information about an API request or response.</p>
  *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
  *
  */
 export declare class UpdateBaiduChannelCommand extends $Command<UpdateBaiduChannelCommandInput, UpdateBaiduChannelCommandOutput, PinpointClientResolvedConfig> {