@aws-sdk/client-pinpoint 3.325.0 → 3.327.0

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

@@ -33,6 +33,36 @@ export interface GetExportJobsCommandOutput extends GetExportJobsResponse, __Met
  * };
  * const command = new GetExportJobsCommand(input);
  * const response = await client.send(command);
+ * // { // GetExportJobsResponse
+ * //   ExportJobsResponse: { // ExportJobsResponse
+ * //     Item: [ // ListOfExportJobResponse // required
+ * //       { // ExportJobResponse
+ * //         ApplicationId: "STRING_VALUE", // required
+ * //         CompletedPieces: Number("int"),
+ * //         CompletionDate: "STRING_VALUE",
+ * //         CreationDate: "STRING_VALUE", // required
+ * //         Definition: { // ExportJobResource
+ * //           RoleArn: "STRING_VALUE", // required
+ * //           S3UrlPrefix: "STRING_VALUE", // required
+ * //           SegmentId: "STRING_VALUE",
+ * //           SegmentVersion: Number("int"),
+ * //         },
+ * //         FailedPieces: Number("int"),
+ * //         Failures: [ // ListOf__string
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Id: "STRING_VALUE", // required
+ * //         JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
+ * //         TotalFailures: Number("int"),
+ * //         TotalPieces: Number("int"),
+ * //         TotalProcessed: Number("int"),
+ * //         Type: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     NextToken: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetExportJobsCommandInput - {@link GetExportJobsCommandInput}
@@ -62,6 +92,8 @@ export interface GetExportJobsCommandOutput extends GetExportJobsResponse, __Met
  * @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 GetExportJobsCommand extends $Command<GetExportJobsCommandInput, GetExportJobsCommandOutput, PinpointClientResolvedConfig> {

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

@@ -31,6 +31,22 @@ export interface GetGcmChannelCommandOutput extends GetGcmChannelResponse, __Met
  * };
  * const command = new GetGcmChannelCommand(input);
  * const response = await client.send(command);
+ * // { // GetGcmChannelResponse
+ * //   GCMChannelResponse: { // GCMChannelResponse
+ * //     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 GetGcmChannelCommandInput - {@link GetGcmChannelCommandInput}
@@ -60,6 +76,8 @@ export interface GetGcmChannelCommandOutput extends GetGcmChannelResponse, __Met
  * @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 GetGcmChannelCommand extends $Command<GetGcmChannelCommandInput, GetGcmChannelCommandOutput, PinpointClientResolvedConfig> {

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

@@ -32,6 +32,35 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __Metad
  * };
  * const command = new GetImportJobCommand(input);
  * const response = await client.send(command);
+ * // { // GetImportJobResponse
+ * //   ImportJobResponse: { // ImportJobResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     CompletedPieces: Number("int"),
+ * //     CompletionDate: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE", // required
+ * //     Definition: { // ImportJobResource
+ * //       DefineSegment: true || false,
+ * //       ExternalId: "STRING_VALUE",
+ * //       Format: "CSV" || "JSON", // required
+ * //       RegisterEndpoints: true || false,
+ * //       RoleArn: "STRING_VALUE", // required
+ * //       S3Url: "STRING_VALUE", // required
+ * //       SegmentId: "STRING_VALUE",
+ * //       SegmentName: "STRING_VALUE",
+ * //     },
+ * //     FailedPieces: Number("int"),
+ * //     Failures: [ // ListOf__string
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     Id: "STRING_VALUE", // required
+ * //     JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
+ * //     TotalFailures: Number("int"),
+ * //     TotalPieces: Number("int"),
+ * //     TotalProcessed: Number("int"),
+ * //     Type: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetImportJobCommandInput - {@link GetImportJobCommandInput}
@@ -61,6 +90,8 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __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 GetImportJobCommand extends $Command<GetImportJobCommandInput, GetImportJobCommandOutput, PinpointClientResolvedConfig> {

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

@@ -33,6 +33,40 @@ export interface GetImportJobsCommandOutput extends GetImportJobsResponse, __Met
  * };
  * const command = new GetImportJobsCommand(input);
  * const response = await client.send(command);
