openapi: 3.0.0 info: version: 2016-12-01 x-release: v4 title: Amazon Pinpoint 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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/pinpoint/ 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) x-hasEquivalentPaths: true paths: /v1/apps: 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 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: 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 "/v1/apps/{application-id}/campaigns": 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 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: 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 "/v1/templates/{template-name}/email": post: operationId: CreateEmailTemplate description: Creates a message template for messages that are sent through the email channel. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateEmailTemplateResponse" "480": description: MethodNotAllowedException content: application/json: schema: $ref: "#/components/schemas/MethodNotAllowedException" "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" parameters: - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EmailTemplateRequest properties: EmailTemplateRequest: description: Specifies the content and settings for a message template that can be used in messages that are sent through the email channel. type: object properties: DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. HtmlPart: allOf: - $ref: "#/components/schemas/__string" - description: The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. RecommenderId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data. Subject: allOf: - $ref: "#/components/schemas/__string" - description: The subject line, or title, to use in email messages that are based on the message template. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. TextPart: allOf: - $ref: "#/components/schemas/__string" - description: The message body, in plain text format, to use in email messages that are based on the message template. 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Email Template 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: DeleteEmailTemplate description: Deletes a message template for messages that were sent through the email channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteEmailTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Email Template get: operationId: GetEmailTemplate description: Retrieves the content and settings of a message template for messages that are sent through the email channel. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetEmailTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Email Template put: operationId: UpdateEmailTemplate description: Updates an existing message template for messages that are sent through the email channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateEmailTemplateResponse" "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: create-new-version in: query required: false description: "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" schema: type: boolean - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EmailTemplateRequest properties: EmailTemplateRequest: description: Specifies the content and settings for a message template that can be used in messages that are sent through the email channel. type: object properties: DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. HtmlPart: allOf: - $ref: "#/components/schemas/__string" - description: The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. RecommenderId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data. Subject: allOf: - $ref: "#/components/schemas/__string" - description: The subject line, or title, to use in email messages that are based on the message template. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. TextPart: allOf: - $ref: "#/components/schemas/__string" - description: The message body, in plain text format, to use in email messages that are based on the message template. 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Email Template "/v1/apps/{application-id}/jobs/export": 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 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: 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 "/v1/apps/{application-id}/jobs/import": 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 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: 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 "/v1/templates/{template-name}/inapp": post: operationId: CreateInAppTemplate description: Creates a new message template for messages using the in-app message channel. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateInAppTemplateResponse" "480": description: MethodNotAllowedException content: application/json: schema: $ref: "#/components/schemas/MethodNotAllowedException" "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" parameters: - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - InAppTemplateRequest properties: InAppTemplateRequest: description: InApp Template Request. type: object properties: Content: allOf: - $ref: "#/components/schemas/ListOfInAppMessageContent" - description: The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional. CustomConfig: allOf: - $ref: "#/components/schemas/MapOf__string" - description: Custom config to be sent to client. Layout: allOf: - $ref: "#/components/schemas/Layout" - description: The layout of the message. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: The description of the template. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create in App Template 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: DeleteInAppTemplate description: Deletes a message template for messages sent using the in-app message channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteInAppTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete in App Template get: operationId: GetInAppTemplate description: Retrieves the content and settings of a message template for messages sent through the in-app channel. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetInAppTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get in App Template put: operationId: UpdateInAppTemplate description: Updates an existing message template for messages sent through the in-app message channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateInAppTemplateResponse" "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: create-new-version in: query required: false description: "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" schema: type: boolean - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - InAppTemplateRequest properties: InAppTemplateRequest: description: InApp Template Request. type: object properties: Content: allOf: - $ref: "#/components/schemas/ListOfInAppMessageContent" - description: The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional. CustomConfig: allOf: - $ref: "#/components/schemas/MapOf__string" - description: Custom config to be sent to client. Layout: allOf: - $ref: "#/components/schemas/Layout" - description: The layout of the message. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: The description of the template. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update in App Template "/v1/apps/{application-id}/journeys": 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 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: 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 "/v1/templates/{template-name}/push": post: operationId: CreatePushTemplate description: Creates a message template for messages that are sent through a push notification channel. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreatePushTemplateResponse" "480": description: MethodNotAllowedException content: application/json: schema: $ref: "#/components/schemas/MethodNotAllowedException" "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" parameters: - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - PushNotificationTemplateRequest properties: PushNotificationTemplateRequest: description: Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel. type: object properties: ADM: allOf: - $ref: "#/components/schemas/AndroidPushNotificationTemplate" - description: The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). APNS: allOf: - $ref: "#/components/schemas/APNSPushNotificationTemplate" - description: The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). Baidu: allOf: - $ref: "#/components/schemas/AndroidPushNotificationTemplate" - description: The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). Default: allOf: - $ref: "#/components/schemas/DefaultPushNotificationTemplate" - description: The default message template to use for push notification channels. DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. GCM: allOf: - $ref: "#/components/schemas/AndroidPushNotificationTemplate" - description: The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). RecommenderId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Push Template 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: DeletePushTemplate description: Deletes a message template for messages that were sent through a push notification channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/DeletePushTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Push Template get: operationId: GetPushTemplate description: Retrieves the content and settings of a message template for messages that are sent through a push notification channel. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetPushTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Push Template put: operationId: UpdatePushTemplate description: Updates an existing message template for messages that are sent through a push notification channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdatePushTemplateResponse" "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: create-new-version in: query required: false description: "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" schema: type: boolean - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - PushNotificationTemplateRequest properties: PushNotificationTemplateRequest: description: Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel. type: object properties: ADM: allOf: - $ref: "#/components/schemas/AndroidPushNotificationTemplate" - description: The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). APNS: allOf: - $ref: "#/components/schemas/APNSPushNotificationTemplate" - description: The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). Baidu: allOf: - $ref: "#/components/schemas/AndroidPushNotificationTemplate" - description: The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). Default: allOf: - $ref: "#/components/schemas/DefaultPushNotificationTemplate" - description: The default message template to use for push notification channels. DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. GCM: allOf: - $ref: "#/components/schemas/AndroidPushNotificationTemplate" - description: The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate). RecommenderId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Push Template /v1/recommenders: post: operationId: CreateRecommenderConfiguration description: Creates an Amazon Pinpoint configuration for a recommender model. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateRecommenderConfigurationResponse" "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: - CreateRecommenderConfiguration properties: CreateRecommenderConfiguration: description: Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model. type: object properties: Attributes: allOf: - $ref: "#/components/schemas/MapOf__string" - description:

A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

