openapi: 3.0.0 info: version: 2016-12-01 x-release: v4 title: Amazon Pinpoint Applications Apps API description: Doc Engage API - Amazon Pinpoint API x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: pinpoint x-aws-signingName: mobiletargeting x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pinpoint-2016-12-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://pinpoint.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Pinpoint multi-region endpoint - url: https://pinpoint.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Pinpoint multi-region endpoint - url: http://pinpoint.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia) - url: https://pinpoint.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Apps paths: /v1/apps: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateApp description: '

Creates an application.

' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAppResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - CreateApplicationRequest properties: CreateApplicationRequest: description: Specifies the display name of an application and the tags to associate with the application. type: object properties: Name: allOf: - $ref: '#/components/schemas/__string' - description: The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create App tags: - Apps get: operationId: GetApps description: Retrieves information about all the applications that are associated with your Amazon Pinpoint account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAppsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apps tags: - Apps /v1/apps/{application-id}/campaigns: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateCampaign description: Creates a new campaign for an application or updates the settings of an existing campaign for an application. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteCampaignRequest properties: WriteCampaignRequest: description: Specifies the configuration and other settings for a campaign. type: object properties: AdditionalTreatments: allOf: - $ref: '#/components/schemas/ListOfWriteTreatmentResource' - description: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. CustomDeliveryConfiguration: allOf: - $ref: '#/components/schemas/CustomDeliveryConfiguration' - description: The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object. Description: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the campaign. HoldoutPercent: allOf: - $ref: '#/components/schemas/__integer' - description: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. Hook: allOf: - $ref: '#/components/schemas/CampaignHook' - description: The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign. IsPaused: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false. Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The messaging limits for the campaign. MessageConfiguration: allOf: - $ref: '#/components/schemas/MessageConfiguration' - description: The message configuration settings for the campaign. Name: allOf: - $ref: '#/components/schemas/__string' - description: A custom name for the campaign. Schedule: allOf: - $ref: '#/components/schemas/Schedule' - description: The schedule settings for the campaign. SegmentId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment to associate with the campaign. SegmentVersion: allOf: - $ref: '#/components/schemas/__integer' - description: The version of the segment to associate with the campaign. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template to use for the campaign. TreatmentDescription: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the default treatment for the campaign. TreatmentName: allOf: - $ref: '#/components/schemas/__string' - description: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing. Priority: allOf: - $ref: '#/components/schemas/__integer' - description: Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Campaign tags: - Apps get: operationId: GetCampaigns description: Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaigns tags: - Apps /v1/apps/{application-id}/jobs/export: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateExportJob description: Creates an export job for an application. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateExportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - ExportJobRequest properties: ExportJobRequest: description: Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket. type: object properties: RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to. S3UrlPrefix: allOf: - $ref: '#/components/schemas/__string' - description: 'The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.' SegmentId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application. SegmentVersion: allOf: - $ref: '#/components/schemas/__integer' - description: The version of the segment to export endpoint definitions from, if specified. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Export Job tags: - Apps get: operationId: GetExportJobs description: Retrieves information about the status and settings of all the export jobs for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetExportJobsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Export Jobs tags: - Apps /v1/apps/{application-id}/jobs/import: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateImportJob description: Creates an import job for an application. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateImportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - ImportJobRequest properties: ImportJobRequest: description: Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket. type: object properties: DefineSegment: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported. ExternalId: allOf: - $ref: '#/components/schemas/__string' - description: (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint. Format: allOf: - $ref: '#/components/schemas/Format' - description: 'The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.' RegisterEndpoints: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported. RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from. S3Url: allOf: - $ref: '#/components/schemas/__string' - description: '

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

' SegmentId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment. SegmentName: allOf: - $ref: '#/components/schemas/__string' - description: A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Import Job tags: - Apps get: operationId: GetImportJobs description: Retrieves information about the status and settings of all the import jobs for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetImportJobsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Import Jobs tags: - Apps /v1/apps/{application-id}/journeys: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateJourney description: Creates a journey for an application. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateJourneyResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteJourneyRequest properties: WriteJourneyRequest: description: Specifies the configuration and other settings for a journey. type: object properties: Activities: allOf: - $ref: '#/components/schemas/MapOfActivity' - description: A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the journey was created. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the journey was last modified. Limits: allOf: - $ref: '#/components/schemas/JourneyLimits' - description: The messaging and entry limits for the journey. LocalTime: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description:

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

RefreshFrequency: allOf: - $ref: '#/components/schemas/__string' - description: The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format. Schedule: allOf: - $ref: '#/components/schemas/JourneySchedule' - description: The schedule settings for the journey. StartActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters. StartCondition: allOf: - $ref: '#/components/schemas/StartCondition' - description: The segment that defines which users are participants in the journey. State: allOf: - $ref: '#/components/schemas/State' - description:

The status of the journey. Valid values are:

PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.