+ * // { // GetImportJobsResponse
+ * //   ImportJobsResponse: { // ImportJobsResponse
+ * //     Item: [ // ListOfImportJobResponse // required
+ * //       { // ImportJobResponse
+ * //         ApplicationId: "STRING_VALUE", // required
+ * //         CompletedPieces: Number("int"),
+ * //         CompletionDate: "STRING_VALUE",
+ * //         CreationDate: "STRING_VALUE", // required
+ * //         Definition: { // ImportJobResource
+ * //           DefineSegment: true || false,
+ * //           ExternalId: "STRING_VALUE",
+ * //           Format: "CSV" || "JSON", // required
+ * //           RegisterEndpoints: true || false,
+ * //           RoleArn: "STRING_VALUE", // required
+ * //           S3Url: "STRING_VALUE", // required
+ * //           SegmentId: "STRING_VALUE",
+ * //           SegmentName: "STRING_VALUE",
+ * //         },
+ * //         FailedPieces: Number("int"),
+ * //         Failures: [ // ListOf__string
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Id: "STRING_VALUE", // required
+ * //         JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
+ * //         TotalFailures: Number("int"),
+ * //         TotalPieces: Number("int"),
+ * //         TotalProcessed: Number("int"),
+ * //         Type: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     NextToken: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetImportJobsCommandInput - {@link GetImportJobsCommandInput}
@@ -62,6 +96,8 @@ export interface GetImportJobsCommandOutput extends GetImportJobsResponse, __Met
  * @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 GetImportJobsCommand extends $Command<GetImportJobsCommandInput, GetImportJobsCommandOutput, PinpointClientResolvedConfig> {

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

@@ -32,6 +32,116 @@ export interface GetInAppMessagesCommandOutput extends GetInAppMessagesResponse,
  * };
  * const command = new GetInAppMessagesCommand(input);
  * const response = await client.send(command);
+ * // { // GetInAppMessagesResponse
+ * //   InAppMessagesResponse: { // InAppMessagesResponse
+ * //     InAppMessageCampaigns: [ // ListOfInAppMessageCampaign
+ * //       { // InAppMessageCampaign
+ * //         CampaignId: "STRING_VALUE",
+ * //         DailyCap: Number("int"),
+ * //         InAppMessage: { // InAppMessage
+ * //           Content: [ // ListOfInAppMessageContent
+ * //             { // InAppMessageContent
+ * //               BackgroundColor: "STRING_VALUE",
+ * //               BodyConfig: { // InAppMessageBodyConfig
+ * //                 Alignment: "LEFT" || "CENTER" || "RIGHT", // required
+ * //                 Body: "STRING_VALUE", // required
+ * //                 TextColor: "STRING_VALUE", // required
+ * //               },
+ * //               HeaderConfig: { // InAppMessageHeaderConfig
+ * //                 Alignment: "LEFT" || "CENTER" || "RIGHT", // required
+ * //                 Header: "STRING_VALUE", // required
+ * //                 TextColor: "STRING_VALUE", // required
+ * //               },
+ * //               ImageUrl: "STRING_VALUE",
+ * //               PrimaryBtn: { // InAppMessageButton
+ * //                 Android: { // OverrideButtonConfiguration
+ * //                   ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //                   Link: "STRING_VALUE",
+ * //                 },
+ * //                 DefaultConfig: { // DefaultButtonConfiguration
+ * //                   BackgroundColor: "STRING_VALUE",
+ * //                   BorderRadius: Number("int"),
+ * //                   ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //                   Link: "STRING_VALUE",
+ * //                   Text: "STRING_VALUE", // required
+ * //                   TextColor: "STRING_VALUE",
+ * //                 },
+ * //                 IOS: {
+ * //                   ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //                   Link: "STRING_VALUE",
+ * //                 },
+ * //                 Web: {
+ * //                   ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //                   Link: "STRING_VALUE",
+ * //                 },
+ * //               },
+ * //               SecondaryBtn: {
+ * //                 Android: {
+ * //                   ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //                   Link: "STRING_VALUE",
+ * //                 },
+ * //                 DefaultConfig: {
+ * //                   BackgroundColor: "STRING_VALUE",
+ * //                   BorderRadius: Number("int"),
+ * //                   ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //                   Link: "STRING_VALUE",
+ * //                   Text: "STRING_VALUE", // required
+ * //                   TextColor: "STRING_VALUE",
+ * //                 },
+ * //                 IOS: {
+ * //                   ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //                   Link: "STRING_VALUE",
+ * //                 },
+ * //                 Web: "<OverrideButtonConfiguration>",
+ * //               },
+ * //             },
+ * //           ],
+ * //           CustomConfig: { // MapOf__string
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //           Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
+ * //         },
+ * //         Priority: Number("int"),
+ * //         Schedule: { // InAppCampaignSchedule
+ * //           EndDate: "STRING_VALUE",
+ * //           EventFilter: { // CampaignEventFilter
+ * //             Dimensions: { // EventDimensions
+ * //               Attributes: { // MapOfAttributeDimension
+ * //                 "<keys>": { // AttributeDimension
+ * //                   AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
+ * //                   Values: [ // ListOf__string // required
+ * //                     "STRING_VALUE",
+ * //                   ],
+ * //                 },
+ * //               },
+ * //               EventType: { // SetDimension
+ * //                 DimensionType: "INCLUSIVE" || "EXCLUSIVE",
+ * //                 Values: [ // required
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //               Metrics: { // MapOfMetricDimension
+ * //                 "<keys>": { // MetricDimension
+ * //                   ComparisonOperator: "STRING_VALUE", // required
+ * //                   Value: Number("double"), // required
+ * //                 },
+ * //               },
+ * //             },
+ * //             FilterType: "SYSTEM" || "ENDPOINT", // required
+ * //           },
+ * //           QuietTime: { // QuietTime
+ * //             End: "STRING_VALUE",
+ * //             Start: "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         SessionCap: Number("int"),
+ * //         TotalCap: Number("int"),
+ * //         TreatmentId: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetInAppMessagesCommandInput - {@link GetInAppMessagesCommandInput}
@@ -61,6 +171,8 @@ export interface GetInAppMessagesCommandOutput extends GetInAppMessagesResponse,
  * @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 GetInAppMessagesCommand extends $Command<GetInAppMessagesCommandInput, GetInAppMessagesCommandOutput, PinpointClientResolvedConfig> {

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

@@ -32,6 +32,82 @@ export interface GetInAppTemplateCommandOutput extends GetInAppTemplateResponse,
  * };
  * const command = new GetInAppTemplateCommand(input);
  * const response = await client.send(command);
+ * // { // GetInAppTemplateResponse
+ * //   InAppTemplateResponse: { // InAppTemplateResponse
+ * //     Arn: "STRING_VALUE",
+ * //     Content: [ // ListOfInAppMessageContent
+ * //       { // InAppMessageContent
+ * //         BackgroundColor: "STRING_VALUE",
+ * //         BodyConfig: { // InAppMessageBodyConfig
+ * //           Alignment: "LEFT" || "CENTER" || "RIGHT", // required
+ * //           Body: "STRING_VALUE", // required
+ * //           TextColor: "STRING_VALUE", // required
+ * //         },
+ * //         HeaderConfig: { // InAppMessageHeaderConfig
+ * //           Alignment: "LEFT" || "CENTER" || "RIGHT", // required
+ * //           Header: "STRING_VALUE", // required
+ * //           TextColor: "STRING_VALUE", // required
+ * //         },
+ * //         ImageUrl: "STRING_VALUE",
+ * //         PrimaryBtn: { // InAppMessageButton
+ * //           Android: { // OverrideButtonConfiguration
+ * //             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //             Link: "STRING_VALUE",
+ * //           },
+ * //           DefaultConfig: { // DefaultButtonConfiguration
+ * //             BackgroundColor: "STRING_VALUE",
+ * //             BorderRadius: Number("int"),
+ * //             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //             Link: "STRING_VALUE",
+ * //             Text: "STRING_VALUE", // required
+ * //             TextColor: "STRING_VALUE",
+ * //           },
+ * //           IOS: {
+ * //             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //             Link: "STRING_VALUE",
+ * //           },
+ * //           Web: {
+ * //             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //             Link: "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         SecondaryBtn: {
+ * //           Android: {
+ * //             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //             Link: "STRING_VALUE",
+ * //           },
+ * //           DefaultConfig: {
+ * //             BackgroundColor: "STRING_VALUE",
+ * //             BorderRadius: Number("int"),
+ * //             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //             Link: "STRING_VALUE",
+ * //             Text: "STRING_VALUE", // required
+ * //             TextColor: "STRING_VALUE",
+ * //           },
+ * //           IOS: {
+ * //             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ * //             Link: "STRING_VALUE",
+ * //           },
+ * //           Web: "<OverrideButtonConfiguration>",
+ * //         },
+ * //       },
+ * //     ],
+ * //     CreationDate: "STRING_VALUE", // required
+ * //     CustomConfig: { // MapOf__string
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     LastModifiedDate: "STRING_VALUE", // required
+ * //     Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
+ * //     tags: {
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     TemplateDescription: "STRING_VALUE",
+ * //     TemplateName: "STRING_VALUE", // required
+ * //     TemplateType: "EMAIL" || "SMS" || "VOICE" || "PUSH" || "INAPP", // required
+ * //     Version: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetInAppTemplateCommandInput - {@link GetInAppTemplateCommandInput}
@@ -61,6 +137,8 @@ export interface GetInAppTemplateCommandOutput extends GetInAppTemplateResponse,
  * @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 GetInAppTemplateCommand extends $Command<GetInAppTemplateCommandInput, GetInAppTemplateCommandOutput, PinpointClientResolvedConfig> {