Description: allOf: - $ref: "#/components/schemas/__string" - description: "A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐." Name: allOf: - $ref: "#/components/schemas/__string" - description: A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). RecommendationProviderIdType: allOf: - $ref: "#/components/schemas/__string" - description:

The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

RecommendationProviderRoleArn: 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 retrieve recommendation data from the recommender model. RecommendationProviderUri: allOf: - $ref: "#/components/schemas/__string" - description: The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign. RecommendationTransformerUri: allOf: - $ref: "#/components/schemas/__string" - description: The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model. RecommendationsDisplayName: allOf: - $ref: "#/components/schemas/__string" - description:

A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

RecommendationsPerMessage: allOf: - $ref: "#/components/schemas/__integer" - description:

The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Recommender Configuration 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: GetRecommenderConfigurations description: Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetRecommenderConfigurationsResponse" "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 Recommender Configurations "/v1/apps/{application-id}/segments": 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 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: 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 "/v1/templates/{template-name}/sms": post: operationId: CreateSmsTemplate description: Creates a message template for messages that are sent through the SMS channel. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateSmsTemplateResponse" "480": description: MethodNotAllowedException content: application/json: schema: $ref: "#/components/schemas/MethodNotAllowedException" "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" parameters: - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - SMSTemplateRequest properties: SMSTemplateRequest: description: Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel. type: object properties: Body: allOf: - $ref: "#/components/schemas/__string" - description: The message body to use in text messages that are based on the message template. DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. RecommenderId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Sms Template 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: DeleteSmsTemplate description: Deletes a message template for messages that were sent through the SMS channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteSmsTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Sms Template get: operationId: GetSmsTemplate description: Retrieves the content and settings of a message template for messages that are sent through the SMS channel. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetSmsTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Sms Template put: operationId: UpdateSmsTemplate description: Updates an existing message template for messages that are sent through the SMS channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateSmsTemplateResponse" "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: create-new-version in: query required: false description: "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" schema: type: boolean - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - SMSTemplateRequest properties: SMSTemplateRequest: description: Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel. type: object properties: Body: allOf: - $ref: "#/components/schemas/__string" - description: The message body to use in text messages that are based on the message template. DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. RecommenderId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Sms Template "/v1/templates/{template-name}/voice": post: operationId: CreateVoiceTemplate description: Creates a message template for messages that are sent through the voice channel. responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateVoiceTemplateResponse" "480": description: MethodNotAllowedException content: application/json: schema: $ref: "#/components/schemas/MethodNotAllowedException" "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" parameters: - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - VoiceTemplateRequest properties: VoiceTemplateRequest: description: Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel. type: object properties: Body: allOf: - $ref: "#/components/schemas/__string" - description: The text of the script to use in messages that are based on the message template, in plain text format. DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. LanguageCode: allOf: - $ref: "#/components/schemas/__string" - description: The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. VoiceId: allOf: - $ref: "#/components/schemas/__string" - description: The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Voice Template 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: DeleteVoiceTemplate description: Deletes a message template for messages that were sent through the voice channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteVoiceTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Voice Template get: operationId: GetVoiceTemplate description: Retrieves the content and settings of a message template for messages that are sent through the voice channel. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetVoiceTemplateResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Voice Template put: operationId: UpdateVoiceTemplate description: Updates an existing message template for messages that are sent through the voice channel. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateVoiceTemplateResponse" "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: create-new-version in: query required: false description: "

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

" schema: type: boolean - name: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: version in: query required: false description:

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - VoiceTemplateRequest properties: VoiceTemplateRequest: description: Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel. type: object properties: Body: allOf: - $ref: "#/components/schemas/__string" - description: The text of the script to use in messages that are based on the message template, in plain text format. DefaultSubstitutions: allOf: - $ref: "#/components/schemas/__string" - description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. LanguageCode: allOf: - $ref: "#/components/schemas/__string" - description: The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. 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 message template. Each tag consists of a required tag key and an associated tag value. TemplateDescription: allOf: - $ref: "#/components/schemas/__string" - description: A custom description of the message template. VoiceId: allOf: - $ref: "#/components/schemas/__string" - description: The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Voice Template "/v1/apps/{application-id}/channels/adm": 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 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: 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 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 "/v1/apps/{application-id}/channels/apns": 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 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: 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 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 "/v1/apps/{application-id}/channels/apns_sandbox": 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 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: 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 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 "/v1/apps/{application-id}/channels/apns_voip": 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 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: 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 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 "/v1/apps/{application-id}/channels/apns_voip_sandbox": 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 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: 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 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 "/v1/apps/{application-id}": 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 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: 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 "/v1/apps/{application-id}/channels/baidu": 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 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: 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 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 "/v1/apps/{application-id}/campaigns/{campaign-id}": 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 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: 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 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 "/v1/apps/{application-id}/channels/email": 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 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: 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 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 "/v1/apps/{application-id}/endpoints/{endpoint-id}": 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 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: 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 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 "/v1/apps/{application-id}/eventstream": 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 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: 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 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

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

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 "/v1/apps/{application-id}/channels/gcm": 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 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: 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 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 "/v1/apps/{application-id}/journeys/{journey-id}": 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 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: 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 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 "/v1/recommenders/{recommender-id}": delete: operationId: DeleteRecommenderConfiguration description: Deletes an Amazon Pinpoint configuration for a recommender model. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteRecommenderConfigurationResponse" "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: recommender-id in: path required: true description: The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Recommender Configuration 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: GetRecommenderConfiguration description: Retrieves information about an Amazon Pinpoint configuration for a recommender model. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetRecommenderConfigurationResponse" "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: recommender-id in: path required: true description: The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Recommender Configuration put: operationId: UpdateRecommenderConfiguration description: Updates an Amazon Pinpoint configuration for a recommender model. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateRecommenderConfigurationResponse" "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: recommender-id in: path required: true description: The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - UpdateRecommenderConfiguration properties: UpdateRecommenderConfiguration: description: Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model. type: object properties: Attributes: allOf: - $ref: "#/components/schemas/MapOf__string" - description:

A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

Description: allOf: - $ref: "#/components/schemas/__string" - description: "A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐." Name: allOf: - $ref: "#/components/schemas/__string" - description: A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). RecommendationProviderIdType: allOf: - $ref: "#/components/schemas/__string" - description:

The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

RecommendationProviderRoleArn: 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 retrieve recommendation data from the recommender model. RecommendationProviderUri: allOf: - $ref: "#/components/schemas/__string" - description: The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign. RecommendationTransformerUri: allOf: - $ref: "#/components/schemas/__string" - description: The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model. RecommendationsDisplayName: allOf: - $ref: "#/components/schemas/__string" - description:

