@aws-sdk/client-pinpoint 3.299.0 → 3.301.0

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

@@ -26,6 +26,14 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea
  * import { PinpointClient, CreateAppCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, CreateAppCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = { // CreateAppRequest
+ *   CreateApplicationRequest: { // CreateApplicationRequest
+ *     Name: "STRING_VALUE", // required
+ *     tags: { // MapOf__string
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *   },
+ * };
  * const command = new CreateAppCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,373 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  * import { PinpointClient, CreateCampaignCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, CreateCampaignCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = { // CreateCampaignRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   WriteCampaignRequest: { // WriteCampaignRequest
+ *     AdditionalTreatments: [ // ListOfWriteTreatmentResource
+ *       { // WriteTreatmentResource
+ *         CustomDeliveryConfiguration: { // CustomDeliveryConfiguration
+ *           DeliveryUri: "STRING_VALUE", // required
+ *           EndpointTypes: [ // ListOf__EndpointTypesElement
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         MessageConfiguration: { // MessageConfiguration
+ *           ADMMessage: { // Message
+ *             Action: "STRING_VALUE",
+ *             Body: "STRING_VALUE",
+ *             ImageIconUrl: "STRING_VALUE",
+ *             ImageSmallIconUrl: "STRING_VALUE",
+ *             ImageUrl: "STRING_VALUE",
+ *             JsonBody: "STRING_VALUE",
+ *             MediaUrl: "STRING_VALUE",
+ *             RawContent: "STRING_VALUE",
+ *             SilentPush: true || false,
+ *             TimeToLive: Number("int"),
+ *             Title: "STRING_VALUE",
+ *             Url: "STRING_VALUE",
+ *           },
+ *           APNSMessage: {
+ *             Action: "STRING_VALUE",
+ *             Body: "STRING_VALUE",
+ *             ImageIconUrl: "STRING_VALUE",
+ *             ImageSmallIconUrl: "STRING_VALUE",
+ *             ImageUrl: "STRING_VALUE",
+ *             JsonBody: "STRING_VALUE",
+ *             MediaUrl: "STRING_VALUE",
+ *             RawContent: "STRING_VALUE",
+ *             SilentPush: true || false,
+ *             TimeToLive: Number("int"),
+ *             Title: "STRING_VALUE",
+ *             Url: "STRING_VALUE",
+ *           },
+ *           BaiduMessage: {
+ *             Action: "STRING_VALUE",
+ *             Body: "STRING_VALUE",
+ *             ImageIconUrl: "STRING_VALUE",
+ *             ImageSmallIconUrl: "STRING_VALUE",
+ *             ImageUrl: "STRING_VALUE",
+ *             JsonBody: "STRING_VALUE",
+ *             MediaUrl: "STRING_VALUE",
+ *             RawContent: "STRING_VALUE",
+ *             SilentPush: true || false,
+ *             TimeToLive: Number("int"),
+ *             Title: "STRING_VALUE",
+ *             Url: "STRING_VALUE",
+ *           },
+ *           CustomMessage: { // CampaignCustomMessage
+ *             Data: "STRING_VALUE",
+ *           },
+ *           DefaultMessage: {
+ *             Action: "STRING_VALUE",
+ *             Body: "STRING_VALUE",
+ *             ImageIconUrl: "STRING_VALUE",
+ *             ImageSmallIconUrl: "STRING_VALUE",
+ *             ImageUrl: "STRING_VALUE",
+ *             JsonBody: "STRING_VALUE",
+ *             MediaUrl: "STRING_VALUE",
+ *             RawContent: "STRING_VALUE",
+ *             SilentPush: true || false,
+ *             TimeToLive: Number("int"),
+ *             Title: "STRING_VALUE",
+ *             Url: "STRING_VALUE",
+ *           },
+ *           EmailMessage: { // CampaignEmailMessage
+ *             Body: "STRING_VALUE",
+ *             FromAddress: "STRING_VALUE",
+ *             HtmlBody: "STRING_VALUE",
+ *             Title: "STRING_VALUE",
+ *           },
+ *           GCMMessage: {
+ *             Action: "STRING_VALUE",
+ *             Body: "STRING_VALUE",
+ *             ImageIconUrl: "STRING_VALUE",
+ *             ImageSmallIconUrl: "STRING_VALUE",
+ *             ImageUrl: "STRING_VALUE",
+ *             JsonBody: "STRING_VALUE",
+ *             MediaUrl: "STRING_VALUE",
+ *             RawContent: "STRING_VALUE",
+ *             SilentPush: true || false,
+ *             TimeToLive: Number("int"),
+ *             Title: "STRING_VALUE",
+ *             Url: "STRING_VALUE",
+ *           },
+ *           SMSMessage: { // CampaignSmsMessage
+ *             Body: "STRING_VALUE",
+ *             MessageType: "STRING_VALUE",
+ *             OriginationNumber: "STRING_VALUE",
+ *             SenderId: "STRING_VALUE",
+ *             EntityId: "STRING_VALUE",
+ *             TemplateId: "STRING_VALUE",
+ *           },
+ *           InAppMessage: { // CampaignInAppMessage
+ *             Body: "STRING_VALUE",
+ *             Content: [ // ListOfInAppMessageContent
+ *               { // InAppMessageContent
+ *                 BackgroundColor: "STRING_VALUE",
+ *                 BodyConfig: { // InAppMessageBodyConfig
+ *                   Alignment: "STRING_VALUE", // required
+ *                   Body: "STRING_VALUE", // required
+ *                   TextColor: "STRING_VALUE", // required
+ *                 },
+ *                 HeaderConfig: { // InAppMessageHeaderConfig
+ *                   Alignment: "STRING_VALUE", // required
+ *                   Header: "STRING_VALUE", // required
+ *                   TextColor: "STRING_VALUE", // required
+ *                 },
+ *                 ImageUrl: "STRING_VALUE",
+ *                 PrimaryBtn: { // InAppMessageButton
+ *                   Android: { // OverrideButtonConfiguration
+ *                     ButtonAction: "STRING_VALUE", // required
+ *                     Link: "STRING_VALUE",
+ *                   },
+ *                   DefaultConfig: { // DefaultButtonConfiguration
+ *                     BackgroundColor: "STRING_VALUE",
+ *                     BorderRadius: Number("int"),
+ *                     ButtonAction: "STRING_VALUE", // required
+ *                     Link: "STRING_VALUE",
+ *                     Text: "STRING_VALUE", // required
+ *                     TextColor: "STRING_VALUE",
+ *                   },
+ *                   IOS: {
+ *                     ButtonAction: "STRING_VALUE", // required
+ *                     Link: "STRING_VALUE",
+ *                   },
+ *                   Web: {
+ *                     ButtonAction: "STRING_VALUE", // required
+ *                     Link: "STRING_VALUE",
+ *                   },
+ *                 },
+ *                 SecondaryBtn: {
+ *                   Android: {
+ *                     ButtonAction: "STRING_VALUE", // required
+ *                     Link: "STRING_VALUE",
+ *                   },
+ *                   DefaultConfig: {
+ *                     BackgroundColor: "STRING_VALUE",
+ *                     BorderRadius: Number("int"),
+ *                     ButtonAction: "STRING_VALUE", // required
+ *                     Link: "STRING_VALUE",
+ *                     Text: "STRING_VALUE", // required
+ *                     TextColor: "STRING_VALUE",
+ *                   },
+ *                   IOS: {
+ *                     ButtonAction: "STRING_VALUE", // required
+ *                     Link: "STRING_VALUE",
+ *                   },
+ *                   Web: "<OverrideButtonConfiguration>",
+ *                 },
+ *               },
+ *             ],
+ *             CustomConfig: { // MapOf__string
+ *               "<keys>": "STRING_VALUE",
+ *             },
+ *             Layout: "STRING_VALUE",
+ *           },
+ *         },
+ *         Schedule: { // Schedule
+ *           EndTime: "STRING_VALUE",
+ *           EventFilter: { // CampaignEventFilter
+ *             Dimensions: { // EventDimensions
+ *               Attributes: { // MapOfAttributeDimension
+ *                 "<keys>": { // AttributeDimension
+ *                   AttributeType: "STRING_VALUE",
+ *                   Values: [ // ListOf__string // required
+ *                     "STRING_VALUE",
+ *                   ],
+ *                 },
+ *               },
+ *               EventType: { // SetDimension
+ *                 DimensionType: "STRING_VALUE",
+ *                 Values: [ // required
+ *                   "STRING_VALUE",
+ *                 ],
+ *               },
+ *               Metrics: { // MapOfMetricDimension
+ *                 "<keys>": { // MetricDimension
+ *                   ComparisonOperator: "STRING_VALUE", // required
+ *                   Value: Number("double"), // required
+ *                 },
+ *               },
+ *             },
+ *             FilterType: "STRING_VALUE", // required
+ *           },
+ *           Frequency: "STRING_VALUE",
+ *           IsLocalTime: true || false,
+ *           QuietTime: { // QuietTime
+ *             End: "STRING_VALUE",
+ *             Start: "STRING_VALUE",
+ *           },
+ *           StartTime: "STRING_VALUE", // required
+ *           Timezone: "STRING_VALUE",
+ *         },
+ *         SizePercent: Number("int"), // required
+ *         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",
+ *           },
+ *         },
+ *         TreatmentDescription: "STRING_VALUE",
+ *         TreatmentName: "STRING_VALUE",
+ *       },
+ *     ],
+ *     CustomDeliveryConfiguration: {
+ *       DeliveryUri: "STRING_VALUE", // required
+ *       EndpointTypes: [
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *     Description: "STRING_VALUE",
+ *     HoldoutPercent: Number("int"),
+ *     Hook: { // CampaignHook
+ *       LambdaFunctionName: "STRING_VALUE",
+ *       Mode: "STRING_VALUE",
+ *       WebUrl: "STRING_VALUE",
+ *     },
+ *     IsPaused: true || false,
+ *     Limits: { // CampaignLimits
+ *       Daily: Number("int"),
+ *       MaximumDuration: Number("int"),
+ *       MessagesPerSecond: Number("int"),
+ *       Total: Number("int"),
+ *       Session: Number("int"),
+ *     },
+ *     MessageConfiguration: {
+ *       ADMMessage: "<Message>",
+ *       APNSMessage: "<Message>",
+ *       BaiduMessage: "<Message>",
+ *       CustomMessage: {
+ *         Data: "STRING_VALUE",
+ *       },
+ *       DefaultMessage: "<Message>",
+ *       EmailMessage: {
+ *         Body: "STRING_VALUE",
+ *         FromAddress: "STRING_VALUE",
+ *         HtmlBody: "STRING_VALUE",
+ *         Title: "STRING_VALUE",
+ *       },
+ *       GCMMessage: "<Message>",
+ *       SMSMessage: {
+ *         Body: "STRING_VALUE",
+ *         MessageType: "STRING_VALUE",
+ *         OriginationNumber: "STRING_VALUE",
+ *         SenderId: "STRING_VALUE",
+ *         EntityId: "STRING_VALUE",
+ *         TemplateId: "STRING_VALUE",
+ *       },
+ *       InAppMessage: {
+ *         Body: "STRING_VALUE",
+ *         Content: [
+ *           {
+ *             BackgroundColor: "STRING_VALUE",
+ *             BodyConfig: {
+ *               Alignment: "STRING_VALUE", // required
+ *               Body: "STRING_VALUE", // required
+ *               TextColor: "STRING_VALUE", // required
+ *             },
+ *             HeaderConfig: {
+ *               Alignment: "STRING_VALUE", // required
+ *               Header: "STRING_VALUE", // required
+ *               TextColor: "STRING_VALUE", // required
+ *             },
+ *             ImageUrl: "STRING_VALUE",
+ *             PrimaryBtn: {
+ *               Android: "<OverrideButtonConfiguration>",
+ *               DefaultConfig: {
+ *                 BackgroundColor: "STRING_VALUE",
+ *                 BorderRadius: Number("int"),
+ *                 ButtonAction: "STRING_VALUE", // required
+ *                 Link: "STRING_VALUE",
+ *                 Text: "STRING_VALUE", // required
+ *                 TextColor: "STRING_VALUE",
+ *               },
+ *               IOS: "<OverrideButtonConfiguration>",
+ *               Web: "<OverrideButtonConfiguration>",
+ *             },
+ *             SecondaryBtn: {
+ *               Android: "<OverrideButtonConfiguration>",
+ *               DefaultConfig: {
+ *                 BackgroundColor: "STRING_VALUE",
+ *                 BorderRadius: Number("int"),
+ *                 ButtonAction: "STRING_VALUE", // required
+ *                 Link: "STRING_VALUE",
+ *                 Text: "STRING_VALUE", // required
+ *                 TextColor: "STRING_VALUE",
+ *               },
+ *               IOS: "<OverrideButtonConfiguration>",
+ *               Web: "<OverrideButtonConfiguration>",
+ *             },
+ *           },
+ *         ],
+ *         CustomConfig: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         Layout: "STRING_VALUE",
+ *       },
+ *     },
+ *     Name: "STRING_VALUE",
+ *     Schedule: {
+ *       EndTime: "STRING_VALUE",
+ *       EventFilter: {
+ *         Dimensions: {
+ *           Attributes: {
+ *             "<keys>": {
+ *               AttributeType: "STRING_VALUE",
+ *               Values: "<ListOf__string>", // required
+ *             },
+ *           },
+ *           EventType: {
+ *             DimensionType: "STRING_VALUE",
+ *             Values: "<ListOf__string>", // required
+ *           },
+ *           Metrics: {
+ *             "<keys>": {
+ *               ComparisonOperator: "STRING_VALUE", // required
+ *               Value: Number("double"), // required
+ *             },
+ *           },
+ *         },
+ *         FilterType: "STRING_VALUE", // required
+ *       },
+ *       Frequency: "STRING_VALUE",
+ *       IsLocalTime: true || false,
+ *       QuietTime: {
+ *         End: "STRING_VALUE",
+ *         Start: "STRING_VALUE",
+ *       },
+ *       StartTime: "STRING_VALUE", // required
+ *       Timezone: "STRING_VALUE",
+ *     },
+ *     SegmentId: "STRING_VALUE",
+ *     SegmentVersion: Number("int"),
+ *     tags: "<MapOf__string>",
+ *     TemplateConfiguration: {
+ *       EmailTemplate: {
+ *         Name: "STRING_VALUE",
+ *         Version: "STRING_VALUE",
+ *       },
+ *       PushTemplate: "<Template>",
+ *       SMSTemplate: "<Template>",
+ *       VoiceTemplate: "<Template>",
+ *     },
+ *     TreatmentDescription: "STRING_VALUE",
+ *     TreatmentName: "STRING_VALUE",
+ *     Priority: Number("int"),
+ *   },
+ * };
  * const command = new CreateCampaignCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,20 @@ export interface CreateEmailTemplateCommandOutput extends CreateEmailTemplateRes
  * import { PinpointClient, CreateEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, CreateEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = { // CreateEmailTemplateRequest
+ *   EmailTemplateRequest: { // EmailTemplateRequest
+ *     DefaultSubstitutions: "STRING_VALUE",
+ *     HtmlPart: "STRING_VALUE",
+ *     RecommenderId: "STRING_VALUE",
+ *     Subject: "STRING_VALUE",
+ *     tags: { // MapOf__string
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     TemplateDescription: "STRING_VALUE",
+ *     TextPart: "STRING_VALUE",
+ *   },
+ *   TemplateName: "STRING_VALUE", // required
+ * };
  * const command = new CreateEmailTemplateCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,15 @@ export interface CreateExportJobCommandOutput extends CreateExportJobResponse, _
  * import { PinpointClient, CreateExportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, CreateExportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = { // CreateExportJobRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   ExportJobRequest: { // ExportJobRequest
+ *     RoleArn: "STRING_VALUE", // required
+ *     S3UrlPrefix: "STRING_VALUE", // required
+ *     SegmentId: "STRING_VALUE",
+ *     SegmentVersion: Number("int"),
+ *   },
+ * };
  * const command = new CreateExportJobCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,19 @@ export interface CreateImportJobCommandOutput extends CreateImportJobResponse, _
  * import { PinpointClient, CreateImportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, CreateImportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = { // CreateImportJobRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   ImportJobRequest: { // ImportJobRequest
+ *     DefineSegment: true || false,
+ *     ExternalId: "STRING_VALUE",
+ *     Format: "STRING_VALUE", // required
+ *     RegisterEndpoints: true || false,
+ *     RoleArn: "STRING_VALUE", // required
+ *     S3Url: "STRING_VALUE", // required
+ *     SegmentId: "STRING_VALUE",
+ *     SegmentName: "STRING_VALUE",
+ *   },
+ * };
  * const command = new CreateImportJobCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,76 @@ export interface CreateInAppTemplateCommandOutput extends CreateInAppTemplateRes
  * import { PinpointClient, CreateInAppTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, CreateInAppTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = { // CreateInAppTemplateRequest
+ *   InAppTemplateRequest: { // InAppTemplateRequest
+ *     Content: [ // ListOfInAppMessageContent
+ *       { // InAppMessageContent
+ *         BackgroundColor: "STRING_VALUE",
+ *         BodyConfig: { // InAppMessageBodyConfig
+ *           Alignment: "STRING_VALUE", // required
+ *           Body: "STRING_VALUE", // required
+ *           TextColor: "STRING_VALUE", // required
+ *         },
+ *         HeaderConfig: { // InAppMessageHeaderConfig
+ *           Alignment: "STRING_VALUE", // required
+ *           Header: "STRING_VALUE", // required
+ *           TextColor: "STRING_VALUE", // required
+ *         },
+ *         ImageUrl: "STRING_VALUE",
+ *         PrimaryBtn: { // InAppMessageButton
+ *           Android: { // OverrideButtonConfiguration
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           DefaultConfig: { // DefaultButtonConfiguration
+ *             BackgroundColor: "STRING_VALUE",
+ *             BorderRadius: Number("int"),
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *             Text: "STRING_VALUE", // required
+ *             TextColor: "STRING_VALUE",
+ *           },
+ *           IOS: {
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           Web: {
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *         },
+ *         SecondaryBtn: {
+ *           Android: {
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           DefaultConfig: {
+ *             BackgroundColor: "STRING_VALUE",
+ *             BorderRadius: Number("int"),
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *             Text: "STRING_VALUE", // required
+ *             TextColor: "STRING_VALUE",
+ *           },
+ *           IOS: {
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           Web: "<OverrideButtonConfiguration>",
+ *         },
+ *       },
+ *     ],
+ *     CustomConfig: { // MapOf__string
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     Layout: "STRING_VALUE",
+ *     tags: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     TemplateDescription: "STRING_VALUE",
+ *   },
+ *   TemplateName: "STRING_VALUE", // required
+ * };
  * const command = new CreateInAppTemplateCommand(input);
  * const response = await client.send(command);
  * ```