@aws-sdk/client-pinpoint 3.299.0 → 3.300.0

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

@@ -26,6 +26,81 @@ export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateRes
  * import { PinpointClient, UpdateInAppTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, UpdateInAppTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = {
+ *   CreateNewVersion: true || false,
+ *   InAppTemplateRequest: {
+ *     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: {
+ *             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: {
+ *             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: {
+ *             ButtonAction: "STRING_VALUE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *         },
+ *       },
+ *     ],
+ *     CustomConfig: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     Layout: "STRING_VALUE",
+ *     tags: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     TemplateDescription: "STRING_VALUE",
+ *   },
+ *   TemplateName: "STRING_VALUE", // required
+ *   Version: "STRING_VALUE",
+ * };
  * const command = new UpdateInAppTemplateCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,464 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
  * import { PinpointClient, UpdateJourneyCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, UpdateJourneyCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = {
+ *   ApplicationId: "STRING_VALUE", // required
+ *   JourneyId: "STRING_VALUE", // required
+ *   WriteJourneyRequest: {
+ *     Activities: {
+ *       "<keys>": {
+ *         CUSTOM: {
+ *           DeliveryUri: "STRING_VALUE",
+ *           EndpointTypes: [
+ *             "STRING_VALUE",
+ *           ],
+ *           MessageConfig: {
+ *             Data: "STRING_VALUE",
+ *           },
+ *           NextActivity: "STRING_VALUE",
+ *           TemplateName: "STRING_VALUE",
+ *           TemplateVersion: "STRING_VALUE",
+ *         },
+ *         ConditionalSplit: {
+ *           Condition: {
+ *             Conditions: [
+ *               {
+ *                 EventCondition: {
+ *                   Dimensions: {
+ *                     Attributes: {
+ *                       "<keys>": {
+ *                         AttributeType: "STRING_VALUE",
+ *                         Values: [ // required
+ *                           "STRING_VALUE",
+ *                         ],
+ *                       },
+ *                     },
+ *                     EventType: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Metrics: {
+ *                       "<keys>": {
+ *                         ComparisonOperator: "STRING_VALUE", // required
+ *                         Value: Number("double"), // required
+ *                       },
+ *                     },
+ *                   },
+ *                   MessageActivity: "STRING_VALUE",
+ *                 },
+ *                 SegmentCondition: {
+ *                   SegmentId: "STRING_VALUE", // required
+ *                 },
+ *                 SegmentDimensions: {
+ *                   Attributes: {
+ *                     "<keys>": {
+ *                       AttributeType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                   },
+ *                   Behavior: {
+ *                     Recency: {
+ *                       Duration: "STRING_VALUE", // required
+ *                       RecencyType: "STRING_VALUE", // required
+ *                     },
+ *                   },
+ *                   Demographic: {
+ *                     AppVersion: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Channel: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     DeviceType: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Make: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Model: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Platform: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                   },
+ *                   Location: {
+ *                     Country: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     GPSPoint: {
+ *                       Coordinates: {
+ *                         Latitude: Number("double"), // required
+ *                         Longitude: Number("double"), // required
+ *                       },
+ *                       RangeInKilometers: Number("double"),
+ *                     },
+ *                   },
+ *                   Metrics: {
+ *                     "<keys>": {
+ *                       ComparisonOperator: "STRING_VALUE", // required
+ *                       Value: Number("double"), // required
+ *                     },
+ *                   },
+ *                   UserAttributes: {
+ *                     "<keys>": {
+ *                       AttributeType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                   },
+ *                 },
+ *               },
+ *             ],
+ *             Operator: "STRING_VALUE",
+ *           },
+ *           EvaluationWaitTime: {
+ *             WaitFor: "STRING_VALUE",
+ *             WaitUntil: "STRING_VALUE",
+ *           },
+ *           FalseActivity: "STRING_VALUE",
+ *           TrueActivity: "STRING_VALUE",
+ *         },
+ *         Description: "STRING_VALUE",
+ *         EMAIL: {
+ *           MessageConfig: {
+ *             FromAddress: "STRING_VALUE",
+ *           },
+ *           NextActivity: "STRING_VALUE",
+ *           TemplateName: "STRING_VALUE",
+ *           TemplateVersion: "STRING_VALUE",
+ *         },
+ *         Holdout: {
+ *           NextActivity: "STRING_VALUE",
+ *           Percentage: Number("int"), // required
+ *         },
+ *         MultiCondition: {
+ *           Branches: [
+ *             {
+ *               Condition: {
+ *                 EventCondition: {
+ *                   Dimensions: {
+ *                     Attributes: {
+ *                       "<keys>": {
+ *                         AttributeType: "STRING_VALUE",
+ *                         Values: [ // required
+ *                           "STRING_VALUE",
+ *                         ],
+ *                       },
+ *                     },
+ *                     EventType: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Metrics: {
+ *                       "<keys>": {
+ *                         ComparisonOperator: "STRING_VALUE", // required
+ *                         Value: Number("double"), // required
+ *                       },
+ *                     },
+ *                   },
+ *                   MessageActivity: "STRING_VALUE",
+ *                 },
+ *                 SegmentCondition: {
+ *                   SegmentId: "STRING_VALUE", // required
+ *                 },
+ *                 SegmentDimensions: {
+ *                   Attributes: {
+ *                     "<keys>": {
+ *                       AttributeType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                   },
+ *                   Behavior: {
+ *                     Recency: {
+ *                       Duration: "STRING_VALUE", // required
+ *                       RecencyType: "STRING_VALUE", // required
+ *                     },
+ *                   },
+ *                   Demographic: {
+ *                     AppVersion: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Channel: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     DeviceType: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Make: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Model: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     Platform: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                   },
+ *                   Location: {
+ *                     Country: {
+ *                       DimensionType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                     GPSPoint: {
+ *                       Coordinates: {
+ *                         Latitude: Number("double"), // required
+ *                         Longitude: Number("double"), // required
+ *                       },
+ *                       RangeInKilometers: Number("double"),
+ *                     },
+ *                   },
+ *                   Metrics: {
+ *                     "<keys>": {
+ *                       ComparisonOperator: "STRING_VALUE", // required
+ *                       Value: Number("double"), // required
+ *                     },
+ *                   },
+ *                   UserAttributes: {
+ *                     "<keys>": {
+ *                       AttributeType: "STRING_VALUE",
+ *                       Values: [ // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                     },
+ *                   },
+ *                 },
+ *               },
+ *               NextActivity: "STRING_VALUE",
+ *             },
+ *           ],
+ *           DefaultActivity: "STRING_VALUE",
+ *           EvaluationWaitTime: {
+ *             WaitFor: "STRING_VALUE",
+ *             WaitUntil: "STRING_VALUE",
+ *           },
+ *         },
+ *         PUSH: {
+ *           MessageConfig: {
+ *             TimeToLive: "STRING_VALUE",
+ *           },
+ *           NextActivity: "STRING_VALUE",
+ *           TemplateName: "STRING_VALUE",
+ *           TemplateVersion: "STRING_VALUE",
+ *         },
+ *         RandomSplit: {
+ *           Branches: [
+ *             {
+ *               NextActivity: "STRING_VALUE",
+ *               Percentage: Number("int"),
+ *             },
+ *           ],
+ *         },
+ *         SMS: {
+ *           MessageConfig: {
+ *             MessageType: "STRING_VALUE",
+ *             OriginationNumber: "STRING_VALUE",
+ *             SenderId: "STRING_VALUE",
+ *             EntityId: "STRING_VALUE",
+ *             TemplateId: "STRING_VALUE",
+ *           },
+ *           NextActivity: "STRING_VALUE",
+ *           TemplateName: "STRING_VALUE",
+ *           TemplateVersion: "STRING_VALUE",
+ *         },
+ *         Wait: {
+ *           NextActivity: "STRING_VALUE",
+ *           WaitTime: {
+ *             WaitFor: "STRING_VALUE",
+ *             WaitUntil: "STRING_VALUE",
+ *           },
+ *         },
+ *         ContactCenter: {
+ *           NextActivity: "STRING_VALUE",
+ *         },
+ *       },
+ *     },
+ *     CreationDate: "STRING_VALUE",
+ *     LastModifiedDate: "STRING_VALUE",
+ *     Limits: {
+ *       DailyCap: Number("int"),
+ *       EndpointReentryCap: Number("int"),
+ *       MessagesPerSecond: Number("int"),
+ *       EndpointReentryInterval: "STRING_VALUE",
+ *     },
+ *     LocalTime: true || false,
+ *     Name: "STRING_VALUE", // required
+ *     QuietTime: {
+ *       End: "STRING_VALUE",
+ *       Start: "STRING_VALUE",
+ *     },
+ *     RefreshFrequency: "STRING_VALUE",
+ *     Schedule: {
+ *       EndTime: new Date("TIMESTAMP"),
+ *       StartTime: new Date("TIMESTAMP"),
+ *       Timezone: "STRING_VALUE",
+ *     },
+ *     StartActivity: "STRING_VALUE",
+ *     StartCondition: {
+ *       Description: "STRING_VALUE",
+ *       EventStartCondition: {
+ *         EventFilter: {
+ *           Dimensions: {
+ *             Attributes: {
+ *               "<keys>": "<AttributeDimension>",
+ *             },
+ *             EventType: {
+ *               DimensionType: "STRING_VALUE",
+ *               Values: [ // required
+ *                 "<ListOf__string>",
+ *               ],
+ *             },
+ *             Metrics: {
+ *               "<keys>": "<MetricDimension>",
+ *             },
+ *           },
+ *           FilterType: "STRING_VALUE", // required
+ *         },
+ *         SegmentId: "STRING_VALUE",
+ *       },
+ *       SegmentStartCondition: {
+ *         SegmentId: "STRING_VALUE", // required
+ *       },
+ *     },
+ *     State: "STRING_VALUE",
+ *     WaitForQuietTime: true || false,
+ *     RefreshOnSegmentUpdate: true || false,
+ *     JourneyChannelSettings: {
+ *       ConnectCampaignArn: "STRING_VALUE",
+ *       ConnectCampaignExecutionRoleArn: "STRING_VALUE",
+ *     },
+ *     SendingSchedule: true || false,
+ *     OpenHours: {
+ *       EMAIL: {
+ *         "<keys>": [
+ *           {
+ *             StartTime: "STRING_VALUE",
+ *             EndTime: "STRING_VALUE",
+ *           },
+ *         ],
+ *       },
+ *       SMS: {
+ *         "<keys>": [
+ *           {
+ *             StartTime: "STRING_VALUE",
+ *             EndTime: "STRING_VALUE",
+ *           },
+ *         ],
+ *       },
+ *       PUSH: {
+ *         "<keys>": [
+ *           {
+ *             StartTime: "STRING_VALUE",
+ *             EndTime: "STRING_VALUE",
+ *           },
+ *         ],
+ *       },
+ *       VOICE: {
+ *         "<keys>": [
+ *           {
+ *             StartTime: "STRING_VALUE",
+ *             EndTime: "STRING_VALUE",
+ *           },
+ *         ],
+ *       },
+ *       CUSTOM: {
+ *         "<keys>": [
+ *           {
+ *             StartTime: "STRING_VALUE",
+ *             EndTime: "STRING_VALUE",
+ *           },
+ *         ],
+ *       },
+ *     },
+ *     ClosedDays: {
+ *       EMAIL: [
+ *         {
+ *           Name: "STRING_VALUE",
+ *           StartDateTime: "STRING_VALUE",
+ *           EndDateTime: "STRING_VALUE",
+ *         },
+ *       ],
+ *       SMS: [
+ *         {
+ *           Name: "STRING_VALUE",
+ *           StartDateTime: "STRING_VALUE",
+ *           EndDateTime: "STRING_VALUE",
+ *         },
+ *       ],
+ *       PUSH: [
+ *         {
+ *           Name: "STRING_VALUE",
+ *           StartDateTime: "STRING_VALUE",
+ *           EndDateTime: "STRING_VALUE",
+ *         },
+ *       ],
+ *       VOICE: [
+ *         {
+ *           Name: "STRING_VALUE",
+ *           StartDateTime: "STRING_VALUE",
+ *           EndDateTime: "STRING_VALUE",
+ *         },
+ *       ],
+ *       CUSTOM: [
+ *         {
+ *           Name: "STRING_VALUE",
+ *           StartDateTime: "STRING_VALUE",
+ *           EndDateTime: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *   },
+ * };
  * const command = new UpdateJourneyCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,13 @@ export interface UpdateJourneyStateCommandOutput extends UpdateJourneyStateRespo
  * import { PinpointClient, UpdateJourneyStateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, UpdateJourneyStateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = {
+ *   ApplicationId: "STRING_VALUE", // required
+ *   JourneyId: "STRING_VALUE", // required
+ *   JourneyStateRequest: {
+ *     State: "STRING_VALUE",
+ *   },
+ * };
  * const command = new UpdateJourneyStateCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,68 @@ export interface UpdatePushTemplateCommandOutput extends UpdatePushTemplateRespo
  * import { PinpointClient, UpdatePushTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, UpdatePushTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = {
+ *   CreateNewVersion: true || false,
+ *   PushNotificationTemplateRequest: {
+ *     ADM: {
+ *       Action: "STRING_VALUE",
+ *       Body: "STRING_VALUE",
+ *       ImageIconUrl: "STRING_VALUE",
+ *       ImageUrl: "STRING_VALUE",
+ *       RawContent: "STRING_VALUE",
+ *       SmallImageIconUrl: "STRING_VALUE",
+ *       Sound: "STRING_VALUE",
+ *       Title: "STRING_VALUE",
+ *       Url: "STRING_VALUE",
+ *     },
+ *     APNS: {
+ *       Action: "STRING_VALUE",
+ *       Body: "STRING_VALUE",
+ *       MediaUrl: "STRING_VALUE",
+ *       RawContent: "STRING_VALUE",
+ *       Sound: "STRING_VALUE",
+ *       Title: "STRING_VALUE",
+ *       Url: "STRING_VALUE",
+ *     },
+ *     Baidu: {
+ *       Action: "STRING_VALUE",
+ *       Body: "STRING_VALUE",
+ *       ImageIconUrl: "STRING_VALUE",
+ *       ImageUrl: "STRING_VALUE",
+ *       RawContent: "STRING_VALUE",
+ *       SmallImageIconUrl: "STRING_VALUE",
+ *       Sound: "STRING_VALUE",
+ *       Title: "STRING_VALUE",
+ *       Url: "STRING_VALUE",
+ *     },
+ *     Default: {
+ *       Action: "STRING_VALUE",
+ *       Body: "STRING_VALUE",
+ *       Sound: "STRING_VALUE",
+ *       Title: "STRING_VALUE",
+ *       Url: "STRING_VALUE",
+ *     },
+ *     DefaultSubstitutions: "STRING_VALUE",
+ *     GCM: {
+ *       Action: "STRING_VALUE",
+ *       Body: "STRING_VALUE",
+ *       ImageIconUrl: "STRING_VALUE",
+ *       ImageUrl: "STRING_VALUE",
+ *       RawContent: "STRING_VALUE",
+ *       SmallImageIconUrl: "STRING_VALUE",
+ *       Sound: "STRING_VALUE",
+ *       Title: "STRING_VALUE",
+ *       Url: "STRING_VALUE",
+ *     },
+ *     RecommenderId: "STRING_VALUE",
+ *     tags: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     TemplateDescription: "STRING_VALUE",
+ *   },
+ *   TemplateName: "STRING_VALUE", // required
+ *   Version: "STRING_VALUE",
+ * };
  * const command = new UpdatePushTemplateCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -26,6 +26,22 @@ export interface UpdateRecommenderConfigurationCommandOutput extends UpdateRecom
  * import { PinpointClient, UpdateRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
  * // const { PinpointClient, UpdateRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
  * const client = new PinpointClient(config);
+ * const input = {
+ *   RecommenderId: "STRING_VALUE", // required
+ *   UpdateRecommenderConfiguration: {
+ *     Attributes: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     Description: "STRING_VALUE",
+ *     Name: "STRING_VALUE",
+ *     RecommendationProviderIdType: "STRING_VALUE",
+ *     RecommendationProviderRoleArn: "STRING_VALUE", // required
+ *     RecommendationProviderUri: "STRING_VALUE", // required
+ *     RecommendationTransformerUri: "STRING_VALUE",
+ *     RecommendationsDisplayName: "STRING_VALUE",
+ *     RecommendationsPerMessage: Number("int"),
+ *   },
+ * };
  * const command = new UpdateRecommenderConfigurationCommand(input);
  * const response = await client.send(command);
  * ```