A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

RecommendationsPerMessage: allOf: - $ref: "#/components/schemas/__integer" - description:

The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Recommender Configuration "/v1/apps/{application-id}/segments/{segment-id}": 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 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: 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 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 "/v1/apps/{application-id}/channels/sms": 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 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: 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 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 "/v1/apps/{application-id}/users/{user-id}": 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 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: 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 "/v1/apps/{application-id}/channels/voice": 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 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: 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 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 "/v1/apps/{application-id}/kpis/daterange/{kpi-name}": 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 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" "/v1/apps/{application-id}/settings": 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 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: 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 "/v1/apps/{application-id}/campaigns/{campaign-id}/activities": 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 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" "/v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}": 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 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" "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}": 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 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" "/v1/apps/{application-id}/campaigns/{campaign-id}/versions": 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 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" "/v1/apps/{application-id}/channels": 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 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" "/v1/apps/{application-id}/jobs/export/{job-id}": 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 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" "/v1/apps/{application-id}/jobs/import/{job-id}": 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 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" "/v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages": 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 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" "/v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}": 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 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" "/v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics": 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 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" "/v1/apps/{application-id}/journeys/{journey-id}/execution-metrics": 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 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" "/v1/apps/{application-id}/segments/{segment-id}/jobs/export": 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 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" "/v1/apps/{application-id}/segments/{segment-id}/jobs/import": 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 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" "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}": 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 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" "/v1/apps/{application-id}/segments/{segment-id}/versions": 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 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" "/v1/tags/{resource-arn}": get: operationId: ListTagsForResource description: Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" parameters: - name: resource-arn in: path required: true description: The Amazon Resource Name (ARN) of the resource. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint List Tags for Resource 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: TagResource description: Adds one or more tags (keys and values) to an application, campaign, message template, or segment. responses: "204": description: Success parameters: - name: resource-arn in: path required: true description: The Amazon Resource Name (ARN) of the resource. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - TagsModel properties: TagsModel: description: Specifies the tags (keys and values) for an application, campaign, message template, or segment. type: object properties: tags: allOf: - $ref: "#/components/schemas/MapOf__string" - description:

A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.

Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Tag Resource "/v1/templates/{template-name}/{template-type}/versions": get: operationId: ListTemplateVersions description: Retrieves information about all the versions of a specific message template. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTemplateVersionsResponse" "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: 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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: template-type in: path required: true description: "The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE." schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint List Template 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" /v1/templates: get: operationId: ListTemplates description: Retrieves information about all the message templates that are associated with your Amazon Pinpoint account. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTemplatesResponse" "480": description: MethodNotAllowedException content: application/json: schema: $ref: "#/components/schemas/MethodNotAllowedException" "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "482": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" parameters: - 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: prefix in: query required: false description: The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify. schema: type: string - name: template-type in: query required: false description: "The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request." schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint List Templates 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" /v1/phone/number/validate: post: operationId: PhoneNumberValidate description: Retrieves information about a phone number. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PhoneNumberValidateResponse" "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: - NumberValidateRequest properties: NumberValidateRequest: description: Specifies a phone number to validate and retrieve information about. type: object properties: IsoCountryCode: allOf: - $ref: "#/components/schemas/__string" - description: The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered. PhoneNumber: allOf: - $ref: "#/components/schemas/__string" - description: The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Phone Number Validate 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" "/v1/apps/{application-id}/events": 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 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" "/v1/apps/{application-id}/attributes/{attribute-type}": 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 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" "/v1/apps/{application-id}/messages": 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 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" "/v1/apps/{application-id}/otp": 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 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" "/v1/apps/{application-id}/users-messages": 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 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" "/v1/tags/{resource-arn}#tagKeys": delete: operationId: UntagResource description: Removes one or more tags (keys and values) from an application, campaign, message template, or segment. responses: "204": description: Success parameters: - name: resource-arn in: path required: true description: The Amazon Resource Name (ARN) of the resource. schema: type: string - name: tagKeys in: query required: true description: The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&). schema: type: array items: $ref: "#/components/schemas/__string" x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Untag Resource 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" "/v1/apps/{application-id}/endpoints": 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 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" "/v1/apps/{application-id}/journeys/{journey-id}/state": 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 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" "/v1/templates/{template-name}/{template-type}/active-version": put: operationId: UpdateTemplateActiveVersion description: Changes the status of a specific version of a message template to active. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateTemplateActiveVersionResponse" "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: template-name in: path required: true description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. schema: type: string - name: template-type in: path required: true description: "The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE." schema: type: string requestBody: required: true content: application/json: schema: type: object required: - TemplateActiveVersionRequest properties: TemplateActiveVersionRequest: description: Specifies which version of a message template to use as the active version of the template. type: object properties: Version: allOf: - $ref: "#/components/schemas/__string" - description: 'The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the 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.' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Template Active 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" "/v1/apps/{application-id}/verify-otp": 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 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" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: CreateAppResponse: type: object required: - ApplicationResponse properties: ApplicationResponse: $ref: "#/components/schemas/ApplicationResponse" __string: type: string MapOf__string: type: object additionalProperties: $ref: "#/components/schemas/__string" BadRequestException: {} InternalServerErrorException: {} PayloadTooLargeException: {} ForbiddenException: {} NotFoundException: {} MethodNotAllowedException: {} TooManyRequestsException: {} CreateCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: "#/components/schemas/CampaignResponse" ListOfWriteTreatmentResource: type: array items: $ref: "#/components/schemas/WriteTreatmentResource" CustomDeliveryConfiguration: type: object required: - DeliveryUri 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 campaign or treatment 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. description: Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment. __integer: type: integer 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. __boolean: type: boolean 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. 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. 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, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11. description: Specifies the schedule settings for a campaign. 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. CreateEmailTemplateResponse: type: object required: - CreateTemplateMessageBody properties: CreateTemplateMessageBody: $ref: "#/components/schemas/CreateTemplateMessageBody" CreateExportJobResponse: type: object required: - ExportJobResponse properties: ExportJobResponse: $ref: "#/components/schemas/ExportJobResponse" CreateImportJobResponse: type: object required: - ImportJobResponse properties: ImportJobResponse: $ref: "#/components/schemas/ImportJobResponse" Format: type: string enum: - CSV - JSON CreateInAppTemplateResponse: type: object required: - TemplateCreateMessageBody properties: TemplateCreateMessageBody: $ref: "#/components/schemas/TemplateCreateMessageBody" ListOfInAppMessageContent: type: array items: $ref: "#/components/schemas/InAppMessageContent" Layout: type: string enum: - BOTTOM_BANNER - TOP_BANNER - OVERLAYS - MOBILE_FEED - MIDDLE_BANNER - CAROUSEL CreateJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: "#/components/schemas/JourneyResponse" MapOfActivity: type: object additionalProperties: $ref: "#/components/schemas/Activity" JourneyLimits: type: object properties: DailyCap: allOf: - $ref: "#/components/schemas/__integer" - description: The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100. EndpointReentryCap: allOf: - $ref: "#/components/schemas/__integer" - description: The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0. MessagesPerSecond: allOf: - $ref: "#/components/schemas/__integer" - description: The maximum number of messages that the journey can send each second. EndpointReentryInterval: allOf: - $ref: "#/components/schemas/__string" - description: "Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H. " description: Specifies limits on the messages that a journey can send and the number of times participants can enter a journey. QuietTime: type: object properties: End: allOf: - $ref: "#/components/schemas/__string" - description: The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. Start: allOf: - $ref: "#/components/schemas/__string" - description: The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM. description: Specifies the start and end times that define a time range when messages aren't sent to endpoints. JourneySchedule: type: object properties: EndTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - description: The scheduled time, in ISO 8601 format, when the journey ended or will end. StartTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - description: The scheduled time, in ISO 8601 format, when the journey began or will begin. Timezone: allOf: - $ref: "#/components/schemas/__string" - description: |- The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11. description: Specifies the schedule settings for a journey. 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. State: type: string enum: - DRAFT - ACTIVE - COMPLETED - CANCELLED - CLOSED - PAUSED JourneyChannelSettings: type: object properties: ConnectCampaignArn: allOf: - $ref: "#/components/schemas/__string" - description: Amazon Resource Name (ARN) of the Connect Campaign. ConnectCampaignExecutionRoleArn: allOf: - $ref: "#/components/schemas/__string" - description: IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing. description: The channel-specific configurations for the journey. OpenHours: type: object properties: EMAIL: allOf: - $ref: "#/components/schemas/MapOfListOfOpenHoursRules" - description: Rules for Email Channel. SMS: allOf: - $ref: "#/components/schemas/MapOfListOfOpenHoursRules" - description: Rules for SMS Channel. PUSH: allOf: - $ref: "#/components/schemas/MapOfListOfOpenHoursRules" - description: Rules for Push Channel. VOICE: allOf: - $ref: "#/components/schemas/MapOfListOfOpenHoursRules" - description: Rules for Voice Channel. CUSTOM: allOf: - $ref: "#/components/schemas/MapOfListOfOpenHoursRules" - description: Rules for Custom Channel. description: The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true. ClosedDays: type: object properties: EMAIL: allOf: - $ref: "#/components/schemas/ListOfClosedDaysRules" - description: Rules for Email Channel. SMS: allOf: - $ref: "#/components/schemas/ListOfClosedDaysRules" - description: Rules for SMS Channel. PUSH: allOf: - $ref: "#/components/schemas/ListOfClosedDaysRules" - description: Rules for Push Channel. VOICE: allOf: - $ref: "#/components/schemas/ListOfClosedDaysRules" - description: Rules for Voice Channel. CUSTOM: allOf: - $ref: "#/components/schemas/ListOfClosedDaysRules" - description: Rules for Custom Channel. description: The time when journey will stop sending messages. CreatePushTemplateResponse: type: object required: - CreateTemplateMessageBody properties: CreateTemplateMessageBody: $ref: "#/components/schemas/CreateTemplateMessageBody" AndroidPushNotificationTemplate: type: object properties: Action: allOf: - $ref: "#/components/schemas/Action" - description:

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