WaitForQuietTime: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours. RefreshOnSegmentUpdate: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether a journey should be refreshed on segment update. JourneyChannelSettings: allOf: - $ref: '#/components/schemas/JourneyChannelSettings' - description: The channel-specific configurations for the journey. SendingSchedule: allOf: - $ref: '#/components/schemas/__boolean' - description: Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays) OpenHours: allOf: - $ref: '#/components/schemas/OpenHours' - description: The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true. ClosedDays: allOf: - $ref: '#/components/schemas/ClosedDays' - description: The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Journey tags: - Apps get: operationId: ListJourneys description: Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListJourneysResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint List Journeys tags: - Apps /v1/apps/{application-id}/segments: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateSegment description: Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteSegmentRequest properties: WriteSegmentRequest: description: Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both. type: object properties: Dimensions: allOf: - $ref: '#/components/schemas/SegmentDimensions' - description: The criteria that define the dimensions for the segment. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the segment. SegmentGroups: allOf: - $ref: '#/components/schemas/SegmentGroupList' - description: The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Segment tags: - Apps get: operationId: GetSegments description: Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segments tags: - Apps /v1/apps/{application-id}/channels/adm: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteAdmChannel description: Disables the ADM channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteAdmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Adm Channel tags: - Apps get: operationId: GetAdmChannel description: Retrieves information about the status and settings of the ADM channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAdmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Adm Channel tags: - Apps put: operationId: UpdateAdmChannel description: Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateAdmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - ADMChannelRequest properties: ADMChannelRequest: description: Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application. type: object properties: ClientId: allOf: - $ref: '#/components/schemas/__string' - description: The Client ID that you received from Amazon to send messages by using ADM. ClientSecret: allOf: - $ref: '#/components/schemas/__string' - description: The Client Secret that you received from Amazon to send messages by using ADM. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the ADM channel for the application. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Adm Channel tags: - Apps /v1/apps/{application-id}/channels/apns: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsChannel description: Disables the APNs channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Channel tags: - Apps get: operationId: GetApnsChannel description: Retrieves information about the status and settings of the APNs channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Channel tags: - Apps put: operationId: UpdateApnsChannel description: Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSChannelRequest properties: APNSChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the APNs channel for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Channel tags: - Apps /v1/apps/{application-id}/channels/apns_sandbox: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsSandboxChannel description: Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Sandbox Channel tags: - Apps get: operationId: GetApnsSandboxChannel description: Retrieves information about the status and settings of the APNs sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Sandbox Channel tags: - Apps put: operationId: UpdateApnsSandboxChannel description: Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSSandboxChannelRequest properties: APNSSandboxChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the APNs sandbox channel for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Sandbox Channel tags: - Apps /v1/apps/{application-id}/channels/apns_voip: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsVoipChannel description: Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsVoipChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Voip Channel tags: - Apps get: operationId: GetApnsVoipChannel description: Retrieves information about the status and settings of the APNs VoIP channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsVoipChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Voip Channel tags: - Apps put: operationId: UpdateApnsVoipChannel description: Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsVoipChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSVoipChannelRequest properties: APNSVoipChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the APNs VoIP channel for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Voip Channel tags: - Apps /v1/apps/{application-id}/channels/apns_voip_sandbox: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsVoipSandboxChannel description: Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsVoipSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Voip Sandbox Channel tags: - Apps get: operationId: GetApnsVoipSandboxChannel description: Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsVoipSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Voip Sandbox Channel tags: - Apps put: operationId: UpdateApnsVoipSandboxChannel description: Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsVoipSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSVoipSandboxChannelRequest properties: APNSVoipSandboxChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the APNs VoIP sandbox channel is enabled for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Voip Sandbox Channel tags: - Apps /v1/apps/{application-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApp description: Deletes an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteAppResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete App tags: - Apps get: operationId: GetApp description: Retrieves information about an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAppResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get App tags: - Apps /v1/apps/{application-id}/channels/baidu: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteBaiduChannel description: Disables the Baidu channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteBaiduChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Baidu Channel tags: - Apps get: operationId: GetBaiduChannel description: Retrieves information about the status and settings of the Baidu channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetBaiduChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Baidu Channel tags: - Apps put: operationId: UpdateBaiduChannel description: Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateBaiduChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - BaiduChannelRequest properties: BaiduChannelRequest: description: Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application. type: object properties: ApiKey: allOf: - $ref: '#/components/schemas/__string' - description: The API key that you received from the Baidu Cloud Push service to communicate with the service. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the Baidu channel for the application. SecretKey: allOf: - $ref: '#/components/schemas/__string' - description: The secret key that you received from the Baidu Cloud Push service to communicate with the service. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Baidu Channel tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteCampaign description: Deletes a campaign from an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Campaign tags: - Apps get: operationId: GetCampaign description: Retrieves information about the status, configuration, and other settings for a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign tags: - Apps put: operationId: UpdateCampaign description: Updates the configuration and other settings for a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteCampaignRequest properties: WriteCampaignRequest: description: Specifies the configuration and other settings for a campaign. type: object properties: AdditionalTreatments: allOf: - $ref: '#/components/schemas/ListOfWriteTreatmentResource' - description: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. CustomDeliveryConfiguration: allOf: - $ref: '#/components/schemas/CustomDeliveryConfiguration' - description: The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object. Description: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the campaign. HoldoutPercent: allOf: - $ref: '#/components/schemas/__integer' - description: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. Hook: allOf: - $ref: '#/components/schemas/CampaignHook' - description: The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign. IsPaused: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false. Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The messaging limits for the campaign. MessageConfiguration: allOf: - $ref: '#/components/schemas/MessageConfiguration' - description: The message configuration settings for the campaign. Name: allOf: - $ref: '#/components/schemas/__string' - description: A custom name for the campaign. Schedule: allOf: - $ref: '#/components/schemas/Schedule' - description: The schedule settings for the campaign. SegmentId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment to associate with the campaign. SegmentVersion: allOf: - $ref: '#/components/schemas/__integer' - description: The version of the segment to associate with the campaign. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template to use for the campaign. TreatmentDescription: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the default treatment for the campaign. TreatmentName: allOf: - $ref: '#/components/schemas/__string' - description: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing. Priority: allOf: - $ref: '#/components/schemas/__integer' - description: Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Campaign tags: - Apps /v1/apps/{application-id}/channels/email: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEmailChannel description: Disables the email channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEmailChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Email Channel tags: - Apps get: operationId: GetEmailChannel description: Retrieves information about the status and settings of the email channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEmailChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Email Channel tags: - Apps put: operationId: UpdateEmailChannel description: Enables the email channel for an application or updates the status and settings of the email channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEmailChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EmailChannelRequest properties: EmailChannelRequest: description: Specifies the status and settings of the email channel for an application. type: object properties: ConfigurationSet: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon SES configuration set that you want to apply to messages that you send through the channel. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the email channel for the application. FromAddress: allOf: - $ref: '#/components/schemas/__string' - description: '

The verified email address that you want to send email from when you send email through the channel.

' Identity: allOf: - $ref: '#/components/schemas/__string' - description: '

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

' RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: '

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Email Channel tags: - Apps /v1/apps/{application-id}/endpoints/{endpoint-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEndpoint description: Deletes an endpoint from an application. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEndpointResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Endpoint tags: - Apps get: operationId: GetEndpoint description: Retrieves information about the settings and attributes of a specific endpoint for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEndpointResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Endpoint tags: - Apps put: operationId: UpdateEndpoint description: Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEndpointResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EndpointRequest properties: EndpointRequest: description: Specifies the channel type and other settings for an endpoint. type: object properties: Address: allOf: - $ref: '#/components/schemas/__string' - description: The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. Attributes: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: '

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can''t display attribute names that contain these characters. This restriction doesn''t apply to attribute values.

' ChannelType: allOf: - $ref: '#/components/schemas/ChannelType' - description: The channel to use when sending messages or push notifications to the endpoint. Demographic: allOf: - $ref: '#/components/schemas/EndpointDemographic' - description: The demographic information for the endpoint, such as the time zone and platform. EffectiveDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the endpoint is updated. EndpointStatus: allOf: - $ref: '#/components/schemas/__string' - description: '

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

' Location: allOf: - $ref: '#/components/schemas/EndpointLocation' - description: The geographic information for the endpoint. Metrics: allOf: - $ref: '#/components/schemas/MapOf__double' - description: One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. OptOut: allOf: - $ref: '#/components/schemas/__string' - description: 'Specifies whether the user who''s associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn''t want to receive any messages or push notifications; and, NONE, the user hasn''t opted out and wants to receive all messages and push notifications.' RequestId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the most recent request to update the endpoint. User: allOf: - $ref: '#/components/schemas/EndpointUser' - description: One or more custom attributes that describe the user who's associated with the endpoint. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Endpoint tags: - Apps /v1/apps/{application-id}/eventstream: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEventStream description: Deletes the event stream for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEventStreamResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Event Stream tags: - Apps get: operationId: GetEventStream description: Retrieves information about the event stream settings for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEventStreamResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Event Stream tags: - Apps post: operationId: PutEventStream description: Creates a new event stream for an application or updates the settings of an existing event stream for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEventStreamResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteEventStream properties: WriteEventStream: description: Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events. type: object properties: DestinationStreamArn: allOf: - $ref: '#/components/schemas/__string' - description: "

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name\n

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name\n

" RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Put Event Stream tags: - Apps /v1/apps/{application-id}/channels/gcm: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteGcmChannel description: Disables the GCM channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteGcmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Gcm Channel tags: - Apps get: operationId: GetGcmChannel description: Retrieves information about the status and settings of the GCM channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetGcmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Gcm Channel tags: - Apps put: operationId: UpdateGcmChannel description: Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateGcmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - GCMChannelRequest properties: GCMChannelRequest: description: Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. type: object properties: ApiKey: allOf: - $ref: '#/components/schemas/__string' - description: The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the GCM channel for the application. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Gcm Channel tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteJourney description: Deletes a journey from an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteJourneyResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Journey tags: - Apps get: operationId: GetJourney description: Retrieves information about the status, configuration, and other settings for a journey. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJourneyResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Journey tags: - Apps put: operationId: UpdateJourney description: Updates the configuration and other settings for a journey. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateJourneyResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '487': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteJourneyRequest properties: WriteJourneyRequest: description: Specifies the configuration and other settings for a journey. type: object properties: Activities: allOf: - $ref: '#/components/schemas/MapOfActivity' - description: A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the journey was created. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the journey was last modified. Limits: allOf: - $ref: '#/components/schemas/JourneyLimits' - description: The messaging and entry limits for the journey. LocalTime: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description:

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

RefreshFrequency: allOf: - $ref: '#/components/schemas/__string' - description: The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format. Schedule: allOf: - $ref: '#/components/schemas/JourneySchedule' - description: The schedule settings for the journey. StartActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters. StartCondition: allOf: - $ref: '#/components/schemas/StartCondition' - description: The segment that defines which users are participants in the journey. State: allOf: - $ref: '#/components/schemas/State' - description:

The status of the journey. Valid values are:

PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.

WaitForQuietTime: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours. RefreshOnSegmentUpdate: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether a journey should be refreshed on segment update. JourneyChannelSettings: allOf: - $ref: '#/components/schemas/JourneyChannelSettings' - description: The channel-specific configurations for the journey. SendingSchedule: allOf: - $ref: '#/components/schemas/__boolean' - description: Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays) OpenHours: allOf: - $ref: '#/components/schemas/OpenHours' - description: The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true. ClosedDays: allOf: - $ref: '#/components/schemas/ClosedDays' - description: The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Journey tags: - Apps /v1/apps/{application-id}/segments/{segment-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteSegment description: Deletes a segment from an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Segment tags: - Apps get: operationId: GetSegment description: Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment tags: - Apps put: operationId: UpdateSegment description: Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteSegmentRequest properties: WriteSegmentRequest: description: Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both. type: object properties: Dimensions: allOf: - $ref: '#/components/schemas/SegmentDimensions' - description: The criteria that define the dimensions for the segment. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the segment. SegmentGroups: allOf: - $ref: '#/components/schemas/SegmentGroupList' - description: The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Segment tags: - Apps /v1/apps/{application-id}/channels/sms: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteSmsChannel description: Disables the SMS channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSmsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Sms Channel tags: - Apps get: operationId: GetSmsChannel description: Retrieves information about the status and settings of the SMS channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSmsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Sms Channel tags: - Apps put: operationId: UpdateSmsChannel description: Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSmsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - SMSChannelRequest properties: SMSChannelRequest: description: Specifies the status and settings of the SMS channel for an application. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the SMS channel for the application. SenderId: allOf: - $ref: '#/components/schemas/__string' - description: The identity that you want to display on recipients' devices when they receive messages from the SMS channel. ShortCode: allOf: - $ref: '#/components/schemas/__string' - description: The registered short code that you want to use when you send messages through the SMS channel. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Sms Channel tags: - Apps /v1/apps/{application-id}/users/{user-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteUserEndpoints description: Deletes all the endpoints that are associated with a specific user ID. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteUserEndpointsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: user-id in: path required: true description: The unique identifier for the user. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete User Endpoints tags: - Apps get: operationId: GetUserEndpoints description: Retrieves information about all the endpoints that are associated with a specific user ID. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetUserEndpointsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: user-id in: path required: true description: The unique identifier for the user. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get User Endpoints tags: - Apps /v1/apps/{application-id}/channels/voice: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteVoiceChannel description: Disables the voice channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVoiceChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Voice Channel tags: - Apps get: operationId: GetVoiceChannel description: Retrieves information about the status and settings of the voice channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetVoiceChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Voice Channel tags: - Apps put: operationId: UpdateVoiceChannel description: Enables the voice channel for an application or updates the status and settings of the voice channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateVoiceChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - VoiceChannelRequest properties: VoiceChannelRequest: description: Specifies the status and settings of the voice channel for an application. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the voice channel for the application. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Voice Channel tags: - Apps /v1/apps/{application-id}/kpis/daterange/{kpi-name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetApplicationDateRangeKpi description: Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApplicationDateRangeKpiResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: end-time in: query required: false description: 'The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.' schema: type: string format: date-time - name: kpi-name in: path required: true description: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: start-time in: query required: false description: 'The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.' schema: type: string format: date-time x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Application Date Range Kpi tags: - Apps /v1/apps/{application-id}/settings: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetApplicationSettings description: Retrieves information about the settings for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApplicationSettingsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Application Settings tags: - Apps put: operationId: UpdateApplicationSettings description: Updates the settings for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationSettingsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteApplicationSettingsRequest properties: WriteApplicationSettingsRequest: description: Specifies the default settings for an application. type: object properties: CampaignHook: allOf: - $ref: '#/components/schemas/CampaignHook' - description:

The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

CloudWatchMetricsEnabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable application-related alarms in Amazon CloudWatch. EventTaggingEnabled: $ref: '#/components/schemas/__boolean' Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description:

The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Application Settings tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/activities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignActivities description: Retrieves information about all the activities for a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignActivitiesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Activities tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignDateRangeKpi description: Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignDateRangeKpiResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: end-time in: query required: false description: 'The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.' schema: type: string format: date-time - name: kpi-name in: path required: true description: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: start-time in: query required: false description: 'The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.' schema: type: string format: date-time x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Date Range Kpi tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignVersion description: Retrieves information about the status, configuration, and other settings for a specific version of a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignVersionResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: version in: path required: true description: The unique version number (Version property) for the campaign version. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Version tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignVersions description: Retrieves information about the status, configuration, and other settings for all versions of a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignVersionsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Versions tags: - Apps /v1/apps/{application-id}/channels: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetChannels description: Retrieves information about the history and status of each channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetChannelsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Channels tags: - Apps /v1/apps/{application-id}/jobs/export/{job-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetExportJob description: Retrieves information about the status and settings of a specific export job for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetExportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: job-id in: path required: true description: The unique identifier for the job. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Export Job tags: - Apps /v1/apps/{application-id}/jobs/import/{job-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetImportJob description: Retrieves information about the status and settings of a specific import job for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetImportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: job-id in: path required: true description: The unique identifier for the job. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Import Job tags: - Apps /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetInAppMessages description: Retrieves the in-app messages targeted for the provided endpoint ID. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetInAppMessagesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get in App Messages tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetJourneyDateRangeKpi description: Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJourneyDateRangeKpiResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: end-time in: query required: false description: 'The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.' schema: type: string format: date-time - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string - name: kpi-name in: path required: true description: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: start-time in: query required: false description: 'The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.' schema: type: string format: date-time x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Journey Date Range Kpi tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetJourneyExecutionActivityMetrics description: Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJourneyExecutionActivityMetricsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-activity-id in: path required: true description: The unique identifier for the journey activity. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Journey Execution Activity Metrics tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}/execution-metrics: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetJourneyExecutionMetrics description: Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJourneyExecutionMetricsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Journey Execution Metrics tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/jobs/export: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentExportJobs description: Retrieves information about the status and settings of the export jobs for a segment. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentExportJobsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Export Jobs tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/jobs/import: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentImportJobs description: Retrieves information about the status and settings of the import jobs for a segment. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentImportJobsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Import Jobs tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/versions/{version}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentVersion description: Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentVersionResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: version in: path required: true description: The unique version number (Version property) for the campaign version. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Version tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentVersions description: Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentVersionsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Versions tags: - Apps /v1/apps/{application-id}/events: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: PutEvents description: Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEventsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EventsRequest properties: EventsRequest: description: Specifies a batch of events to process. type: object properties: BatchItem: allOf: - $ref: '#/components/schemas/MapOfEventsBatch' - description: The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Put Events tags: - Apps /v1/apps/{application-id}/attributes/{attribute-type}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: RemoveAttributes description: Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveAttributesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: attribute-type in: path required: true description: '

The type of attribute or attributes to remove. Valid values are:

' schema: type: string requestBody: required: true content: application/json: schema: type: object required: - UpdateAttributesRequest properties: UpdateAttributesRequest: description: Specifies one or more attributes to remove from all the endpoints that are associated with an application. type: object properties: Blacklist: allOf: - $ref: '#/components/schemas/ListOf__string' - description: An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Remove Attributes tags: - Apps /v1/apps/{application-id}/messages: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendMessages description: Creates and sends a direct message. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendMessagesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - MessageRequest properties: MessageRequest: description: Specifies the configuration and other settings for a message. type: object properties: Addresses: allOf: - $ref: '#/components/schemas/MapOfAddressConfiguration' - description: A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables. Context: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes. Endpoints: allOf: - $ref: '#/components/schemas/MapOfEndpointSendConfiguration' - description: A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables. MessageConfiguration: allOf: - $ref: '#/components/schemas/DirectMessageConfiguration' - description: The settings and content for the default message and any default messages that you defined for specific channels. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template to use for the message. TraceId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for tracing the message. This identifier is visible to message recipients. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Send Messages tags: - Apps /v1/apps/{application-id}/otp: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendOTPMessage description: Send an OTP message responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendOTPMessageResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique ID of your Amazon Pinpoint application. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - SendOTPMessageRequestParameters properties: SendOTPMessageRequestParameters: description: Send OTP message request parameters. type: object properties: AllowedAttempts: allOf: - $ref: '#/components/schemas/__integer' - description: The attempts allowed to validate an OTP. BrandName: allOf: - $ref: '#/components/schemas/__string' - description: The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account. Channel: allOf: - $ref: '#/components/schemas/__string' - description: 'Channel type for the OTP message. Supported values: [SMS].' CodeLength: allOf: - $ref: '#/components/schemas/__integer' - description: The number of characters in the generated OTP. DestinationIdentity: allOf: - $ref: '#/components/schemas/__string' - description: The destination identity to send OTP to. EntityId: allOf: - $ref: '#/components/schemas/__string' - description: A unique Entity ID received from DLT after entity registration is approved. Language: allOf: - $ref: '#/components/schemas/__string' - description: The language to be used for the outgoing message body containing the OTP. OriginationIdentity: allOf: - $ref: '#/components/schemas/__string' - description: The origination identity used to send OTP from. ReferenceId: allOf: - $ref: '#/components/schemas/__string' - description: Developer-specified reference identifier. Required to match during OTP verification. TemplateId: allOf: - $ref: '#/components/schemas/__string' - description: A unique Template ID received from DLT after entity registration is approved. ValidityPeriod: allOf: - $ref: '#/components/schemas/__integer' - description: The time in minutes before the OTP is no longer valid. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Send O T P Message tags: - Apps /v1/apps/{application-id}/users-messages: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendUsersMessages description: Creates and sends a message to a list of users. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendUsersMessagesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - SendUsersMessageRequest properties: SendUsersMessageRequest: description: Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users. type: object properties: Context: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries. MessageConfiguration: allOf: - $ref: '#/components/schemas/DirectMessageConfiguration' - description: The settings and content for the default message and any default messages that you defined for specific channels. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template to use for the message. TraceId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for tracing the message. This identifier is visible to message recipients. Users: allOf: - $ref: '#/components/schemas/MapOfEndpointSendConfiguration' - description: A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Send Users Messages tags: - Apps /v1/apps/{application-id}/endpoints: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateEndpointsBatch description: Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEndpointsBatchResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EndpointBatchRequest properties: EndpointBatchRequest: description: Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint. type: object properties: Item: allOf: - $ref: '#/components/schemas/ListOfEndpointBatchItem' - description: An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Endpoints Batch tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}/state: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateJourneyState description: Cancels (stops) an active journey. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateJourneyStateResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - JourneyStateRequest properties: JourneyStateRequest: description: Changes the status of a journey. type: object properties: State: allOf: - $ref: '#/components/schemas/State' - description:

The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED

If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Journey State tags: - Apps /v1/apps/{application-id}/verify-otp: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: VerifyOTPMessage description: Verify an OTP responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VerifyOTPMessageResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique ID of your Amazon Pinpoint application. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - VerifyOTPMessageRequestParameters properties: VerifyOTPMessageRequestParameters: description: Verify OTP message request. type: object properties: DestinationIdentity: allOf: - $ref: '#/components/schemas/__string' - description: The destination identity to send OTP to. Otp: allOf: - $ref: '#/components/schemas/__string' - description: The OTP the end user provided for verification. ReferenceId: allOf: - $ref: '#/components/schemas/__string' - description: The reference identifier provided when the OTP was previously sent. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Verify O T P Message tags: - Apps components: schemas: EndpointDemographic: type: object properties: AppVersion: allOf: - $ref: '#/components/schemas/__string' - description: The version of the app that's associated with the endpoint. Locale: allOf: - $ref: '#/components/schemas/__string' - description: 'The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.' Make: allOf: - $ref: '#/components/schemas/__string' - description: The manufacturer of the endpoint device, such as apple or samsung. Model: allOf: - $ref: '#/components/schemas/__string' - description: The model name or number of the endpoint device, such as iPhone or SM-G900F. ModelVersion: allOf: - $ref: '#/components/schemas/__string' - description: The model version of the endpoint device. Platform: allOf: - $ref: '#/components/schemas/__string' - description: The platform of the endpoint device, such as ios. PlatformVersion: allOf: - $ref: '#/components/schemas/__string' - description: The platform version of the endpoint device. Timezone: allOf: - $ref: '#/components/schemas/__string' - description: The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles. description: Specifies demographic information about an endpoint, such as the applicable time zone and platform. JourneyEmailMessage: type: object properties: FromAddress: allOf: - $ref: '#/components/schemas/__string' - description: The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application. description: Specifies the "From" address for an email message that's sent to participants in a journey. State: type: string enum: - DRAFT - ACTIVE - COMPLETED - CANCELLED - CLOSED - PAUSED EmailMessageActivity: type: object properties: MessageConfig: allOf: - $ref: '#/components/schemas/JourneyEmailMessage' - description: Specifies the sender address for an email message that's sent to participants in the journey. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after the message is sent. TemplateName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the email message template to use for the message. If specified, this value must match the name of an existing message template. TemplateVersion: allOf: - $ref: '#/components/schemas/__string' - description:

The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

description: Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants. ClosedDaysRule: type: object properties: Name: allOf: - $ref: '#/components/schemas/__string' - description: Name of the rule. StartDateTime: allOf: - $ref: '#/components/schemas/__string' - description: Start Datetime in ISO 8601 format. EndDateTime: allOf: - $ref: '#/components/schemas/__string' - description: End Datetime in ISO 8601 format. description: Closed Days Rule. Part of Journey sending schedule. DimensionType: type: string enum: - INCLUSIVE - EXCLUSIVE EventStream: type: object required: - ApplicationId - RoleArn - DestinationStreamArn properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application to publish event data for. DestinationStreamArn: allOf: - $ref: '#/components/schemas/__string' - description: "

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name\n

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name\n

" ExternalId: allOf: - $ref: '#/components/schemas/__string' - description: (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the event stream was last modified. LastUpdatedBy: allOf: - $ref: '#/components/schemas/__string' - description: The IAM user who last modified the event stream. RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account. description: Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream. DeleteApnsVoipChannelResponse: type: object required: - APNSVoipChannelResponse properties: APNSVoipChannelResponse: $ref: '#/components/schemas/APNSVoipChannelResponse' UpdateAdmChannelResponse: type: object required: - ADMChannelResponse properties: ADMChannelResponse: $ref: '#/components/schemas/ADMChannelResponse' InternalServerErrorException: {} SegmentType: type: string enum: - DIMENSIONAL - IMPORT InAppCampaignSchedule: type: object properties: EndDate: allOf: - $ref: '#/components/schemas/__string' - description: The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format. EventFilter: allOf: - $ref: '#/components/schemas/CampaignEventFilter' - description: The event filter the SDK has to use to show the in-app message in the application. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description: Time during which the in-app message should not be shown to the user. description: Schedule of the campaign. CampaignResponse: type: object required: - LastModifiedDate - CreationDate - SegmentId - SegmentVersion - Id - Arn - ApplicationId properties: AdditionalTreatments: allOf: - $ref: '#/components/schemas/ListOfTreatmentResource' - description: An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment. ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the campaign applies to. Arn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the campaign. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the campaign was created. CustomDeliveryConfiguration: allOf: - $ref: '#/components/schemas/CustomDeliveryConfiguration' - description: The delivery configuration settings for sending the campaign through a custom channel. DefaultState: allOf: - $ref: '#/components/schemas/CampaignState' - description: The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment. Description: allOf: - $ref: '#/components/schemas/__string' - description: The custom description of the campaign. HoldoutPercent: allOf: - $ref: '#/components/schemas/__integer' - description: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. Hook: allOf: - $ref: '#/components/schemas/CampaignHook' - description: The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the campaign. IsPaused: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the campaign was last modified. Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The messaging limits for the campaign. MessageConfiguration: allOf: - $ref: '#/components/schemas/MessageConfiguration' - description: The message configuration settings for the campaign. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the campaign. Schedule: allOf: - $ref: '#/components/schemas/Schedule' - description: The schedule settings for the campaign. SegmentId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment that's associated with the campaign. SegmentVersion: allOf: - $ref: '#/components/schemas/__integer' - description: The version number of the segment that's associated with the campaign. State: allOf: - $ref: '#/components/schemas/CampaignState' - description: The current status of the campaign. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template that’s used for the campaign. TreatmentDescription: allOf: - $ref: '#/components/schemas/__string' - description: The custom description of the default treatment for the campaign. TreatmentName: allOf: - $ref: '#/components/schemas/__string' - description: The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The version number of the campaign. Priority: allOf: - $ref: '#/components/schemas/__integer' - description: Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment. description: Provides information about the status, configuration, and other settings for a campaign. MessageResponse: type: object required: - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that was used to send the message. EndpointResult: allOf: - $ref: '#/components/schemas/MapOfEndpointMessageResult' - description: A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value. RequestId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier for the original request that the message was delivered for. Result: allOf: - $ref: '#/components/schemas/MapOfMessageResult' - description: A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value. description: Provides information about the results of a request to send a message to an endpoint address. ApplicationResponse: type: object required: - Id - Arn - Name properties: Arn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the application. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. Name: allOf: - $ref: '#/components/schemas/__string' - description: The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the Application was created. description: Provides information about an application. BaiduMessage: type: object properties: Action: allOf: - $ref: '#/components/schemas/Action' - description:

The action to occur if the recipient taps the push notification. Valid values are:

Body: allOf: - $ref: '#/components/schemas/__string' - description: The body of the notification message. Data: allOf: - $ref: '#/components/schemas/MapOf__string' - description: The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. IconReference: allOf: - $ref: '#/components/schemas/__string' - description: The icon image name of the asset saved in your app. ImageIconUrl: allOf: - $ref: '#/components/schemas/__string' - description: The URL of the large icon image to display in the content view of the push notification. ImageUrl: allOf: - $ref: '#/components/schemas/__string' - description: The URL of an image to display in the push notification. RawContent: allOf: - $ref: '#/components/schemas/__string' - description: The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message. SilentPush: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. SmallImageIconUrl: allOf: - $ref: '#/components/schemas/__string' - description: The URL of the small icon image to display in the status bar and the content view of the push notification. Sound: allOf: - $ref: '#/components/schemas/__string' - description: The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The default message variables to use in the notification message. You can override the default variables with individual address variables. TimeToLive: allOf: - $ref: '#/components/schemas/__integer' - description: The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days). Title: allOf: - $ref: '#/components/schemas/__string' - description: The title to display above the notification message on the recipient's device. Url: allOf: - $ref: '#/components/schemas/__string' - description: The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. description: Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel. JourneyExecutionMetricsResponse: type: object required: - Metrics - JourneyId - LastEvaluatedTime - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the metric applies to. JourneyId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the journey that the metric applies to. LastEvaluatedTime: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric. Metrics: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide. description: Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query. Schedule: type: object required: - StartTime properties: EndTime: allOf: - $ref: '#/components/schemas/__string' - description: The scheduled time, in ISO 8601 format, when the campaign ended or will end. EventFilter: allOf: - $ref: '#/components/schemas/CampaignEventFilter' - description: The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT. Frequency: allOf: - $ref: '#/components/schemas/Frequency' - description: Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. IsLocalTime: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description:

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

StartTime: allOf: - $ref: '#/components/schemas/__string' - description: 'The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.' Timezone: allOf: - $ref: '#/components/schemas/__string' - description: "The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,\n UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,\n UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11." description: Specifies the schedule settings for a campaign. ListJourneysResponse: type: object required: - JourneysResponse properties: JourneysResponse: $ref: '#/components/schemas/JourneysResponse' OverrideButtonConfiguration: type: object required: - ButtonAction properties: ButtonAction: allOf: - $ref: '#/components/schemas/ButtonAction' - description: Action triggered by the button. Link: allOf: - $ref: '#/components/schemas/__string' - description: Button destination. description: Override button configuration. DeleteEmailChannelResponse: type: object required: - EmailChannelResponse properties: EmailChannelResponse: $ref: '#/components/schemas/EmailChannelResponse' Frequency: type: string enum: - ONCE - HOURLY - DAILY - WEEKLY - MONTHLY - EVENT - IN_APP_EVENT StartCondition: type: object properties: Description: allOf: - $ref: '#/components/schemas/__string' - description: The custom description of the condition. EventStartCondition: $ref: '#/components/schemas/EventStartCondition' SegmentStartCondition: allOf: - $ref: '#/components/schemas/SegmentCondition' - description: The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey. description: Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey. GetSegmentVersionsResponse: type: object required: - SegmentsResponse properties: SegmentsResponse: $ref: '#/components/schemas/SegmentsResponse' ListOf__string: type: array items: $ref: '#/components/schemas/__string' ListOfEndpointResponse: type: array items: $ref: '#/components/schemas/EndpointResponse' UpdateEndpointsBatchResponse: type: object required: - MessageBody properties: MessageBody: $ref: '#/components/schemas/MessageBody' DeleteBaiduChannelResponse: type: object required: - BaiduChannelResponse properties: BaiduChannelResponse: $ref: '#/components/schemas/BaiduChannelResponse' Event: type: object required: - EventType - Timestamp properties: AppPackageName: allOf: - $ref: '#/components/schemas/__string' - description: The package name of the app that's recording the event. AppTitle: allOf: - $ref: '#/components/schemas/__string' - description: The title of the app that's recording the event. AppVersionCode: allOf: - $ref: '#/components/schemas/__string' - description: The version number of the app that's recording the event. Attributes: allOf: - $ref: '#/components/schemas/MapOf__string' - description: One or more custom attributes that are associated with the event. ClientSdkVersion: allOf: - $ref: '#/components/schemas/__string' - description: The version of the SDK that's running on the client device. EventType: allOf: - $ref: '#/components/schemas/__string' - description: The name of the event. Metrics: allOf: - $ref: '#/components/schemas/MapOf__double' - description: One or more custom metrics that are associated with the event. SdkName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the SDK that's being used to record the event. Session: allOf: - $ref: '#/components/schemas/Session' - description: Information about the session in which the event occurred. Timestamp: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the event occurred. description: Specifies information about an event that reports data to Amazon Pinpoint. ListOfSegmentResponse: type: array items: $ref: '#/components/schemas/SegmentResponse' EventsResponse: type: object properties: Results: allOf: - $ref: '#/components/schemas/MapOfItemResponse' - description: 'A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn''t valid or required fields were missing.' description: Provides information about endpoints and the events that they're associated with. UpdateJourneyStateResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: '#/components/schemas/JourneyResponse' EventCondition: type: object properties: Dimensions: allOf: - $ref: '#/components/schemas/EventDimensions' - description: The dimensions for the event filter to use for the activity. MessageActivity: allOf: - $ref: '#/components/schemas/__string' - description: The message identifier (message_id) for the message to use when determining whether message events meet the condition. description: Specifies the conditions to evaluate for an event that applies to an activity in a journey. JourneysResponse: type: object required: - Item properties: Item: allOf: - $ref: '#/components/schemas/ListOfJourneyResponse' - description: An array of responses, one for each journey that's associated with the application. NextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. description: Provides information about the status, configuration, and other settings for all the journeys that are associated with an application. SendUsersMessageResponse: type: object required: - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that was used to send the message. RequestId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier that was assigned to the message request. Result: allOf: - $ref: '#/components/schemas/MapOfMapOfEndpointMessageResult' - description: An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object. description: Provides information about which users and endpoints a message was sent to. MapOfItemResponse: type: object additionalProperties: $ref: '#/components/schemas/ItemResponse' Mode: type: string enum: - DELIVERY - FILTER CustomMessageActivity: type: object properties: DeliveryUri: allOf: - $ref: '#/components/schemas/__string' - description:

The destination to send the campaign or treatment to. This value can be one of the following:

EndpointTypes: allOf: - $ref: '#/components/schemas/ListOf__EndpointTypesElement' - description: The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint. MessageConfig: allOf: - $ref: '#/components/schemas/JourneyCustomMessage' - description: Specifies the message data included in a custom channel message that's sent to participants in a journey. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook. TemplateName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template. TemplateVersion: allOf: - $ref: '#/components/schemas/__string' - description:

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

description: The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants. Session: type: object required: - StartTimestamp - Id properties: Duration: allOf: - $ref: '#/components/schemas/__integer' - description: The duration of the session, in milliseconds. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the session. StartTimestamp: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the session began. StopTimestamp: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the session ended. description: Provides information about a session. RandomSplitActivity: type: object properties: Branches: allOf: - $ref: '#/components/schemas/ListOfRandomSplitEntry' - description: The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path. description: Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify. GetJourneyExecutionActivityMetricsResponse: type: object required: - JourneyExecutionActivityMetricsResponse properties: JourneyExecutionActivityMetricsResponse: $ref: '#/components/schemas/JourneyExecutionActivityMetricsResponse' GCMChannelResponse: type: object required: - Credential - Platform properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the GCM channel applies to. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the GCM channel was enabled. Credential: allOf: - $ref: '#/components/schemas/__string' - description: The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the GCM channel is enabled for the application. HasCredential: allOf: - $ref: '#/components/schemas/__boolean' - description: (Not used) This property is retained only for backward compatibility. Id: allOf: - $ref: '#/components/schemas/__string' - description: (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the GCM channel is archived. LastModifiedBy: allOf: - $ref: '#/components/schemas/__string' - description: The user who last modified the GCM channel. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the GCM channel was last modified. Platform: allOf: - $ref: '#/components/schemas/__string' - description: The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The current version of the GCM channel. description: Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. MapOfEndpointMessageResult: type: object additionalProperties: $ref: '#/components/schemas/EndpointMessageResult' MapOfEndpointSendConfiguration: type: object additionalProperties: $ref: '#/components/schemas/EndpointSendConfiguration' EndpointBatchItem: type: object properties: Address: allOf: - $ref: '#/components/schemas/__string' - description: The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. Attributes: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: '

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can''t display attribute names that contain these characters. This restriction doesn''t apply to attribute values.

' ChannelType: allOf: - $ref: '#/components/schemas/ChannelType' - description: The channel to use when sending messages or push notifications to the endpoint. Demographic: allOf: - $ref: '#/components/schemas/EndpointDemographic' - description: The demographic information for the endpoint, such as the time zone and platform. EffectiveDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the endpoint was created or updated. EndpointStatus: allOf: - $ref: '#/components/schemas/__string' - description: '

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

' Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the endpoint in the context of the batch. Location: allOf: - $ref: '#/components/schemas/EndpointLocation' - description: The geographic information for the endpoint. Metrics: allOf: - $ref: '#/components/schemas/MapOf__double' - description: One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. OptOut: allOf: - $ref: '#/components/schemas/__string' - description: 'Specifies whether the user who''s associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn''t want to receive any messages or push notifications; and, NONE, the user hasn''t opted out and wants to receive all messages and push notifications.' RequestId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the request to create or update the endpoint. User: allOf: - $ref: '#/components/schemas/EndpointUser' - description: One or more custom attributes that describe the user who's associated with the endpoint. description: Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint. GetCampaignVersionsResponse: type: object required: - CampaignsResponse properties: CampaignsResponse: $ref: '#/components/schemas/CampaignsResponse' ResultRowValue: type: object required: - Type - Value - Key properties: Key: allOf: - $ref: '#/components/schemas/__string' - description: The friendly name of the metric whose value is specified by the Value property. Type: allOf: - $ref: '#/components/schemas/__string' - description: The data type of the value specified by the Value property. Value: allOf: - $ref: '#/components/schemas/__string' - description: In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects). description: Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey. GetApnsVoipSandboxChannelResponse: type: object required: - APNSVoipSandboxChannelResponse properties: APNSVoipSandboxChannelResponse: $ref: '#/components/schemas/APNSVoipSandboxChannelResponse' ListOfRandomSplitEntry: type: array items: $ref: '#/components/schemas/RandomSplitEntry' DeleteGcmChannelResponse: type: object required: - GCMChannelResponse properties: GCMChannelResponse: $ref: '#/components/schemas/GCMChannelResponse' GetImportJobResponse: type: object required: - ImportJobResponse properties: ImportJobResponse: $ref: '#/components/schemas/ImportJobResponse' MessageResult: type: object required: - DeliveryStatus - StatusCode properties: DeliveryStatus: allOf: - $ref: '#/components/schemas/DeliveryStatus' - description:

The delivery status of the message. Possible values are:

MessageId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the message that was sent. StatusCode: allOf: - $ref: '#/components/schemas/__integer' - description: The downstream service status code for delivering the message. StatusMessage: allOf: - $ref: '#/components/schemas/__string' - description: The status message for delivering the message. UpdatedToken: allOf: - $ref: '#/components/schemas/__string' - description: For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message. description: Provides information about the results of sending a message directly to an endpoint address. JourneyExecutionActivityMetricsResponse: type: object required: - Metrics - JourneyId - LastEvaluatedTime - JourneyActivityId - ActivityType - ApplicationId properties: ActivityType: allOf: - $ref: '#/components/schemas/__string' - description:

The type of activity that the metric applies to. Possible values are:

ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the metric applies to. JourneyActivityId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the activity that the metric applies to. JourneyId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the journey that the metric applies to. LastEvaluatedTime: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric. Metrics: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide. description: Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query. GetApnsVoipChannelResponse: type: object required: - APNSVoipChannelResponse properties: APNSVoipChannelResponse: $ref: '#/components/schemas/APNSVoipChannelResponse' CampaignEventFilter: type: object required: - FilterType - Dimensions properties: Dimensions: allOf: - $ref: '#/components/schemas/EventDimensions' - description: The dimension settings of the event filter for the campaign. FilterType: allOf: - $ref: '#/components/schemas/FilterType' - description: 'The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.' description: Specifies the settings for events that cause a campaign to be sent. EventFilter: type: object required: - FilterType - Dimensions properties: Dimensions: allOf: - $ref: '#/components/schemas/EventDimensions' - description: The dimensions for the event filter to use for the campaign or the journey activity. FilterType: allOf: - $ref: '#/components/schemas/FilterType' - description: 'The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.' description: Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed. ChannelResponse: type: object properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the channel was enabled. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the channel is enabled for the application. HasCredential: allOf: - $ref: '#/components/schemas/__boolean' - description: (Not used) This property is retained only for backward compatibility. Id: allOf: - $ref: '#/components/schemas/__string' - description: (Deprecated) An identifier for the channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the channel is archived. LastModifiedBy: allOf: - $ref: '#/components/schemas/__string' - description: The user who last modified the channel. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the channel was last modified. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The current version of the channel. description: Provides information about the general settings and status of a channel for an application. ConflictException: {} SimpleCondition: type: object properties: EventCondition: allOf: - $ref: '#/components/schemas/EventCondition' - description: The dimension settings for the event that's associated with the activity. SegmentCondition: allOf: - $ref: '#/components/schemas/SegmentCondition' - description: The segment that's associated with the activity. SegmentDimensions: allOf: - $ref: '#/components/schemas/SegmentDimensions' - xml: name: segmentDimensions description: The dimension settings for the segment that's associated with the activity. description: Specifies a condition to evaluate for an activity in a journey. __double: type: number format: double InAppMessage: type: object properties: Content: allOf: - $ref: '#/components/schemas/ListOfInAppMessageContent' - description: In-app message content. CustomConfig: allOf: - $ref: '#/components/schemas/MapOf__string' - description: Custom config to be sent to SDK. Layout: allOf: - $ref: '#/components/schemas/Layout' - description: The layout of the message. description: Provides all fields required for building an in-app message. MapOf__double: type: object additionalProperties: $ref: '#/components/schemas/__double' MessageType: type: string enum: - TRANSACTIONAL - PROMOTIONAL CampaignLimits: type: object properties: Daily: allOf: - $ref: '#/components/schemas/__integer' - description: The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100. MaximumDuration: allOf: - $ref: '#/components/schemas/__integer' - description: The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds. MessagesPerSecond: allOf: - $ref: '#/components/schemas/__integer' - description: The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000. Total: allOf: - $ref: '#/components/schemas/__integer' - description: The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100. Session: allOf: - $ref: '#/components/schemas/__integer' - description: The maximum total number of messages that the campaign can send per user session. description: For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send. AttributesResource: type: object required: - AttributeType - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application. AttributeType: allOf: - $ref: '#/components/schemas/__string' - description:

The type of attribute or attributes that were removed from the endpoints. Valid values are:

Attributes: allOf: - $ref: '#/components/schemas/ListOf__string' - description: An array that specifies the names of the attributes that were removed from the endpoints. description: Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application. SMSMessage: type: object properties: Body: allOf: - $ref: '#/components/schemas/__string' - description: The body of the SMS message. Keyword: allOf: - $ref: '#/components/schemas/__string' - description: The SMS program name that you provided to AWS Support when you requested your dedicated number. MediaUrl: allOf: - $ref: '#/components/schemas/__string' - description: This field is reserved for future use. MessageType: allOf: - $ref: '#/components/schemas/MessageType' - description: The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages). OriginationNumber: allOf: - $ref: '#/components/schemas/__string' - description: The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code. SenderId: allOf: - $ref: '#/components/schemas/__string' - description: The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The message variables to use in the SMS message. You can override the default variables with individual address variables. EntityId: allOf: - $ref: '#/components/schemas/__string' - description: The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country. TemplateId: allOf: - $ref: '#/components/schemas/__string' - description: The template ID received from the regulatory body for sending SMS in your country. description: Specifies the default settings for a one-time SMS message that's sent directly to an endpoint. CampaignsResponse: type: object required: - Item properties: Item: allOf: - $ref: '#/components/schemas/ListOfCampaignResponse' - description: An array of responses, one for each campaign that's associated with the application. NextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. description: Provides information about the configuration and other settings for all the campaigns that are associated with an application. ChannelsResponse: type: object required: - Channels properties: Channels: allOf: - $ref: '#/components/schemas/MapOfChannelResponse' - description: A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value. description: Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application. MapOfEventsBatch: type: object additionalProperties: $ref: '#/components/schemas/EventsBatch' FilterType: type: string enum: - SYSTEM - ENDPOINT MapOfActivity: type: object additionalProperties: $ref: '#/components/schemas/Activity' PushMessageActivity: type: object properties: MessageConfig: allOf: - $ref: '#/components/schemas/JourneyPushMessage' - description: Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after the message is sent. TemplateName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template. TemplateVersion: allOf: - $ref: '#/components/schemas/__string' - description:

The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

description: Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants. CreateCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: '#/components/schemas/CampaignResponse' CampaignHook: type: object properties: LambdaFunctionName: allOf: - $ref: '#/components/schemas/__string' - description: The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign. Mode: allOf: - $ref: '#/components/schemas/Mode' - description:

The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

WebUrl: allOf: - $ref: '#/components/schemas/__string' - description: '

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

' description: Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign. Type: type: string enum: - ALL - ANY - NONE JourneySMSMessage: type: object properties: MessageType: allOf: - $ref: '#/components/schemas/MessageType' - description: The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages). OriginationNumber: allOf: - $ref: '#/components/schemas/__string' - description: The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100. SenderId: allOf: - $ref: '#/components/schemas/__string' - description: The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide. EntityId: allOf: - $ref: '#/components/schemas/__string' - description: The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country. TemplateId: allOf: - $ref: '#/components/schemas/__string' - description: The template ID received from the regulatory body for sending SMS in your country. description: Specifies the sender ID and message type for an SMS message that's sent to participants in a journey. ListOfInAppMessageCampaign: type: array items: $ref: '#/components/schemas/InAppMessageCampaign' TemplateConfiguration: type: object properties: EmailTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The email template to use for the message. PushTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The push notification template to use for the message. SMSTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The SMS template to use for the message. VoiceTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The voice template to use for the message. This object isn't supported for campaigns. description: Specifies the message template to use for the message, for each type of channel. Include: type: string enum: - ALL - ANY - NONE GetInAppMessagesResponse: type: object required: - InAppMessagesResponse properties: InAppMessagesResponse: $ref: '#/components/schemas/InAppMessagesResponse' InAppMessageButton: type: object properties: Android: allOf: - $ref: '#/components/schemas/OverrideButtonConfiguration' - description: Default button content. DefaultConfig: allOf: - $ref: '#/components/schemas/DefaultButtonConfiguration' - description: Default button content. IOS: allOf: - $ref: '#/components/schemas/OverrideButtonConfiguration' - description: Default button content. Web: allOf: - $ref: '#/components/schemas/OverrideButtonConfiguration' - description: Default button content. description: Button Config for an in-app message. UpdateCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: '#/components/schemas/CampaignResponse' MetricDimension: type: object required: - ComparisonOperator - Value properties: ComparisonOperator: allOf: - $ref: '#/components/schemas/__string' - description: 'The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.' Value: allOf: - $ref: '#/components/schemas/__double' - description: The value to compare. description: Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints. MapOfListOfOpenHoursRules: type: object additionalProperties: $ref: '#/components/schemas/ListOfOpenHoursRules' ListOfActivityResponse: type: array items: $ref: '#/components/schemas/ActivityResponse' ListOfJourneyResponse: type: array items: $ref: '#/components/schemas/JourneyResponse' VoiceChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the voice channel applies to. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the voice channel was enabled. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the voice channel is enabled for the application. HasCredential: allOf: - $ref: '#/components/schemas/__boolean' - description: (Not used) This property is retained only for backward compatibility. Id: allOf: - $ref: '#/components/schemas/__string' - description: (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the voice channel is archived. LastModifiedBy: allOf: - $ref: '#/components/schemas/__string' - description: The user who last modified the voice channel. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the voice channel was last modified. Platform: allOf: - $ref: '#/components/schemas/__string' - description: The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The current version of the voice channel. description: Provides information about the status and settings of the voice channel for an application. DeleteAppResponse: type: object required: - ApplicationResponse properties: ApplicationResponse: $ref: '#/components/schemas/ApplicationResponse' ActivityResponse: type: object required: - CampaignId - Id - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the campaign applies to. CampaignId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the campaign that the activity applies to. End: allOf: - $ref: '#/components/schemas/__string' - description: The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the activity. Result: allOf: - $ref: '#/components/schemas/__string' - description: Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. ScheduledStart: allOf: - $ref: '#/components/schemas/__string' - description: The scheduled start time, in ISO 8601 format, for the activity. Start: allOf: - $ref: '#/components/schemas/__string' - description: The actual start time, in ISO 8601 format, of the activity. State: allOf: - $ref: '#/components/schemas/__string' - description: 'The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.' SuccessfulEndpointCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoints that the campaign successfully delivered messages to. TimezonesCompletedCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of time zones that were completed. TimezonesTotalCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of unique time zones that are in the segment for the campaign. TotalEndpointCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoints that the campaign attempted to deliver messages to. TreatmentId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign. description: Provides information about an activity that was performed by a campaign. CreateJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: '#/components/schemas/JourneyResponse' GetApplicationDateRangeKpiResponse: type: object required: - ApplicationDateRangeKpiResponse properties: ApplicationDateRangeKpiResponse: $ref: '#/components/schemas/ApplicationDateRangeKpiResponse' Activity: type: object properties: CUSTOM: allOf: - $ref: '#/components/schemas/CustomMessageActivity' - description: The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants. ConditionalSplit: allOf: - $ref: '#/components/schemas/ConditionalSplitActivity' - description: The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify. Description: allOf: - $ref: '#/components/schemas/__string' - description: The custom description of the activity. EMAIL: allOf: - $ref: '#/components/schemas/EmailMessageActivity' - description: The settings for an email activity. This type of activity sends an email message to participants. Holdout: allOf: - $ref: '#/components/schemas/HoldoutActivity' - description: The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants. MultiCondition: allOf: - $ref: '#/components/schemas/MultiConditionalSplitActivity' - description: The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify. PUSH: allOf: - $ref: '#/components/schemas/PushMessageActivity' - description: The settings for a push notification activity. This type of activity sends a push notification to participants. RandomSplit: allOf: - $ref: '#/components/schemas/RandomSplitActivity' - description: The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify. SMS: allOf: - $ref: '#/components/schemas/SMSMessageActivity' - description: The settings for an SMS activity. This type of activity sends a text message to participants. Wait: allOf: - $ref: '#/components/schemas/WaitActivity' - description: The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey. ContactCenter: allOf: - $ref: '#/components/schemas/ContactCenterActivity' - description: The settings for a connect activity. This type of activity initiates a contact center call to participants. description: Specifies the configuration and other settings for an activity in a journey. MultiConditionalBranch: type: object properties: Condition: allOf: - $ref: '#/components/schemas/SimpleCondition' - description: The condition to evaluate for the activity path. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after completing the activity for the path. description: Specifies a condition to evaluate for an activity path in a journey. GetSegmentExportJobsResponse: type: object required: - ExportJobsResponse properties: ExportJobsResponse: $ref: '#/components/schemas/ExportJobsResponse' UpdateSmsChannelResponse: type: object required: - SMSChannelResponse properties: SMSChannelResponse: $ref: '#/components/schemas/SMSChannelResponse' JourneyPushMessage: type: object properties: TimeToLive: allOf: - $ref: '#/components/schemas/__string' - description:

The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

description: Specifies the message configuration for a push notification that's sent to participants in a journey. MapOfAttributeDimension: type: object additionalProperties: $ref: '#/components/schemas/AttributeDimension' SimpleEmailPart: type: object properties: Charset: allOf: - $ref: '#/components/schemas/__string' - description: The applicable character set for the message content. Data: allOf: - $ref: '#/components/schemas/__string' - description: The textual data of the message content. description: Specifies the subject or body of an email message, represented as textual email data and the applicable character set. SimpleEmail: type: object properties: HtmlPart: allOf: - $ref: '#/components/schemas/SimpleEmailPart' - description: The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Subject: allOf: - $ref: '#/components/schemas/SimpleEmailPart' - description: The subject line, or title, of the email. TextPart: allOf: - $ref: '#/components/schemas/SimpleEmailPart' - description: The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. description: Specifies the contents of an email message, composed of a subject, a text part, and an HTML part. MessageBody: type: object properties: Message: allOf: - $ref: '#/components/schemas/__string' - description: The message that's returned from the API. RequestID: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the request or response. description: Provides information about an API request or response. ListOfSegmentReference: type: array items: $ref: '#/components/schemas/SegmentReference' UpdateApnsVoipSandboxChannelResponse: type: object required: - APNSVoipSandboxChannelResponse properties: APNSVoipSandboxChannelResponse: $ref: '#/components/schemas/APNSVoipSandboxChannelResponse' BadRequestException: {} DefaultMessage: type: object properties: Body: allOf: - $ref: '#/components/schemas/__string' - description: The default body of the message. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The default message variables to use in the message. You can override these default variables with individual address variables. description: Specifies the default message for all channels. APNSMessage: type: object properties: APNSPushType: allOf: - $ref: '#/components/schemas/__string' - description:

The type of push notification to send. Valid values are:

Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

Action: allOf: - $ref: '#/components/schemas/Action' - description:

The action to occur if the recipient taps the push notification. Valid values are:

Badge: allOf: - $ref: '#/components/schemas/__integer' - description: The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0. Body: allOf: - $ref: '#/components/schemas/__string' - description: The body of the notification message. Category: allOf: - $ref: '#/components/schemas/__string' - description: The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories. CollapseId: allOf: - $ref: '#/components/schemas/__string' - description:

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

Data: allOf: - $ref: '#/components/schemas/MapOf__string' - description: The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. MediaUrl: allOf: - $ref: '#/components/schemas/__string' - description: The URL of an image or video to display in the push notification. PreferredAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN. Priority: allOf: - $ref: '#/components/schemas/__string' - description:

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>
  • 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

  • /para>

    Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

    The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

    RawContent: allOf: - $ref: '#/components/schemas/__string' - description:

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

    SilentPush: allOf: - $ref: '#/components/schemas/__boolean' - description:

    Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

    Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

    Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

    Sound: allOf: - $ref: '#/components/schemas/__string' - description: The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The default message variables to use in the notification message. You can override these default variables with individual address variables. ThreadId: allOf: - $ref: '#/components/schemas/__string' - description: The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. TimeToLive: allOf: - $ref: '#/components/schemas/__integer' - description:

    The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

    Title: allOf: - $ref: '#/components/schemas/__string' - description: The title to display above the notification message on the recipient's device. Url: allOf: - $ref: '#/components/schemas/__string' - description: The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. description: Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel. ListOfInAppMessageContent: type: array items: $ref: '#/components/schemas/InAppMessageContent' MethodNotAllowedException: {} SendUsersMessagesResponse: type: object required: - SendUsersMessageResponse properties: SendUsersMessageResponse: $ref: '#/components/schemas/SendUsersMessageResponse' RecencyType: type: string enum: - ACTIVE - INACTIVE GPSCoordinates: type: object required: - Latitude - Longitude properties: Latitude: allOf: - $ref: '#/components/schemas/__double' - description: The latitude coordinate of the location. Longitude: allOf: - $ref: '#/components/schemas/__double' - description: The longitude coordinate of the location. description: Specifies the GPS coordinates of a location. EndpointSendConfiguration: type: object properties: BodyOverride: allOf: - $ref: '#/components/schemas/__string' - description: The body of the message. If specified, this value overrides the default message body. Context: allOf: - $ref: '#/components/schemas/MapOf__string' - description:

    A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.

    For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    RawContent: allOf: - $ref: '#/components/schemas/__string' - description: The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables. TitleOverride: allOf: - $ref: '#/components/schemas/__string' - description: The title or subject line of the message. If specified, this value overrides the default message title or subject line. description: Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint. DeleteApnsSandboxChannelResponse: type: object required: - APNSSandboxChannelResponse properties: APNSSandboxChannelResponse: $ref: '#/components/schemas/APNSSandboxChannelResponse' WaitTime: type: object properties: WaitFor: allOf: - $ref: '#/components/schemas/__string' - description: The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey. WaitUntil: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey. description: Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey. SMSMessageActivity: type: object properties: MessageConfig: allOf: - $ref: '#/components/schemas/JourneySMSMessage' - description: Specifies the sender ID and message type for an SMS message that's sent to participants in a journey. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after the message is sent. TemplateName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template. TemplateVersion: allOf: - $ref: '#/components/schemas/__string' - description:

    The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    description: Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants. NotFoundException: {} UpdateApplicationSettingsResponse: type: object required: - ApplicationSettingsResource properties: ApplicationSettingsResource: $ref: '#/components/schemas/ApplicationSettingsResource' DirectMessageConfiguration: type: object properties: ADMMessage: allOf: - $ref: '#/components/schemas/ADMMessage' - description: The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage). APNSMessage: allOf: - $ref: '#/components/schemas/APNSMessage' - description: The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage). BaiduMessage: allOf: - $ref: '#/components/schemas/BaiduMessage' - description: The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage). DefaultMessage: allOf: - $ref: '#/components/schemas/DefaultMessage' - description: The default message for all channels. DefaultPushNotificationMessage: allOf: - $ref: '#/components/schemas/DefaultPushNotificationMessage' - description: The default push notification message for all push notification channels. EmailMessage: allOf: - $ref: '#/components/schemas/EmailMessage' - description: The default message for the email channel. This message overrides the default message (DefaultMessage). GCMMessage: allOf: - $ref: '#/components/schemas/GCMMessage' - description: The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage). SMSMessage: allOf: - $ref: '#/components/schemas/SMSMessage' - description: The default message for the SMS channel. This message overrides the default message (DefaultMessage). VoiceMessage: allOf: - $ref: '#/components/schemas/VoiceMessage' - description: The default message for the voice channel. This message overrides the default message (DefaultMessage). description: Specifies the settings and content for the default message and any default messages that you tailored for specific channels. Layout: type: string enum: - BOTTOM_BANNER - TOP_BANNER - OVERLAYS - MOBILE_FEED - MIDDLE_BANNER - CAROUSEL SetDimension: type: object required: - Values properties: DimensionType: allOf: - $ref: '#/components/schemas/DimensionType' - description: 'The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.' Values: allOf: - $ref: '#/components/schemas/ListOf__string' - description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. description: Specifies the dimension type and values for a segment dimension. VoiceMessage: type: object properties: Body: allOf: - $ref: '#/components/schemas/__string' - description: The text of the script to use for the voice message. LanguageCode: allOf: - $ref: '#/components/schemas/__string' - description: The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. OriginationNumber: allOf: - $ref: '#/components/schemas/__string' - description: The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The default message variables to use in the voice message. You can override the default variables with individual address variables. VoiceId: allOf: - $ref: '#/components/schemas/__string' - description: The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide. description: Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel. Duration: type: string enum: - HR_24 - DAY_7 - DAY_14 - DAY_30 ListOfExportJobResponse: type: array items: $ref: '#/components/schemas/ExportJobResponse' ApplicationDateRangeKpiResponse: type: object required: - KpiResult - KpiName - EndTime - StartTime - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the metric applies to. EndTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. KpiName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide. KpiResult: allOf: - $ref: '#/components/schemas/BaseKpiResult' - description: An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value. NextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page. StartTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. description: Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query. MessageConfiguration: type: object properties: ADMMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message. APNSMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message. BaiduMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message. CustomMessage: allOf: - $ref: '#/components/schemas/CampaignCustomMessage' - description: '

    The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

    ' DefaultMessage: allOf: - $ref: '#/components/schemas/Message' - description: The default message that the campaign sends through all the channels that are configured for the campaign. EmailMessage: allOf: - $ref: '#/components/schemas/CampaignEmailMessage' - description: The message that the campaign sends through the email channel. If specified, this message overrides the default message. GCMMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message. SMSMessage: allOf: - $ref: '#/components/schemas/CampaignSmsMessage' - description: The message that the campaign sends through the SMS channel. If specified, this message overrides the default message. InAppMessage: allOf: - $ref: '#/components/schemas/CampaignInAppMessage' - description: The in-app message configuration. description: Specifies the message configuration settings for a campaign. EventDimensions: type: object properties: Attributes: allOf: - $ref: '#/components/schemas/MapOfAttributeDimension' - description: One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. EventType: allOf: - $ref: '#/components/schemas/SetDimension' - description: The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide. Metrics: allOf: - $ref: '#/components/schemas/MapOfMetricDimension' - description: One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. description: Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed. TooManyRequestsException: {} ListOfOpenHoursRules: type: array items: allOf: - $ref: '#/components/schemas/OpenHoursRule' - description: Open Hour Rule Details. CreateExportJobResponse: type: object required: - ExportJobResponse properties: ExportJobResponse: $ref: '#/components/schemas/ExportJobResponse' UpdateSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: '#/components/schemas/SegmentResponse' ResultRow: type: object required: - GroupedBys - Values properties: GroupedBys: allOf: - $ref: '#/components/schemas/ListOfResultRowValue' - description: An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped. Values: allOf: - $ref: '#/components/schemas/ListOfResultRowValue' - description: An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey. description: Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey. JourneyDateRangeKpiResponse: type: object required: - KpiResult - KpiName - JourneyId - EndTime - StartTime - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the metric applies to. EndTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. JourneyId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the journey that the metric applies to. KpiName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide. KpiResult: allOf: - $ref: '#/components/schemas/BaseKpiResult' - description: An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value. NextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page. StartTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. description: Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query. RemoveAttributesResponse: type: object required: - AttributesResource properties: AttributesResource: $ref: '#/components/schemas/AttributesResource' SegmentReference: type: object required: - Id properties: Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The version number of the segment. description: Specifies the segment identifier and version of a segment. UpdateGcmChannelResponse: type: object required: - GCMChannelResponse properties: GCMChannelResponse: $ref: '#/components/schemas/GCMChannelResponse' DefaultButtonConfiguration: type: object required: - ButtonAction - Text properties: BackgroundColor: allOf: - $ref: '#/components/schemas/__string' - description: The background color of the button. BorderRadius: allOf: - $ref: '#/components/schemas/__integer' - description: The border radius of the button. ButtonAction: allOf: - $ref: '#/components/schemas/ButtonAction' - description: Action triggered by the button. Link: allOf: - $ref: '#/components/schemas/__string' - description: Button destination. Text: allOf: - $ref: '#/components/schemas/__string' - description: Button text. TextColor: allOf: - $ref: '#/components/schemas/__string' - description: The text color of the button. description: Default button configuration. ForbiddenException: {} SegmentBehaviors: type: object properties: Recency: allOf: - $ref: '#/components/schemas/RecencyDimension' - description: The dimension settings that are based on how recently an endpoint was active. description: Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active. ApplicationSettingsResource: type: object required: - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. CampaignHook: allOf: - $ref: '#/components/schemas/CampaignHook' - description: The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the application's settings were last modified. Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The default sending limits for campaigns in the application. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description:

    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    description: Provides information about an application, including the default settings for an application. AttributeDimension: type: object required: - Values properties: AttributeType: allOf: - $ref: '#/components/schemas/AttributeType' - description: 'The type of segment dimension to use. Valid values are: