@aws-sdk/client-pinpoint 3.300.0 → 3.301.0

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

@@ -26,10 +26,10 @@ 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 = {
- *   CreateApplicationRequest: {
+ * const input = { // CreateAppRequest
+ *   CreateApplicationRequest: { // CreateApplicationRequest
  *     Name: "STRING_VALUE", // required
- *     tags: {
+ *     tags: { // MapOf__string
  *       "<keys>": "STRING_VALUE",
  *     },
  *   },

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

@@ -26,19 +26,19 @@ 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 = {
+ * const input = { // CreateCampaignRequest
  *   ApplicationId: "STRING_VALUE", // required
- *   WriteCampaignRequest: {
- *     AdditionalTreatments: [
- *       {
- *         CustomDeliveryConfiguration: {
+ *   WriteCampaignRequest: { // WriteCampaignRequest
+ *     AdditionalTreatments: [ // ListOfWriteTreatmentResource
+ *       { // WriteTreatmentResource
+ *         CustomDeliveryConfiguration: { // CustomDeliveryConfiguration
  *           DeliveryUri: "STRING_VALUE", // required
- *           EndpointTypes: [
+ *           EndpointTypes: [ // ListOf__EndpointTypesElement
  *             "STRING_VALUE",
  *           ],
  *         },
- *         MessageConfiguration: {
- *           ADMMessage: {
+ *         MessageConfiguration: { // MessageConfiguration
+ *           ADMMessage: { // Message
  *             Action: "STRING_VALUE",
  *             Body: "STRING_VALUE",
  *             ImageIconUrl: "STRING_VALUE",
@@ -80,7 +80,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *             Title: "STRING_VALUE",
  *             Url: "STRING_VALUE",
  *           },
- *           CustomMessage: {
+ *           CustomMessage: { // CampaignCustomMessage
  *             Data: "STRING_VALUE",
  *           },
  *           DefaultMessage: {
@@ -97,7 +97,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *             Title: "STRING_VALUE",
  *             Url: "STRING_VALUE",
  *           },
- *           EmailMessage: {
+ *           EmailMessage: { // CampaignEmailMessage
  *             Body: "STRING_VALUE",
  *             FromAddress: "STRING_VALUE",
  *             HtmlBody: "STRING_VALUE",
@@ -117,7 +117,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *             Title: "STRING_VALUE",
  *             Url: "STRING_VALUE",
  *           },
- *           SMSMessage: {
+ *           SMSMessage: { // CampaignSmsMessage
  *             Body: "STRING_VALUE",
  *             MessageType: "STRING_VALUE",
  *             OriginationNumber: "STRING_VALUE",
@@ -125,28 +125,28 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *             EntityId: "STRING_VALUE",
  *             TemplateId: "STRING_VALUE",
  *           },
- *           InAppMessage: {
+ *           InAppMessage: { // CampaignInAppMessage
  *             Body: "STRING_VALUE",
- *             Content: [
- *               {
+ *             Content: [ // ListOfInAppMessageContent
+ *               { // InAppMessageContent
  *                 BackgroundColor: "STRING_VALUE",
- *                 BodyConfig: {
+ *                 BodyConfig: { // InAppMessageBodyConfig
  *                   Alignment: "STRING_VALUE", // required
  *                   Body: "STRING_VALUE", // required
  *                   TextColor: "STRING_VALUE", // required
  *                 },
- *                 HeaderConfig: {
+ *                 HeaderConfig: { // InAppMessageHeaderConfig
  *                   Alignment: "STRING_VALUE", // required
  *                   Header: "STRING_VALUE", // required
  *                   TextColor: "STRING_VALUE", // required
  *                 },
  *                 ImageUrl: "STRING_VALUE",
- *                 PrimaryBtn: {
- *                   Android: {
+ *                 PrimaryBtn: { // InAppMessageButton
+ *                   Android: { // OverrideButtonConfiguration
  *                     ButtonAction: "STRING_VALUE", // required
  *                     Link: "STRING_VALUE",
  *                   },
- *                   DefaultConfig: {
+ *                   DefaultConfig: { // DefaultButtonConfiguration
  *                     BackgroundColor: "STRING_VALUE",
  *                     BorderRadius: Number("int"),
  *                     ButtonAction: "STRING_VALUE", // required
@@ -180,39 +180,36 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *                     ButtonAction: "STRING_VALUE", // required
  *                     Link: "STRING_VALUE",
  *                   },
- *                   Web: {
- *                     ButtonAction: "STRING_VALUE", // required
- *                     Link: "STRING_VALUE",
- *                   },
+ *                   Web: "<OverrideButtonConfiguration>",
  *                 },
  *               },
  *             ],
- *             CustomConfig: {
+ *             CustomConfig: { // MapOf__string
  *               "<keys>": "STRING_VALUE",
  *             },
  *             Layout: "STRING_VALUE",
  *           },
  *         },
- *         Schedule: {
+ *         Schedule: { // Schedule
  *           EndTime: "STRING_VALUE",
- *           EventFilter: {
- *             Dimensions: {
- *               Attributes: {
- *                 "<keys>": {
+ *           EventFilter: { // CampaignEventFilter
+ *             Dimensions: { // EventDimensions
+ *               Attributes: { // MapOfAttributeDimension
+ *                 "<keys>": { // AttributeDimension
  *                   AttributeType: "STRING_VALUE",
- *                   Values: [ // required
+ *                   Values: [ // ListOf__string // required
  *                     "STRING_VALUE",
  *                   ],
  *                 },
  *               },
- *               EventType: {
+ *               EventType: { // SetDimension
  *                 DimensionType: "STRING_VALUE",
  *                 Values: [ // required
  *                   "STRING_VALUE",
  *                 ],
  *               },
- *               Metrics: {
- *                 "<keys>": {
+ *               Metrics: { // MapOfMetricDimension
+ *                 "<keys>": { // MetricDimension
  *                   ComparisonOperator: "STRING_VALUE", // required
  *                   Value: Number("double"), // required
  *                 },
@@ -222,7 +219,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *           },
  *           Frequency: "STRING_VALUE",
  *           IsLocalTime: true || false,
- *           QuietTime: {
+ *           QuietTime: { // QuietTime
  *             End: "STRING_VALUE",
  *             Start: "STRING_VALUE",
  *           },
@@ -230,8 +227,8 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *           Timezone: "STRING_VALUE",
  *         },
  *         SizePercent: Number("int"), // required
- *         TemplateConfiguration: {
- *           EmailTemplate: {
+ *         TemplateConfiguration: { // TemplateConfiguration
+ *           EmailTemplate: { // Template
  *             Name: "STRING_VALUE",
  *             Version: "STRING_VALUE",
  *           },
@@ -260,13 +257,13 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *     },
  *     Description: "STRING_VALUE",
  *     HoldoutPercent: Number("int"),
- *     Hook: {
+ *     Hook: { // CampaignHook
  *       LambdaFunctionName: "STRING_VALUE",
  *       Mode: "STRING_VALUE",
  *       WebUrl: "STRING_VALUE",
  *     },
  *     IsPaused: true || false,
- *     Limits: {
+ *     Limits: { // CampaignLimits
  *       Daily: Number("int"),
  *       MaximumDuration: Number("int"),
  *       MessagesPerSecond: Number("int"),
@@ -274,85 +271,20 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *       Session: Number("int"),
  *     },
  *     MessageConfiguration: {
- *       ADMMessage: {
- *         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",
- *       },
+ *       ADMMessage: "<Message>",
+ *       APNSMessage: "<Message>",
+ *       BaiduMessage: "<Message>",
  *       CustomMessage: {
  *         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",
- *       },
+ *       DefaultMessage: "<Message>",
  *       EmailMessage: {
  *         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",
- *       },
+ *       GCMMessage: "<Message>",
  *       SMSMessage: {
  *         Body: "STRING_VALUE",
  *         MessageType: "STRING_VALUE",
@@ -378,10 +310,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *             },
  *             ImageUrl: "STRING_VALUE",
  *             PrimaryBtn: {
- *               Android: {
- *                 ButtonAction: "STRING_VALUE", // required
- *                 Link: "STRING_VALUE",
- *               },
+ *               Android: "<OverrideButtonConfiguration>",
  *               DefaultConfig: {
  *                 BackgroundColor: "STRING_VALUE",
  *                 BorderRadius: Number("int"),
@@ -390,20 +319,11 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *                 Text: "STRING_VALUE", // required
  *                 TextColor: "STRING_VALUE",
  *               },
- *               IOS: {
- *                 ButtonAction: "STRING_VALUE", // required
- *                 Link: "STRING_VALUE",
- *               },
- *               Web: {
- *                 ButtonAction: "STRING_VALUE", // required
- *                 Link: "STRING_VALUE",
- *               },
+ *               IOS: "<OverrideButtonConfiguration>",
+ *               Web: "<OverrideButtonConfiguration>",
  *             },
  *             SecondaryBtn: {
- *               Android: {
- *                 ButtonAction: "STRING_VALUE", // required
- *                 Link: "STRING_VALUE",
- *               },
+ *               Android: "<OverrideButtonConfiguration>",
  *               DefaultConfig: {
  *                 BackgroundColor: "STRING_VALUE",
  *                 BorderRadius: Number("int"),
@@ -412,14 +332,8 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *                 Text: "STRING_VALUE", // required
  *                 TextColor: "STRING_VALUE",
  *               },
- *               IOS: {
- *                 ButtonAction: "STRING_VALUE", // required
- *                 Link: "STRING_VALUE",
- *               },
- *               Web: {
- *                 ButtonAction: "STRING_VALUE", // required
- *                 Link: "STRING_VALUE",
- *               },
+ *               IOS: "<OverrideButtonConfiguration>",
+ *               Web: "<OverrideButtonConfiguration>",
  *             },
  *           },
  *         ],
@@ -437,16 +351,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *           Attributes: {
  *             "<keys>": {
  *               AttributeType: "STRING_VALUE",
- *               Values: [ // required
- *                 "<ListOf__string>",
- *               ],
+ *               Values: "<ListOf__string>", // required
  *             },
  *           },
  *           EventType: {
  *             DimensionType: "STRING_VALUE",
- *             Values: [ // required
- *               "<ListOf__string>",
- *             ],
+ *             Values: "<ListOf__string>", // required
  *           },
  *           Metrics: {
  *             "<keys>": {
@@ -468,26 +378,15 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *     },
  *     SegmentId: "STRING_VALUE",
  *     SegmentVersion: Number("int"),
- *     tags: {
- *       "<keys>": "<__string>",
- *     },
+ *     tags: "<MapOf__string>",
  *     TemplateConfiguration: {
  *       EmailTemplate: {
  *         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",
- *       },
+ *       PushTemplate: "<Template>",
+ *       SMSTemplate: "<Template>",
+ *       VoiceTemplate: "<Template>",
  *     },
  *     TreatmentDescription: "STRING_VALUE",
  *     TreatmentName: "STRING_VALUE",

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

@@ -26,13 +26,13 @@ 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 = {
- *   EmailTemplateRequest: {
+ * const input = { // CreateEmailTemplateRequest
+ *   EmailTemplateRequest: { // EmailTemplateRequest
  *     DefaultSubstitutions: "STRING_VALUE",
  *     HtmlPart: "STRING_VALUE",
  *     RecommenderId: "STRING_VALUE",
  *     Subject: "STRING_VALUE",
- *     tags: {
+ *     tags: { // MapOf__string
  *       "<keys>": "STRING_VALUE",
  *     },
  *     TemplateDescription: "STRING_VALUE",

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

@@ -26,9 +26,9 @@ 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 = {
+ * const input = { // CreateExportJobRequest
  *   ApplicationId: "STRING_VALUE", // required
- *   ExportJobRequest: {
+ *   ExportJobRequest: { // ExportJobRequest
  *     RoleArn: "STRING_VALUE", // required
  *     S3UrlPrefix: "STRING_VALUE", // required
  *     SegmentId: "STRING_VALUE",

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

@@ -26,9 +26,9 @@ 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 = {
+ * const input = { // CreateImportJobRequest
  *   ApplicationId: "STRING_VALUE", // required
- *   ImportJobRequest: {
+ *   ImportJobRequest: { // ImportJobRequest
  *     DefineSegment: true || false,
  *     ExternalId: "STRING_VALUE",
  *     Format: "STRING_VALUE", // required

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

@@ -26,28 +26,28 @@ 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 = {
- *   InAppTemplateRequest: {
- *     Content: [
- *       {
+ * const input = { // CreateInAppTemplateRequest
+ *   InAppTemplateRequest: { // InAppTemplateRequest
+ *     Content: [ // ListOfInAppMessageContent
+ *       { // InAppMessageContent
  *         BackgroundColor: "STRING_VALUE",
- *         BodyConfig: {
+ *         BodyConfig: { // InAppMessageBodyConfig
  *           Alignment: "STRING_VALUE", // required
  *           Body: "STRING_VALUE", // required
  *           TextColor: "STRING_VALUE", // required
  *         },
- *         HeaderConfig: {
+ *         HeaderConfig: { // InAppMessageHeaderConfig
  *           Alignment: "STRING_VALUE", // required
  *           Header: "STRING_VALUE", // required
  *           TextColor: "STRING_VALUE", // required
  *         },
  *         ImageUrl: "STRING_VALUE",
- *         PrimaryBtn: {
- *           Android: {
+ *         PrimaryBtn: { // InAppMessageButton
+ *           Android: { // OverrideButtonConfiguration
  *             ButtonAction: "STRING_VALUE", // required
  *             Link: "STRING_VALUE",
  *           },
- *           DefaultConfig: {
+ *           DefaultConfig: { // DefaultButtonConfiguration
  *             BackgroundColor: "STRING_VALUE",
  *             BorderRadius: Number("int"),
  *             ButtonAction: "STRING_VALUE", // required
@@ -81,14 +81,11 @@ export interface CreateInAppTemplateCommandOutput extends CreateInAppTemplateRes
  *             ButtonAction: "STRING_VALUE", // required
  *             Link: "STRING_VALUE",
  *           },
- *           Web: {
- *             ButtonAction: "STRING_VALUE", // required
- *             Link: "STRING_VALUE",
- *           },
+ *           Web: "<OverrideButtonConfiguration>",
  *         },
  *       },
  *     ],
- *     CustomConfig: {
+ *     CustomConfig: { // MapOf__string
  *       "<keys>": "STRING_VALUE",
  *     },
  *     Layout: "STRING_VALUE",