Body: allOf: - $ref: "#/components/schemas/__string" - description: The message body to use in a push notification that's based on the message template. ImageIconUrl: allOf: - $ref: "#/components/schemas/__string" - description: The URL of the large icon image to display in the content view of a push notification that's based on the message template. ImageUrl: allOf: - $ref: "#/components/schemas/__string" - description: The URL of an image to display in a push notification that's based on the message template. RawContent: allOf: - $ref: "#/components/schemas/__string" - description: The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template. 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 a push notification that's based on the message template. Sound: allOf: - $ref: "#/components/schemas/__string" - description: The sound to play when a recipient receives a push notification that's based on the message template. 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/. Title: allOf: - $ref: "#/components/schemas/__string" - description: The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. Url: allOf: - $ref: "#/components/schemas/__string" - description: The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. description: Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel. APNSPushNotificationTemplate: type: object properties: Action: allOf: - $ref: "#/components/schemas/Action" - description:

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

Body: allOf: - $ref: "#/components/schemas/__string" - description: The message body to use in push notifications that are based on the message template. MediaUrl: allOf: - $ref: "#/components/schemas/__string" - description: The URL of an image or video to display in push notifications that are based on the message template. RawContent: allOf: - $ref: "#/components/schemas/__string" - description: The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template. Sound: allOf: - $ref: "#/components/schemas/__string" - description: The key for the sound to play when the recipient receives a push notification that's based on the message template. 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. Title: allOf: - $ref: "#/components/schemas/__string" - description: The title to use in push notifications that are based on the message template. This title appears above the notification message on a 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 a push notification that's based on the message template and the value of the Action property is URL. description: Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel. DefaultPushNotificationTemplate: type: object properties: Action: allOf: - $ref: "#/components/schemas/Action" - description:

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

Body: allOf: - $ref: "#/components/schemas/__string" - description: The message body to use in push notifications that are based on the message template. Sound: allOf: - $ref: "#/components/schemas/__string" - description:

The sound to play when a recipient receives a push notification that's based on the message template. 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/.

For an iOS platform, this value is the key for 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.

Title: allOf: - $ref: "#/components/schemas/__string" - description: The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. Url: allOf: - $ref: "#/components/schemas/__string" - description: The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. description: Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel. CreateRecommenderConfigurationResponse: type: object required: - RecommenderConfigurationResponse properties: RecommenderConfigurationResponse: $ref: "#/components/schemas/RecommenderConfigurationResponse" CreateSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: "#/components/schemas/SegmentResponse" SegmentDimensions: type: object properties: Attributes: allOf: - $ref: "#/components/schemas/MapOfAttributeDimension" - description: One or more custom attributes to use as criteria for the segment. Behavior: allOf: - $ref: "#/components/schemas/SegmentBehaviors" - description: The behavior-based criteria, such as how recently users have used your app, for the segment. Demographic: allOf: - $ref: "#/components/schemas/SegmentDemographics" - description: The demographic-based criteria, such as device platform, for the segment. Location: allOf: - $ref: "#/components/schemas/SegmentLocation" - description: The location-based criteria, such as region or GPS coordinates, for the segment. Metrics: allOf: - $ref: "#/components/schemas/MapOfMetricDimension" - description: One or more custom metrics to use as criteria for the segment. UserAttributes: allOf: - $ref: "#/components/schemas/MapOfAttributeDimension" - description: One or more custom user attributes to use as criteria for the segment. description: Specifies the dimension settings for a segment. SegmentGroupList: type: object properties: Groups: allOf: - $ref: "#/components/schemas/ListOfSegmentGroup" - description: An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. Include: allOf: - $ref: "#/components/schemas/Include" - description: Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups. description: Specifies the settings that define the relationships between segment groups for a segment. CreateSmsTemplateResponse: type: object required: - CreateTemplateMessageBody properties: CreateTemplateMessageBody: $ref: "#/components/schemas/CreateTemplateMessageBody" CreateVoiceTemplateResponse: type: object required: - CreateTemplateMessageBody properties: CreateTemplateMessageBody: $ref: "#/components/schemas/CreateTemplateMessageBody" DeleteAdmChannelResponse: type: object required: - ADMChannelResponse properties: ADMChannelResponse: $ref: "#/components/schemas/ADMChannelResponse" DeleteApnsChannelResponse: type: object required: - APNSChannelResponse properties: APNSChannelResponse: $ref: "#/components/schemas/APNSChannelResponse" DeleteApnsSandboxChannelResponse: type: object required: - APNSSandboxChannelResponse properties: APNSSandboxChannelResponse: $ref: "#/components/schemas/APNSSandboxChannelResponse" DeleteApnsVoipChannelResponse: type: object required: - APNSVoipChannelResponse properties: APNSVoipChannelResponse: $ref: "#/components/schemas/APNSVoipChannelResponse" DeleteApnsVoipSandboxChannelResponse: type: object required: - APNSVoipSandboxChannelResponse properties: APNSVoipSandboxChannelResponse: $ref: "#/components/schemas/APNSVoipSandboxChannelResponse" DeleteAppResponse: type: object required: - ApplicationResponse properties: ApplicationResponse: $ref: "#/components/schemas/ApplicationResponse" DeleteBaiduChannelResponse: type: object required: - BaiduChannelResponse properties: BaiduChannelResponse: $ref: "#/components/schemas/BaiduChannelResponse" DeleteCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: "#/components/schemas/CampaignResponse" DeleteEmailChannelResponse: type: object required: - EmailChannelResponse properties: EmailChannelResponse: $ref: "#/components/schemas/EmailChannelResponse" DeleteEmailTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" DeleteEndpointResponse: type: object required: - EndpointResponse properties: EndpointResponse: $ref: "#/components/schemas/EndpointResponse" DeleteEventStreamResponse: type: object required: - EventStream properties: EventStream: $ref: "#/components/schemas/EventStream" DeleteGcmChannelResponse: type: object required: - GCMChannelResponse properties: GCMChannelResponse: $ref: "#/components/schemas/GCMChannelResponse" DeleteInAppTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" DeleteJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: "#/components/schemas/JourneyResponse" DeletePushTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" DeleteRecommenderConfigurationResponse: type: object required: - RecommenderConfigurationResponse properties: RecommenderConfigurationResponse: $ref: "#/components/schemas/RecommenderConfigurationResponse" DeleteSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: "#/components/schemas/SegmentResponse" DeleteSmsChannelResponse: type: object required: - SMSChannelResponse properties: SMSChannelResponse: $ref: "#/components/schemas/SMSChannelResponse" DeleteSmsTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" DeleteUserEndpointsResponse: type: object required: - EndpointsResponse properties: EndpointsResponse: $ref: "#/components/schemas/EndpointsResponse" DeleteVoiceChannelResponse: type: object required: - VoiceChannelResponse properties: VoiceChannelResponse: $ref: "#/components/schemas/VoiceChannelResponse" DeleteVoiceTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" GetAdmChannelResponse: type: object required: - ADMChannelResponse properties: ADMChannelResponse: $ref: "#/components/schemas/ADMChannelResponse" GetApnsChannelResponse: type: object required: - APNSChannelResponse properties: APNSChannelResponse: $ref: "#/components/schemas/APNSChannelResponse" GetApnsSandboxChannelResponse: type: object required: - APNSSandboxChannelResponse properties: APNSSandboxChannelResponse: $ref: "#/components/schemas/APNSSandboxChannelResponse" GetApnsVoipChannelResponse: type: object required: - APNSVoipChannelResponse properties: APNSVoipChannelResponse: $ref: "#/components/schemas/APNSVoipChannelResponse" GetApnsVoipSandboxChannelResponse: type: object required: - APNSVoipSandboxChannelResponse properties: APNSVoipSandboxChannelResponse: $ref: "#/components/schemas/APNSVoipSandboxChannelResponse" GetAppResponse: type: object required: - ApplicationResponse properties: ApplicationResponse: $ref: "#/components/schemas/ApplicationResponse" GetApplicationDateRangeKpiResponse: type: object required: - ApplicationDateRangeKpiResponse properties: ApplicationDateRangeKpiResponse: $ref: "#/components/schemas/ApplicationDateRangeKpiResponse" GetApplicationSettingsResponse: type: object required: - ApplicationSettingsResource properties: ApplicationSettingsResource: $ref: "#/components/schemas/ApplicationSettingsResource" GetAppsResponse: type: object required: - ApplicationsResponse properties: ApplicationsResponse: $ref: "#/components/schemas/ApplicationsResponse" GetBaiduChannelResponse: type: object required: - BaiduChannelResponse properties: BaiduChannelResponse: $ref: "#/components/schemas/BaiduChannelResponse" GetCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: "#/components/schemas/CampaignResponse" GetCampaignActivitiesResponse: type: object required: - ActivitiesResponse properties: ActivitiesResponse: $ref: "#/components/schemas/ActivitiesResponse" GetCampaignDateRangeKpiResponse: type: object required: - CampaignDateRangeKpiResponse properties: CampaignDateRangeKpiResponse: $ref: "#/components/schemas/CampaignDateRangeKpiResponse" GetCampaignVersionResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: "#/components/schemas/CampaignResponse" GetCampaignVersionsResponse: type: object required: - CampaignsResponse properties: CampaignsResponse: $ref: "#/components/schemas/CampaignsResponse" GetCampaignsResponse: type: object required: - CampaignsResponse properties: CampaignsResponse: $ref: "#/components/schemas/CampaignsResponse" GetChannelsResponse: type: object required: - ChannelsResponse properties: ChannelsResponse: $ref: "#/components/schemas/ChannelsResponse" GetEmailChannelResponse: type: object required: - EmailChannelResponse properties: EmailChannelResponse: $ref: "#/components/schemas/EmailChannelResponse" GetEmailTemplateResponse: type: object required: - EmailTemplateResponse properties: EmailTemplateResponse: $ref: "#/components/schemas/EmailTemplateResponse" GetEndpointResponse: type: object required: - EndpointResponse properties: EndpointResponse: $ref: "#/components/schemas/EndpointResponse" GetEventStreamResponse: type: object required: - EventStream properties: EventStream: $ref: "#/components/schemas/EventStream" GetExportJobResponse: type: object required: - ExportJobResponse properties: ExportJobResponse: $ref: "#/components/schemas/ExportJobResponse" GetExportJobsResponse: type: object required: - ExportJobsResponse properties: ExportJobsResponse: $ref: "#/components/schemas/ExportJobsResponse" GetGcmChannelResponse: type: object required: - GCMChannelResponse properties: GCMChannelResponse: $ref: "#/components/schemas/GCMChannelResponse" GetImportJobResponse: type: object required: - ImportJobResponse properties: ImportJobResponse: $ref: "#/components/schemas/ImportJobResponse" GetImportJobsResponse: type: object required: - ImportJobsResponse properties: ImportJobsResponse: $ref: "#/components/schemas/ImportJobsResponse" GetInAppMessagesResponse: type: object required: - InAppMessagesResponse properties: InAppMessagesResponse: $ref: "#/components/schemas/InAppMessagesResponse" GetInAppTemplateResponse: type: object required: - InAppTemplateResponse properties: InAppTemplateResponse: $ref: "#/components/schemas/InAppTemplateResponse" GetJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: "#/components/schemas/JourneyResponse" GetJourneyDateRangeKpiResponse: type: object required: - JourneyDateRangeKpiResponse properties: JourneyDateRangeKpiResponse: $ref: "#/components/schemas/JourneyDateRangeKpiResponse" GetJourneyExecutionActivityMetricsResponse: type: object required: - JourneyExecutionActivityMetricsResponse properties: JourneyExecutionActivityMetricsResponse: $ref: "#/components/schemas/JourneyExecutionActivityMetricsResponse" GetJourneyExecutionMetricsResponse: type: object required: - JourneyExecutionMetricsResponse properties: JourneyExecutionMetricsResponse: $ref: "#/components/schemas/JourneyExecutionMetricsResponse" GetPushTemplateResponse: type: object required: - PushNotificationTemplateResponse properties: PushNotificationTemplateResponse: $ref: "#/components/schemas/PushNotificationTemplateResponse" GetRecommenderConfigurationResponse: type: object required: - RecommenderConfigurationResponse properties: RecommenderConfigurationResponse: $ref: "#/components/schemas/RecommenderConfigurationResponse" GetRecommenderConfigurationsResponse: type: object required: - ListRecommenderConfigurationsResponse properties: ListRecommenderConfigurationsResponse: $ref: "#/components/schemas/ListRecommenderConfigurationsResponse" GetSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: "#/components/schemas/SegmentResponse" GetSegmentExportJobsResponse: type: object required: - ExportJobsResponse properties: ExportJobsResponse: $ref: "#/components/schemas/ExportJobsResponse" GetSegmentImportJobsResponse: type: object required: - ImportJobsResponse properties: ImportJobsResponse: $ref: "#/components/schemas/ImportJobsResponse" GetSegmentVersionResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: "#/components/schemas/SegmentResponse" GetSegmentVersionsResponse: type: object required: - SegmentsResponse properties: SegmentsResponse: $ref: "#/components/schemas/SegmentsResponse" GetSegmentsResponse: type: object required: - SegmentsResponse properties: SegmentsResponse: $ref: "#/components/schemas/SegmentsResponse" GetSmsChannelResponse: type: object required: - SMSChannelResponse properties: SMSChannelResponse: $ref: "#/components/schemas/SMSChannelResponse" GetSmsTemplateResponse: type: object required: - SMSTemplateResponse properties: SMSTemplateResponse: $ref: "#/components/schemas/SMSTemplateResponse" GetUserEndpointsResponse: type: object required: - EndpointsResponse properties: EndpointsResponse: $ref: "#/components/schemas/EndpointsResponse" GetVoiceChannelResponse: type: object required: - VoiceChannelResponse properties: VoiceChannelResponse: $ref: "#/components/schemas/VoiceChannelResponse" GetVoiceTemplateResponse: type: object required: - VoiceTemplateResponse properties: VoiceTemplateResponse: $ref: "#/components/schemas/VoiceTemplateResponse" ListJourneysResponse: type: object required: - JourneysResponse properties: JourneysResponse: $ref: "#/components/schemas/JourneysResponse" ListTagsForResourceResponse: type: object required: - TagsModel properties: TagsModel: $ref: "#/components/schemas/TagsModel" ListTemplateVersionsResponse: type: object required: - TemplateVersionsResponse properties: TemplateVersionsResponse: $ref: "#/components/schemas/TemplateVersionsResponse" ListTemplatesResponse: type: object required: - TemplatesResponse properties: TemplatesResponse: $ref: "#/components/schemas/TemplatesResponse" PhoneNumberValidateResponse: type: object required: - NumberValidateResponse properties: NumberValidateResponse: $ref: "#/components/schemas/NumberValidateResponse" PutEventStreamResponse: type: object required: - EventStream properties: EventStream: $ref: "#/components/schemas/EventStream" PutEventsResponse: type: object required: - EventsResponse properties: EventsResponse: $ref: "#/components/schemas/EventsResponse" MapOfEventsBatch: type: object additionalProperties: $ref: "#/components/schemas/EventsBatch" RemoveAttributesResponse: type: object required: - AttributesResource properties: AttributesResource: $ref: "#/components/schemas/AttributesResource" ListOf__string: type: array items: $ref: "#/components/schemas/__string" SendMessagesResponse: type: object required: - MessageResponse properties: MessageResponse: $ref: "#/components/schemas/MessageResponse" MapOfAddressConfiguration: type: object additionalProperties: $ref: "#/components/schemas/AddressConfiguration" MapOfEndpointSendConfiguration: type: object additionalProperties: $ref: "#/components/schemas/EndpointSendConfiguration" 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. SendOTPMessageResponse: type: object required: - MessageResponse properties: MessageResponse: $ref: "#/components/schemas/MessageResponse" SendUsersMessagesResponse: type: object required: - SendUsersMessageResponse properties: SendUsersMessageResponse: $ref: "#/components/schemas/SendUsersMessageResponse" UpdateAdmChannelResponse: type: object required: - ADMChannelResponse properties: ADMChannelResponse: $ref: "#/components/schemas/ADMChannelResponse" UpdateApnsChannelResponse: type: object required: - APNSChannelResponse properties: APNSChannelResponse: $ref: "#/components/schemas/APNSChannelResponse" UpdateApnsSandboxChannelResponse: type: object required: - APNSSandboxChannelResponse properties: APNSSandboxChannelResponse: $ref: "#/components/schemas/APNSSandboxChannelResponse" UpdateApnsVoipChannelResponse: type: object required: - APNSVoipChannelResponse properties: APNSVoipChannelResponse: $ref: "#/components/schemas/APNSVoipChannelResponse" UpdateApnsVoipSandboxChannelResponse: type: object required: - APNSVoipSandboxChannelResponse properties: APNSVoipSandboxChannelResponse: $ref: "#/components/schemas/APNSVoipSandboxChannelResponse" UpdateApplicationSettingsResponse: type: object required: - ApplicationSettingsResource properties: ApplicationSettingsResource: $ref: "#/components/schemas/ApplicationSettingsResource" UpdateBaiduChannelResponse: type: object required: - BaiduChannelResponse properties: BaiduChannelResponse: $ref: "#/components/schemas/BaiduChannelResponse" UpdateCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: "#/components/schemas/CampaignResponse" UpdateEmailChannelResponse: type: object required: - EmailChannelResponse properties: EmailChannelResponse: $ref: "#/components/schemas/EmailChannelResponse" UpdateEmailTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" UpdateEndpointResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" MapOfListOf__string: type: object additionalProperties: $ref: "#/components/schemas/ListOf__string" ChannelType: type: string enum: - PUSH - GCM - APNS - APNS_SANDBOX - APNS_VOIP - APNS_VOIP_SANDBOX - ADM - SMS - VOICE - EMAIL - BAIDU - CUSTOM - IN_APP 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. EndpointLocation: type: object properties: City: allOf: - $ref: "#/components/schemas/__string" - description: The name of the city where the endpoint is located. Country: allOf: - $ref: "#/components/schemas/__string" - description: The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States. Latitude: allOf: - $ref: "#/components/schemas/__double" - description: The latitude coordinate of the endpoint location, rounded to one decimal place. Longitude: allOf: - $ref: "#/components/schemas/__double" - description: The longitude coordinate of the endpoint location, rounded to one decimal place. PostalCode: allOf: - $ref: "#/components/schemas/__string" - description: The postal or ZIP code for the area where the endpoint is located. Region: allOf: - $ref: "#/components/schemas/__string" - description: The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state. description: Specifies geographic information about an endpoint. MapOf__double: type: object additionalProperties: $ref: "#/components/schemas/__double" EndpointUser: type: object properties: UserAttributes: allOf: - $ref: "#/components/schemas/MapOfListOf__string" - description: "

One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an 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.

" UserId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the user. description: Specifies data for one or more attributes that describe the user who's associated with an endpoint. UpdateEndpointsBatchResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" ListOfEndpointBatchItem: type: array items: $ref: "#/components/schemas/EndpointBatchItem" UpdateGcmChannelResponse: type: object required: - GCMChannelResponse properties: GCMChannelResponse: $ref: "#/components/schemas/GCMChannelResponse" UpdateInAppTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" UpdateJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: "#/components/schemas/JourneyResponse" ConflictException: {} UpdateJourneyStateResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: "#/components/schemas/JourneyResponse" UpdatePushTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" UpdateRecommenderConfigurationResponse: type: object required: - RecommenderConfigurationResponse properties: RecommenderConfigurationResponse: $ref: "#/components/schemas/RecommenderConfigurationResponse" UpdateSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: "#/components/schemas/SegmentResponse" UpdateSmsChannelResponse: type: object required: - SMSChannelResponse properties: SMSChannelResponse: $ref: "#/components/schemas/SMSChannelResponse" UpdateSmsTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" UpdateTemplateActiveVersionResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" UpdateVoiceChannelResponse: type: object required: - VoiceChannelResponse properties: VoiceChannelResponse: $ref: "#/components/schemas/VoiceChannelResponse" UpdateVoiceTemplateResponse: type: object required: - MessageBody properties: MessageBody: $ref: "#/components/schemas/MessageBody" VerifyOTPMessageResponse: type: object required: - VerificationResponse properties: VerificationResponse: $ref: "#/components/schemas/VerificationResponse" ADMChannelRequest: type: object required: - ClientSecret - ClientId 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. description: Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application. ADMChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the application that the ADM channel applies to. CreationDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the ADM channel was enabled. Enabled: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the ADM 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 ADM channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the ADM channel is archived. LastModifiedBy: allOf: - $ref: "#/components/schemas/__string" - description: The user who last modified the ADM channel. LastModifiedDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the ADM channel was last modified. Platform: allOf: - $ref: "#/components/schemas/__string" - description: The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM. Version: allOf: - $ref: "#/components/schemas/__integer" - description: The current version of the ADM channel. description: Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application. Action: type: string enum: - OPEN_APP - DEEP_LINK - URL ADMMessage: 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. ConsolidationKey: allOf: - $ref: "#/components/schemas/__string" - description: An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this 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. ExpiresAfter: allOf: - $ref: "#/components/schemas/__string" - description: The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM. 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. MD5: allOf: - $ref: "#/components/schemas/__string" - description: The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data. 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. 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 ADM (Amazon Device Messaging) channel. APNSChannelRequest: 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. description: Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application. APNSChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the application that the APNs channel applies to. CreationDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs channel was enabled. DefaultAuthenticationMethod: allOf: - $ref: "#/components/schemas/__string" - description: The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate. Enabled: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs channel is enabled for the application. HasCredential: allOf: - $ref: "#/components/schemas/__boolean" - description: (Not used) This property is retained only for backward compatibility. HasTokenKey: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. Id: allOf: - $ref: "#/components/schemas/__string" - description: (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs channel is archived. LastModifiedBy: allOf: - $ref: "#/components/schemas/__string" - description: The user who last modified the APNs channel. LastModifiedDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs channel was last modified. Platform: allOf: - $ref: "#/components/schemas/__string" - description: "

The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

" Version: allOf: - $ref: "#/components/schemas/__integer" - description: The current version of the APNs channel. description: Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application. 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. APNSSandboxChannelRequest: 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. description: Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application. APNSSandboxChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the application that the APNs sandbox channel applies to. CreationDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs sandbox channel was enabled. DefaultAuthenticationMethod: allOf: - $ref: "#/components/schemas/__string" - description: The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate. Enabled: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs sandbox channel is enabled for the application. HasCredential: allOf: - $ref: "#/components/schemas/__boolean" - description: (Not used) This property is retained only for backward compatibility. HasTokenKey: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. Id: allOf: - $ref: "#/components/schemas/__string" - description: (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs sandbox channel is archived. LastModifiedBy: allOf: - $ref: "#/components/schemas/__string" - description: The user who last modified the APNs sandbox channel. LastModifiedDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs sandbox channel was last modified. Platform: allOf: - $ref: "#/components/schemas/__string" - description: The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX. Version: allOf: - $ref: "#/components/schemas/__integer" - description: The current version of the APNs sandbox channel. description: Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application. APNSVoipChannelRequest: 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. description: Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application. APNSVoipChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the application that the APNs VoIP channel applies to. CreationDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs VoIP channel was enabled. DefaultAuthenticationMethod: allOf: - $ref: "#/components/schemas/__string" - description: The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate. Enabled: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs VoIP channel is enabled for the application. HasCredential: allOf: - $ref: "#/components/schemas/__boolean" - description: (Not used) This property is retained only for backward compatibility. HasTokenKey: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. Id: allOf: - $ref: "#/components/schemas/__string" - description: (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs VoIP channel is archived. LastModifiedBy: allOf: - $ref: "#/components/schemas/__string" - description: The user who last modified the APNs VoIP channel. LastModifiedDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs VoIP channel was last modified. Platform: allOf: - $ref: "#/components/schemas/__string" - description: The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP. Version: allOf: - $ref: "#/components/schemas/__integer" - description: The current version of the APNs VoIP channel. description: Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application. APNSVoipSandboxChannelRequest: 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. description: Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application. APNSVoipSandboxChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the application that the APNs VoIP sandbox channel applies to. CreationDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs VoIP sandbox channel was enabled. DefaultAuthenticationMethod: allOf: - $ref: "#/components/schemas/__string" - description: The default authentication method that Amazon Pinpoint uses to authenticate 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. HasCredential: allOf: - $ref: "#/components/schemas/__boolean" - description: (Not used) This property is retained only for backward compatibility. HasTokenKey: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. Id: allOf: - $ref: "#/components/schemas/__string" - description: (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: "#/components/schemas/__boolean" - description: Specifies whether the APNs VoIP sandbox channel is archived. LastModifiedBy: allOf: - $ref: "#/components/schemas/__string" - description: The user who last modified the APNs VoIP sandbox channel. LastModifiedDate: allOf: - $ref: "#/components/schemas/__string" - description: The date and time when the APNs VoIP sandbox channel was last modified. Platform: allOf: - $ref: "#/components/schemas/__string" - description: The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX. Version: allOf: - $ref: "#/components/schemas/__integer" - description: The current version of the APNs VoIP sandbox channel. description: Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application. ListOfActivityResponse: type: array items: $ref: "#/components/schemas/ActivityResponse" ActivitiesResponse: type: object required: - Item properties: Item: allOf: - $ref: "#/components/schemas/ListOfActivityResponse" - description: An array of responses, one for each activity that was performed by the campaign. 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 activities that were performed by a campaign. 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. ConditionalSplitActivity: type: object properties: Condition: allOf: - $ref: "#/components/schemas/Condition" - description: The conditions that define the paths for the activity, and the relationship between the conditions. EvaluationWaitTime: allOf: - $ref: "#/components/schemas/WaitTime" - description: The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met. FalseActivity: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the activity to perform if the conditions aren't met. TrueActivity: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the activity to perform if the conditions are met. description:

    Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

    To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

    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. HoldoutActivity: type: object required: - Percentage properties: NextActivity: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the next activity to perform, after performing the holdout activity. Percentage: allOf: - $ref: "#/components/schemas/__integer" - description:

    The percentage of participants who shouldn't continue the journey.

    To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

    description: Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants. MultiConditionalSplitActivity: type: object properties: Branches: allOf: - $ref: "#/components/schemas/ListOfMultiConditionalBranch" - description: The paths for the activity, including the conditions for entering each path and the activity to perform for each path. DefaultActivity: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity. EvaluationWaitTime: allOf: - $ref: "#/components/schemas/WaitTime" - description: The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met. description:

    Specifies the settings for a multivariate split activity in a journey. 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.

    To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

    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. 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. 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. WaitActivity: type: object properties: NextActivity: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the next activity to perform, after performing the wait activity. WaitTime: allOf: - $ref: "#/components/schemas/WaitTime" - description: The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey. description: Specifies the settings for a wait activity in a journey. 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. ContactCenterActivity: type: object properties: NextActivity: allOf: - $ref: "#/components/schemas/__string" - description: The unique identifier for the next activity to perform after the this activity. 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. 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. AddressConfiguration: type: object properties: BodyOverride: allOf: - $ref: "#/components/schemas/__string" - description: The message body to use instead of the default message body. This value overrides the default message body. ChannelType: allOf: - $ref: "#/components/schemas/ChannelType" - description: The channel to use when sending the message. Context: allOf: - $ref: "#/components/schemas/MapOf__string" - description:

    An object that maps custom attributes to attributes for the address and is attached to the message. 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 by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables. TitleOverride: allOf: - $ref: "#/components/schemas/__string" - description: The message title to use instead of the default message title. This value overrides the default message title. description: Specifies address-based configuration settings for a message that's sent directly to an endpoint. Alignment: type: string enum: - LEFT - CENTER - RIGHT __timestampIso8601: type: string format: date-time BaseKpiResult: type: object required: - Rows properties: Rows: allOf: - $ref: "#/components/schemas/ListOfResultRow" - description: An array of objects that provides the results of a query that retrieved the data 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. 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. 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. 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. ListOfApplicationResponse: type: array items: $ref: "#/components/schemas/ApplicationResponse" ApplicationsResponse: type: object properties: Item: allOf: - $ref: "#/components/schemas/ListOfApplicationResponse" - description: An array of responses, one for each application that was returned. 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 all of your applications. AttributeType: type: string enum: - INCLUSIVE - EXCLUSIVE - CONTAINS - BEFORE - AFTER - ON - BETWEEN AttributeDimension: type: object required: - Values properties: AttributeType: allOf: - $ref: "#/components/schemas/AttributeType" - description: "The type of segment dimension to use. Valid values are: