openapi: 3.0.0 info: version: 2016-12-01 x-release: v4 title: Amazon Pinpoint Applications Apps API description: Doc Engage API - Amazon Pinpoint API x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: pinpoint x-aws-signingName: mobiletargeting x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pinpoint-2016-12-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://pinpoint.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Pinpoint multi-region endpoint - url: https://pinpoint.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Pinpoint multi-region endpoint - url: http://pinpoint.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia) - url: https://pinpoint.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Apps paths: /v1/apps: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateApp description: '
Creates an application.
' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAppResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - CreateApplicationRequest properties: CreateApplicationRequest: description: Specifies the display name of an application and the tags to associate with the application. type: object properties: Name: allOf: - $ref: '#/components/schemas/__string' - description: The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create App tags: - Apps get: operationId: GetApps description: Retrieves information about all the applications that are associated with your Amazon Pinpoint account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAppsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apps tags: - Apps /v1/apps/{application-id}/campaigns: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateCampaign description: Creates a new campaign for an application or updates the settings of an existing campaign for an application. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteCampaignRequest properties: WriteCampaignRequest: description: Specifies the configuration and other settings for a campaign. type: object properties: AdditionalTreatments: allOf: - $ref: '#/components/schemas/ListOfWriteTreatmentResource' - description: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. CustomDeliveryConfiguration: allOf: - $ref: '#/components/schemas/CustomDeliveryConfiguration' - description: The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object. Description: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the campaign. HoldoutPercent: allOf: - $ref: '#/components/schemas/__integer' - description: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. Hook: allOf: - $ref: '#/components/schemas/CampaignHook' - description: The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign. IsPaused: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false. Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The messaging limits for the campaign. MessageConfiguration: allOf: - $ref: '#/components/schemas/MessageConfiguration' - description: The message configuration settings for the campaign. Name: allOf: - $ref: '#/components/schemas/__string' - description: A custom name for the campaign. Schedule: allOf: - $ref: '#/components/schemas/Schedule' - description: The schedule settings for the campaign. SegmentId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment to associate with the campaign. SegmentVersion: allOf: - $ref: '#/components/schemas/__integer' - description: The version of the segment to associate with the campaign. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template to use for the campaign. TreatmentDescription: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the default treatment for the campaign. TreatmentName: allOf: - $ref: '#/components/schemas/__string' - description: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing. Priority: allOf: - $ref: '#/components/schemas/__integer' - description: Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Campaign tags: - Apps get: operationId: GetCampaigns description: Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaigns tags: - Apps /v1/apps/{application-id}/jobs/export: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateExportJob description: Creates an export job for an application. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateExportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - ExportJobRequest properties: ExportJobRequest: description: Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket. type: object properties: RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to. S3UrlPrefix: allOf: - $ref: '#/components/schemas/__string' - description: 'The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://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://
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:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
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:
DRAFT - Saves the journey and doesn't publish it.
ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.
WaitForQuietTime: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours. RefreshOnSegmentUpdate: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether a journey should be refreshed on segment update. JourneyChannelSettings: allOf: - $ref: '#/components/schemas/JourneyChannelSettings' - description: The channel-specific configurations for the journey. SendingSchedule: allOf: - $ref: '#/components/schemas/__boolean' - description: Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays) OpenHours: allOf: - $ref: '#/components/schemas/OpenHours' - description: The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true. ClosedDays: allOf: - $ref: '#/components/schemas/ClosedDays' - description: The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Journey tags: - Apps get: operationId: ListJourneys description: Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListJourneysResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint List Journeys tags: - Apps /v1/apps/{application-id}/segments: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateSegment description: Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteSegmentRequest properties: WriteSegmentRequest: description: Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both. type: object properties: Dimensions: allOf: - $ref: '#/components/schemas/SegmentDimensions' - description: The criteria that define the dimensions for the segment. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the segment. SegmentGroups: allOf: - $ref: '#/components/schemas/SegmentGroupList' - description: The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Create Segment tags: - Apps get: operationId: GetSegments description: Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segments tags: - Apps /v1/apps/{application-id}/channels/adm: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteAdmChannel description: Disables the ADM channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteAdmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Adm Channel tags: - Apps get: operationId: GetAdmChannel description: Retrieves information about the status and settings of the ADM channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAdmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Adm Channel tags: - Apps put: operationId: UpdateAdmChannel description: Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateAdmChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - ADMChannelRequest properties: ADMChannelRequest: description: Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application. type: object properties: ClientId: allOf: - $ref: '#/components/schemas/__string' - description: The Client ID that you received from Amazon to send messages by using ADM. ClientSecret: allOf: - $ref: '#/components/schemas/__string' - description: The Client Secret that you received from Amazon to send messages by using ADM. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the ADM channel for the application. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Adm Channel tags: - Apps /v1/apps/{application-id}/channels/apns: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsChannel description: Disables the APNs channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Channel tags: - Apps get: operationId: GetApnsChannel description: Retrieves information about the status and settings of the APNs channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Channel tags: - Apps put: operationId: UpdateApnsChannel description: Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSChannelRequest properties: APNSChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the APNs channel for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Channel tags: - Apps /v1/apps/{application-id}/channels/apns_sandbox: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsSandboxChannel description: Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Sandbox Channel tags: - Apps get: operationId: GetApnsSandboxChannel description: Retrieves information about the status and settings of the APNs sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Sandbox Channel tags: - Apps put: operationId: UpdateApnsSandboxChannel description: Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSSandboxChannelRequest properties: APNSSandboxChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the APNs sandbox channel for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Sandbox Channel tags: - Apps /v1/apps/{application-id}/channels/apns_voip: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsVoipChannel description: Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsVoipChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Voip Channel tags: - Apps get: operationId: GetApnsVoipChannel description: Retrieves information about the status and settings of the APNs VoIP channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsVoipChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Voip Channel tags: - Apps put: operationId: UpdateApnsVoipChannel description: Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsVoipChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSVoipChannelRequest properties: APNSVoipChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the APNs VoIP channel for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Voip Channel tags: - Apps /v1/apps/{application-id}/channels/apns_voip_sandbox: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApnsVoipSandboxChannel description: Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApnsVoipSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Apns Voip Sandbox Channel tags: - Apps get: operationId: GetApnsVoipSandboxChannel description: Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApnsVoipSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Apns Voip Sandbox Channel tags: - Apps put: operationId: UpdateApnsVoipSandboxChannel description: Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApnsVoipSandboxChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - APNSVoipSandboxChannelRequest properties: APNSVoipSandboxChannelRequest: description: Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application. type: object properties: BundleId: allOf: - $ref: '#/components/schemas/__string' - description: The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. Certificate: allOf: - $ref: '#/components/schemas/__string' - description: The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. DefaultAuthenticationMethod: allOf: - $ref: '#/components/schemas/__string' - description: The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the APNs VoIP sandbox channel is enabled for the application. PrivateKey: allOf: - $ref: '#/components/schemas/__string' - description: The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. TeamId: allOf: - $ref: '#/components/schemas/__string' - description: The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. TokenKey: allOf: - $ref: '#/components/schemas/__string' - description: The authentication key to use for APNs tokens. TokenKeyId: allOf: - $ref: '#/components/schemas/__string' - description: The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Apns Voip Sandbox Channel tags: - Apps /v1/apps/{application-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteApp description: Deletes an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteAppResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete App tags: - Apps get: operationId: GetApp description: Retrieves information about an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAppResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get App tags: - Apps /v1/apps/{application-id}/channels/baidu: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteBaiduChannel description: Disables the Baidu channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteBaiduChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Baidu Channel tags: - Apps get: operationId: GetBaiduChannel description: Retrieves information about the status and settings of the Baidu channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetBaiduChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Baidu Channel tags: - Apps put: operationId: UpdateBaiduChannel description: Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateBaiduChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - BaiduChannelRequest properties: BaiduChannelRequest: description: Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application. type: object properties: ApiKey: allOf: - $ref: '#/components/schemas/__string' - description: The API key that you received from the Baidu Cloud Push service to communicate with the service. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the Baidu channel for the application. SecretKey: allOf: - $ref: '#/components/schemas/__string' - description: The secret key that you received from the Baidu Cloud Push service to communicate with the service. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Baidu Channel tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteCampaign description: Deletes a campaign from an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Campaign tags: - Apps get: operationId: GetCampaign description: Retrieves information about the status, configuration, and other settings for a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign tags: - Apps put: operationId: UpdateCampaign description: Updates the configuration and other settings for a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateCampaignResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteCampaignRequest properties: WriteCampaignRequest: description: Specifies the configuration and other settings for a campaign. type: object properties: AdditionalTreatments: allOf: - $ref: '#/components/schemas/ListOfWriteTreatmentResource' - description: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. CustomDeliveryConfiguration: allOf: - $ref: '#/components/schemas/CustomDeliveryConfiguration' - description: The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object. Description: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the campaign. HoldoutPercent: allOf: - $ref: '#/components/schemas/__integer' - description: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. Hook: allOf: - $ref: '#/components/schemas/CampaignHook' - description: The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign. IsPaused: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false. Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The messaging limits for the campaign. MessageConfiguration: allOf: - $ref: '#/components/schemas/MessageConfiguration' - description: The message configuration settings for the campaign. Name: allOf: - $ref: '#/components/schemas/__string' - description: A custom name for the campaign. Schedule: allOf: - $ref: '#/components/schemas/Schedule' - description: The schedule settings for the campaign. SegmentId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment to associate with the campaign. SegmentVersion: allOf: - $ref: '#/components/schemas/__integer' - description: The version of the segment to associate with the campaign. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template to use for the campaign. TreatmentDescription: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the default treatment for the campaign. TreatmentName: allOf: - $ref: '#/components/schemas/__string' - description: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing. Priority: allOf: - $ref: '#/components/schemas/__integer' - description: Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Campaign tags: - Apps /v1/apps/{application-id}/channels/email: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEmailChannel description: Disables the email channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEmailChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Email Channel tags: - Apps get: operationId: GetEmailChannel description: Retrieves information about the status and settings of the email channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEmailChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Email Channel tags: - Apps put: operationId: UpdateEmailChannel description: Enables the email channel for an application or updates the status and settings of the email channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEmailChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EmailChannelRequest properties: EmailChannelRequest: description: Specifies the status and settings of the email channel for an application. type: object properties: ConfigurationSet: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon SES configuration set that you want to apply to messages that you send through the channel. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the email channel for the application. FromAddress: allOf: - $ref: '#/components/schemas/__string' - description: 'The verified email address that you want to send email from when you send email through the channel.
' Identity: allOf: - $ref: '#/components/schemas/__string' - description: 'The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
' RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: 'The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Email Channel tags: - Apps /v1/apps/{application-id}/endpoints/{endpoint-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEndpoint description: Deletes an endpoint from an application. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEndpointResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Endpoint tags: - Apps get: operationId: GetEndpoint description: Retrieves information about the settings and attributes of a specific endpoint for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEndpointResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Endpoint tags: - Apps put: operationId: UpdateEndpoint description: Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEndpointResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EndpointRequest properties: EndpointRequest: description: Specifies the channel type and other settings for an endpoint. type: object properties: Address: allOf: - $ref: '#/components/schemas/__string' - description: The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. Attributes: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: 'One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can''t display attribute names that contain these characters. This restriction doesn''t apply to attribute values.
' ChannelType: allOf: - $ref: '#/components/schemas/ChannelType' - description: The channel to use when sending messages or push notifications to the endpoint. Demographic: allOf: - $ref: '#/components/schemas/EndpointDemographic' - description: The demographic information for the endpoint, such as the time zone and platform. EffectiveDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the endpoint is updated. EndpointStatus: allOf: - $ref: '#/components/schemas/__string' - description: 'Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
' Location: allOf: - $ref: '#/components/schemas/EndpointLocation' - description: The geographic information for the endpoint. Metrics: allOf: - $ref: '#/components/schemas/MapOf__double' - description: One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. OptOut: allOf: - $ref: '#/components/schemas/__string' - description: 'Specifies whether the user who''s associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn''t want to receive any messages or push notifications; and, NONE, the user hasn''t opted out and wants to receive all messages and push notifications.' RequestId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the most recent request to update the endpoint. User: allOf: - $ref: '#/components/schemas/EndpointUser' - description: One or more custom attributes that describe the user who's associated with the endpoint. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Endpoint tags: - Apps /v1/apps/{application-id}/eventstream: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEventStream description: Deletes the event stream for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEventStreamResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Event Stream tags: - Apps get: operationId: GetEventStream description: Retrieves information about the event stream settings for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEventStreamResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Event Stream tags: - Apps post: operationId: PutEventStream description: Creates a new event stream for an application or updates the settings of an existing event stream for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEventStreamResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteEventStream properties: WriteEventStream: description: Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events. type: object properties: DestinationStreamArn: allOf: - $ref: '#/components/schemas/__string' - description: "The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:
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:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
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:
DRAFT - Saves the journey and doesn't publish it.
ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.
WaitForQuietTime: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours. RefreshOnSegmentUpdate: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether a journey should be refreshed on segment update. JourneyChannelSettings: allOf: - $ref: '#/components/schemas/JourneyChannelSettings' - description: The channel-specific configurations for the journey. SendingSchedule: allOf: - $ref: '#/components/schemas/__boolean' - description: Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays) OpenHours: allOf: - $ref: '#/components/schemas/OpenHours' - description: The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true. ClosedDays: allOf: - $ref: '#/components/schemas/ClosedDays' - description: The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Journey tags: - Apps /v1/apps/{application-id}/segments/{segment-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteSegment description: Deletes a segment from an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Segment tags: - Apps get: operationId: GetSegment description: Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment tags: - Apps put: operationId: UpdateSegment description: Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSegmentResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteSegmentRequest properties: WriteSegmentRequest: description: Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both. type: object properties: Dimensions: allOf: - $ref: '#/components/schemas/SegmentDimensions' - description: The criteria that define the dimensions for the segment. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the segment. SegmentGroups: allOf: - $ref: '#/components/schemas/SegmentGroupList' - description: The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group. tags: allOf: - $ref: '#/components/schemas/MapOf__string' - description: A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Segment tags: - Apps /v1/apps/{application-id}/channels/sms: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteSmsChannel description: Disables the SMS channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSmsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Sms Channel tags: - Apps get: operationId: GetSmsChannel description: Retrieves information about the status and settings of the SMS channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSmsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Sms Channel tags: - Apps put: operationId: UpdateSmsChannel description: Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSmsChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - SMSChannelRequest properties: SMSChannelRequest: description: Specifies the status and settings of the SMS channel for an application. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the SMS channel for the application. SenderId: allOf: - $ref: '#/components/schemas/__string' - description: The identity that you want to display on recipients' devices when they receive messages from the SMS channel. ShortCode: allOf: - $ref: '#/components/schemas/__string' - description: The registered short code that you want to use when you send messages through the SMS channel. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Sms Channel tags: - Apps /v1/apps/{application-id}/users/{user-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteUserEndpoints description: Deletes all the endpoints that are associated with a specific user ID. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteUserEndpointsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: user-id in: path required: true description: The unique identifier for the user. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete User Endpoints tags: - Apps get: operationId: GetUserEndpoints description: Retrieves information about all the endpoints that are associated with a specific user ID. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetUserEndpointsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: user-id in: path required: true description: The unique identifier for the user. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get User Endpoints tags: - Apps /v1/apps/{application-id}/channels/voice: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteVoiceChannel description: Disables the voice channel for an application and deletes any existing settings for the channel. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVoiceChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Delete Voice Channel tags: - Apps get: operationId: GetVoiceChannel description: Retrieves information about the status and settings of the voice channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetVoiceChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Voice Channel tags: - Apps put: operationId: UpdateVoiceChannel description: Enables the voice channel for an application or updates the status and settings of the voice channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateVoiceChannelResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - VoiceChannelRequest properties: VoiceChannelRequest: description: Specifies the status and settings of the voice channel for an application. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable the voice channel for the application. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Voice Channel tags: - Apps /v1/apps/{application-id}/kpis/daterange/{kpi-name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetApplicationDateRangeKpi description: Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApplicationDateRangeKpiResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: end-time in: query required: false description: 'The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.' schema: type: string format: date-time - name: kpi-name in: path required: true description: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: start-time in: query required: false description: 'The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.' schema: type: string format: date-time x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Application Date Range Kpi tags: - Apps /v1/apps/{application-id}/settings: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetApplicationSettings description: Retrieves information about the settings for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetApplicationSettingsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Application Settings tags: - Apps put: operationId: UpdateApplicationSettings description: Updates the settings for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationSettingsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - WriteApplicationSettingsRequest properties: WriteApplicationSettingsRequest: description: Specifies the default settings for an application. type: object properties: CampaignHook: allOf: - $ref: '#/components/schemas/CampaignHook' - description:The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
CloudWatchMetricsEnabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether to enable application-related alarms in Amazon CloudWatch. EventTaggingEnabled: $ref: '#/components/schemas/__boolean' Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description:The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Application Settings tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/activities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignActivities description: Retrieves information about all the activities for a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignActivitiesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Activities tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignDateRangeKpi description: Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignDateRangeKpiResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: end-time in: query required: false description: 'The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.' schema: type: string format: date-time - name: kpi-name in: path required: true description: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: start-time in: query required: false description: 'The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.' schema: type: string format: date-time x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Date Range Kpi tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignVersion description: Retrieves information about the status, configuration, and other settings for a specific version of a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignVersionResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: version in: path required: true description: The unique version number (Version property) for the campaign version. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Version tags: - Apps /v1/apps/{application-id}/campaigns/{campaign-id}/versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetCampaignVersions description: Retrieves information about the status, configuration, and other settings for all versions of a campaign. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCampaignVersionsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: campaign-id in: path required: true description: The unique identifier for the campaign. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Campaign Versions tags: - Apps /v1/apps/{application-id}/channels: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetChannels description: Retrieves information about the history and status of each channel for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetChannelsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Channels tags: - Apps /v1/apps/{application-id}/jobs/export/{job-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetExportJob description: Retrieves information about the status and settings of a specific export job for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetExportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: job-id in: path required: true description: The unique identifier for the job. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Export Job tags: - Apps /v1/apps/{application-id}/jobs/import/{job-id}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetImportJob description: Retrieves information about the status and settings of a specific import job for an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetImportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: job-id in: path required: true description: The unique identifier for the job. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Import Job tags: - Apps /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetInAppMessages description: Retrieves the in-app messages targeted for the provided endpoint ID. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetInAppMessagesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: endpoint-id in: path required: true description: The unique identifier for the endpoint. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get in App Messages tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetJourneyDateRangeKpi description: Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJourneyDateRangeKpiResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: end-time in: query required: false description: 'The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.' schema: type: string format: date-time - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string - name: kpi-name in: path required: true description: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: start-time in: query required: false description: 'The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.' schema: type: string format: date-time x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Journey Date Range Kpi tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetJourneyExecutionActivityMetrics description: Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJourneyExecutionActivityMetricsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-activity-id in: path required: true description: The unique identifier for the journey activity. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Journey Execution Activity Metrics tags: - Apps /v1/apps/{application-id}/journeys/{journey-id}/execution-metrics: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetJourneyExecutionMetrics description: Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJourneyExecutionMetricsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: journey-id in: path required: true description: The unique identifier for the journey. schema: type: string - name: next-token in: query required: false description: The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Journey Execution Metrics tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/jobs/export: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentExportJobs description: Retrieves information about the status and settings of the export jobs for a segment. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentExportJobsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Export Jobs tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/jobs/import: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentImportJobs description: Retrieves information about the status and settings of the import jobs for a segment. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentImportJobsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Import Jobs tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/versions/{version}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentVersion description: Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentVersionResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: version in: path required: true description: The unique version number (Version property) for the campaign version. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Version tags: - Apps /v1/apps/{application-id}/segments/{segment-id}/versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSegmentVersions description: Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSegmentVersionsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: page-size in: query required: false description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. schema: type: string - name: segment-id in: path required: true description: The unique identifier for the segment. schema: type: string - name: token in: query required: false description: The NextToken string that specifies which page of results to return in a paginated response. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Get Segment Versions tags: - Apps /v1/apps/{application-id}/events: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: PutEvents description: Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEventsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EventsRequest properties: EventsRequest: description: Specifies a batch of events to process. type: object properties: BatchItem: allOf: - $ref: '#/components/schemas/MapOfEventsBatch' - description: The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Put Events tags: - Apps /v1/apps/{application-id}/attributes/{attribute-type}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: RemoveAttributes description: Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveAttributesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. schema: type: string - name: attribute-type in: path required: true description: 'The type of attribute or attributes to remove. Valid values are:
endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.
The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.
x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Update Journey State tags: - Apps /v1/apps/{application-id}/verify-otp: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: VerifyOTPMessage description: Verify an OTP responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VerifyOTPMessageResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' '482': description: PayloadTooLargeException content: application/json: schema: $ref: '#/components/schemas/PayloadTooLargeException' '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: MethodNotAllowedException content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedException' '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: application-id in: path required: true description: The unique ID of your Amazon Pinpoint application. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - VerifyOTPMessageRequestParameters properties: VerifyOTPMessageRequestParameters: description: Verify OTP message request. type: object properties: DestinationIdentity: allOf: - $ref: '#/components/schemas/__string' - description: The destination identity to send OTP to. Otp: allOf: - $ref: '#/components/schemas/__string' - description: The OTP the end user provided for verification. ReferenceId: allOf: - $ref: '#/components/schemas/__string' - description: The reference identifier provided when the OTP was previously sent. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Pinpoint Verify O T P Message tags: - Apps components: schemas: EndpointDemographic: type: object properties: AppVersion: allOf: - $ref: '#/components/schemas/__string' - description: The version of the app that's associated with the endpoint. Locale: allOf: - $ref: '#/components/schemas/__string' - description: 'The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.' Make: allOf: - $ref: '#/components/schemas/__string' - description: The manufacturer of the endpoint device, such as apple or samsung. Model: allOf: - $ref: '#/components/schemas/__string' - description: The model name or number of the endpoint device, such as iPhone or SM-G900F. ModelVersion: allOf: - $ref: '#/components/schemas/__string' - description: The model version of the endpoint device. Platform: allOf: - $ref: '#/components/schemas/__string' - description: The platform of the endpoint device, such as ios. PlatformVersion: allOf: - $ref: '#/components/schemas/__string' - description: The platform version of the endpoint device. Timezone: allOf: - $ref: '#/components/schemas/__string' - description: The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles. description: Specifies demographic information about an endpoint, such as the applicable time zone and platform. JourneyEmailMessage: type: object properties: FromAddress: allOf: - $ref: '#/components/schemas/__string' - description: The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application. description: Specifies the "From" address for an email message that's sent to participants in a journey. State: type: string enum: - DRAFT - ACTIVE - COMPLETED - CANCELLED - CLOSED - PAUSED EmailMessageActivity: type: object properties: MessageConfig: allOf: - $ref: '#/components/schemas/JourneyEmailMessage' - description: Specifies the sender address for an email message that's sent to participants in the journey. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after the message is sent. TemplateName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the email message template to use for the message. If specified, this value must match the name of an existing message template. TemplateVersion: allOf: - $ref: '#/components/schemas/__string' - description:The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
description: Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants. ClosedDaysRule: type: object properties: Name: allOf: - $ref: '#/components/schemas/__string' - description: Name of the rule. StartDateTime: allOf: - $ref: '#/components/schemas/__string' - description: Start Datetime in ISO 8601 format. EndDateTime: allOf: - $ref: '#/components/schemas/__string' - description: End Datetime in ISO 8601 format. description: Closed Days Rule. Part of Journey sending schedule. DimensionType: type: string enum: - INCLUSIVE - EXCLUSIVE EventStream: type: object required: - ApplicationId - RoleArn - DestinationStreamArn properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application to publish event data for. DestinationStreamArn: allOf: - $ref: '#/components/schemas/__string' - description: "The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
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:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
StartTime: allOf: - $ref: '#/components/schemas/__string' - description: 'The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.' Timezone: allOf: - $ref: '#/components/schemas/__string' - description: "The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,\n UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,\n UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11." description: Specifies the schedule settings for a campaign. ListJourneysResponse: type: object required: - JourneysResponse properties: JourneysResponse: $ref: '#/components/schemas/JourneysResponse' OverrideButtonConfiguration: type: object required: - ButtonAction properties: ButtonAction: allOf: - $ref: '#/components/schemas/ButtonAction' - description: Action triggered by the button. Link: allOf: - $ref: '#/components/schemas/__string' - description: Button destination. description: Override button configuration. DeleteEmailChannelResponse: type: object required: - EmailChannelResponse properties: EmailChannelResponse: $ref: '#/components/schemas/EmailChannelResponse' Frequency: type: string enum: - ONCE - HOURLY - DAILY - WEEKLY - MONTHLY - EVENT - IN_APP_EVENT StartCondition: type: object properties: Description: allOf: - $ref: '#/components/schemas/__string' - description: The custom description of the condition. EventStartCondition: $ref: '#/components/schemas/EventStartCondition' SegmentStartCondition: allOf: - $ref: '#/components/schemas/SegmentCondition' - description: The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey. description: Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey. GetSegmentVersionsResponse: type: object required: - SegmentsResponse properties: SegmentsResponse: $ref: '#/components/schemas/SegmentsResponse' ListOf__string: type: array items: $ref: '#/components/schemas/__string' ListOfEndpointResponse: type: array items: $ref: '#/components/schemas/EndpointResponse' UpdateEndpointsBatchResponse: type: object required: - MessageBody properties: MessageBody: $ref: '#/components/schemas/MessageBody' DeleteBaiduChannelResponse: type: object required: - BaiduChannelResponse properties: BaiduChannelResponse: $ref: '#/components/schemas/BaiduChannelResponse' Event: type: object required: - EventType - Timestamp properties: AppPackageName: allOf: - $ref: '#/components/schemas/__string' - description: The package name of the app that's recording the event. AppTitle: allOf: - $ref: '#/components/schemas/__string' - description: The title of the app that's recording the event. AppVersionCode: allOf: - $ref: '#/components/schemas/__string' - description: The version number of the app that's recording the event. Attributes: allOf: - $ref: '#/components/schemas/MapOf__string' - description: One or more custom attributes that are associated with the event. ClientSdkVersion: allOf: - $ref: '#/components/schemas/__string' - description: The version of the SDK that's running on the client device. EventType: allOf: - $ref: '#/components/schemas/__string' - description: The name of the event. Metrics: allOf: - $ref: '#/components/schemas/MapOf__double' - description: One or more custom metrics that are associated with the event. SdkName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the SDK that's being used to record the event. Session: allOf: - $ref: '#/components/schemas/Session' - description: Information about the session in which the event occurred. Timestamp: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the event occurred. description: Specifies information about an event that reports data to Amazon Pinpoint. ListOfSegmentResponse: type: array items: $ref: '#/components/schemas/SegmentResponse' EventsResponse: type: object properties: Results: allOf: - $ref: '#/components/schemas/MapOfItemResponse' - description: 'A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn''t valid or required fields were missing.' description: Provides information about endpoints and the events that they're associated with. UpdateJourneyStateResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: '#/components/schemas/JourneyResponse' EventCondition: type: object properties: Dimensions: allOf: - $ref: '#/components/schemas/EventDimensions' - description: The dimensions for the event filter to use for the activity. MessageActivity: allOf: - $ref: '#/components/schemas/__string' - description: The message identifier (message_id) for the message to use when determining whether message events meet the condition. description: Specifies the conditions to evaluate for an event that applies to an activity in a journey. JourneysResponse: type: object required: - Item properties: Item: allOf: - $ref: '#/components/schemas/ListOfJourneyResponse' - description: An array of responses, one for each journey that's associated with the application. NextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. description: Provides information about the status, configuration, and other settings for all the journeys that are associated with an application. SendUsersMessageResponse: type: object required: - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that was used to send the message. RequestId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier that was assigned to the message request. Result: allOf: - $ref: '#/components/schemas/MapOfMapOfEndpointMessageResult' - description: An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object. description: Provides information about which users and endpoints a message was sent to. MapOfItemResponse: type: object additionalProperties: $ref: '#/components/schemas/ItemResponse' Mode: type: string enum: - DELIVERY - FILTER CustomMessageActivity: type: object properties: DeliveryUri: allOf: - $ref: '#/components/schemas/__string' - description:The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
description: The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants. Session: type: object required: - StartTimestamp - Id properties: Duration: allOf: - $ref: '#/components/schemas/__integer' - description: The duration of the session, in milliseconds. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the session. StartTimestamp: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the session began. StopTimestamp: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the session ended. description: Provides information about a session. RandomSplitActivity: type: object properties: Branches: allOf: - $ref: '#/components/schemas/ListOfRandomSplitEntry' - description: The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path. description: Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify. GetJourneyExecutionActivityMetricsResponse: type: object required: - JourneyExecutionActivityMetricsResponse properties: JourneyExecutionActivityMetricsResponse: $ref: '#/components/schemas/JourneyExecutionActivityMetricsResponse' GCMChannelResponse: type: object required: - Credential - Platform properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the GCM channel applies to. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the GCM channel was enabled. Credential: allOf: - $ref: '#/components/schemas/__string' - description: The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the GCM channel is enabled for the application. HasCredential: allOf: - $ref: '#/components/schemas/__boolean' - description: (Not used) This property is retained only for backward compatibility. Id: allOf: - $ref: '#/components/schemas/__string' - description: (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the GCM channel is archived. LastModifiedBy: allOf: - $ref: '#/components/schemas/__string' - description: The user who last modified the GCM channel. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the GCM channel was last modified. Platform: allOf: - $ref: '#/components/schemas/__string' - description: The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The current version of the GCM channel. description: Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. MapOfEndpointMessageResult: type: object additionalProperties: $ref: '#/components/schemas/EndpointMessageResult' MapOfEndpointSendConfiguration: type: object additionalProperties: $ref: '#/components/schemas/EndpointSendConfiguration' EndpointBatchItem: type: object properties: Address: allOf: - $ref: '#/components/schemas/__string' - description: The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address. Attributes: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: 'One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can''t display attribute names that contain these characters. This restriction doesn''t apply to attribute values.
' ChannelType: allOf: - $ref: '#/components/schemas/ChannelType' - description: The channel to use when sending messages or push notifications to the endpoint. Demographic: allOf: - $ref: '#/components/schemas/EndpointDemographic' - description: The demographic information for the endpoint, such as the time zone and platform. EffectiveDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the endpoint was created or updated. EndpointStatus: allOf: - $ref: '#/components/schemas/__string' - description: 'Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
' Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the endpoint in the context of the batch. Location: allOf: - $ref: '#/components/schemas/EndpointLocation' - description: The geographic information for the endpoint. Metrics: allOf: - $ref: '#/components/schemas/MapOf__double' - description: One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. OptOut: allOf: - $ref: '#/components/schemas/__string' - description: 'Specifies whether the user who''s associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn''t want to receive any messages or push notifications; and, NONE, the user hasn''t opted out and wants to receive all messages and push notifications.' RequestId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the request to create or update the endpoint. User: allOf: - $ref: '#/components/schemas/EndpointUser' - description: One or more custom attributes that describe the user who's associated with the endpoint. description: Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint. GetCampaignVersionsResponse: type: object required: - CampaignsResponse properties: CampaignsResponse: $ref: '#/components/schemas/CampaignsResponse' ResultRowValue: type: object required: - Type - Value - Key properties: Key: allOf: - $ref: '#/components/schemas/__string' - description: The friendly name of the metric whose value is specified by the Value property. Type: allOf: - $ref: '#/components/schemas/__string' - description: The data type of the value specified by the Value property. Value: allOf: - $ref: '#/components/schemas/__string' - description: In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects). description: Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey. GetApnsVoipSandboxChannelResponse: type: object required: - APNSVoipSandboxChannelResponse properties: APNSVoipSandboxChannelResponse: $ref: '#/components/schemas/APNSVoipSandboxChannelResponse' ListOfRandomSplitEntry: type: array items: $ref: '#/components/schemas/RandomSplitEntry' DeleteGcmChannelResponse: type: object required: - GCMChannelResponse properties: GCMChannelResponse: $ref: '#/components/schemas/GCMChannelResponse' GetImportJobResponse: type: object required: - ImportJobResponse properties: ImportJobResponse: $ref: '#/components/schemas/ImportJobResponse' MessageResult: type: object required: - DeliveryStatus - StatusCode properties: DeliveryStatus: allOf: - $ref: '#/components/schemas/DeliveryStatus' - description:The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
The type of activity that the metric applies to. Possible values are:
CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE - For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
The type of attribute or attributes that were removed from the endpoints. Valid values are:
endpoint-custom-attributes - Custom attributes that describe endpoints.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
endpoint-user-attributes - Custom attributes that describe users.
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
description: Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants. CreateCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: '#/components/schemas/CampaignResponse' CampaignHook: type: object properties: LambdaFunctionName: allOf: - $ref: '#/components/schemas/__string' - description: The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign. Mode: allOf: - $ref: '#/components/schemas/Mode' - description:The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
' description: Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign. Type: type: string enum: - ALL - ANY - NONE JourneySMSMessage: type: object properties: MessageType: allOf: - $ref: '#/components/schemas/MessageType' - description: The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages). OriginationNumber: allOf: - $ref: '#/components/schemas/__string' - description: The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100. SenderId: allOf: - $ref: '#/components/schemas/__string' - description: The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide. EntityId: allOf: - $ref: '#/components/schemas/__string' - description: The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country. TemplateId: allOf: - $ref: '#/components/schemas/__string' - description: The template ID received from the regulatory body for sending SMS in your country. description: Specifies the sender ID and message type for an SMS message that's sent to participants in a journey. ListOfInAppMessageCampaign: type: array items: $ref: '#/components/schemas/InAppMessageCampaign' TemplateConfiguration: type: object properties: EmailTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The email template to use for the message. PushTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The push notification template to use for the message. SMSTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The SMS template to use for the message. VoiceTemplate: allOf: - $ref: '#/components/schemas/Template' - description: The voice template to use for the message. This object isn't supported for campaigns. description: Specifies the message template to use for the message, for each type of channel. Include: type: string enum: - ALL - ANY - NONE GetInAppMessagesResponse: type: object required: - InAppMessagesResponse properties: InAppMessagesResponse: $ref: '#/components/schemas/InAppMessagesResponse' InAppMessageButton: type: object properties: Android: allOf: - $ref: '#/components/schemas/OverrideButtonConfiguration' - description: Default button content. DefaultConfig: allOf: - $ref: '#/components/schemas/DefaultButtonConfiguration' - description: Default button content. IOS: allOf: - $ref: '#/components/schemas/OverrideButtonConfiguration' - description: Default button content. Web: allOf: - $ref: '#/components/schemas/OverrideButtonConfiguration' - description: Default button content. description: Button Config for an in-app message. UpdateCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: '#/components/schemas/CampaignResponse' MetricDimension: type: object required: - ComparisonOperator - Value properties: ComparisonOperator: allOf: - $ref: '#/components/schemas/__string' - description: 'The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.' Value: allOf: - $ref: '#/components/schemas/__double' - description: The value to compare. description: Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints. MapOfListOfOpenHoursRules: type: object additionalProperties: $ref: '#/components/schemas/ListOfOpenHoursRules' ListOfActivityResponse: type: array items: $ref: '#/components/schemas/ActivityResponse' ListOfJourneyResponse: type: array items: $ref: '#/components/schemas/JourneyResponse' VoiceChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the voice channel applies to. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the voice channel was enabled. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the voice channel is enabled for the application. HasCredential: allOf: - $ref: '#/components/schemas/__boolean' - description: (Not used) This property is retained only for backward compatibility. Id: allOf: - $ref: '#/components/schemas/__string' - description: (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility. IsArchived: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the voice channel is archived. LastModifiedBy: allOf: - $ref: '#/components/schemas/__string' - description: The user who last modified the voice channel. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the voice channel was last modified. Platform: allOf: - $ref: '#/components/schemas/__string' - description: The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The current version of the voice channel. description: Provides information about the status and settings of the voice channel for an application. DeleteAppResponse: type: object required: - ApplicationResponse properties: ApplicationResponse: $ref: '#/components/schemas/ApplicationResponse' ActivityResponse: type: object required: - CampaignId - Id - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the campaign applies to. CampaignId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the campaign that the activity applies to. End: allOf: - $ref: '#/components/schemas/__string' - description: The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the activity. Result: allOf: - $ref: '#/components/schemas/__string' - description: Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. ScheduledStart: allOf: - $ref: '#/components/schemas/__string' - description: The scheduled start time, in ISO 8601 format, for the activity. Start: allOf: - $ref: '#/components/schemas/__string' - description: The actual start time, in ISO 8601 format, of the activity. State: allOf: - $ref: '#/components/schemas/__string' - description: 'The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.' SuccessfulEndpointCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoints that the campaign successfully delivered messages to. TimezonesCompletedCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of time zones that were completed. TimezonesTotalCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of unique time zones that are in the segment for the campaign. TotalEndpointCount: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoints that the campaign attempted to deliver messages to. TreatmentId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign. description: Provides information about an activity that was performed by a campaign. CreateJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: '#/components/schemas/JourneyResponse' GetApplicationDateRangeKpiResponse: type: object required: - ApplicationDateRangeKpiResponse properties: ApplicationDateRangeKpiResponse: $ref: '#/components/schemas/ApplicationDateRangeKpiResponse' Activity: type: object properties: CUSTOM: allOf: - $ref: '#/components/schemas/CustomMessageActivity' - description: The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants. ConditionalSplit: allOf: - $ref: '#/components/schemas/ConditionalSplitActivity' - description: The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify. Description: allOf: - $ref: '#/components/schemas/__string' - description: The custom description of the activity. EMAIL: allOf: - $ref: '#/components/schemas/EmailMessageActivity' - description: The settings for an email activity. This type of activity sends an email message to participants. Holdout: allOf: - $ref: '#/components/schemas/HoldoutActivity' - description: The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants. MultiCondition: allOf: - $ref: '#/components/schemas/MultiConditionalSplitActivity' - description: The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify. PUSH: allOf: - $ref: '#/components/schemas/PushMessageActivity' - description: The settings for a push notification activity. This type of activity sends a push notification to participants. RandomSplit: allOf: - $ref: '#/components/schemas/RandomSplitActivity' - description: The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify. SMS: allOf: - $ref: '#/components/schemas/SMSMessageActivity' - description: The settings for an SMS activity. This type of activity sends a text message to participants. Wait: allOf: - $ref: '#/components/schemas/WaitActivity' - description: The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey. ContactCenter: allOf: - $ref: '#/components/schemas/ContactCenterActivity' - description: The settings for a connect activity. This type of activity initiates a contact center call to participants. description: Specifies the configuration and other settings for an activity in a journey. MultiConditionalBranch: type: object properties: Condition: allOf: - $ref: '#/components/schemas/SimpleCondition' - description: The condition to evaluate for the activity path. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after completing the activity for the path. description: Specifies a condition to evaluate for an activity path in a journey. GetSegmentExportJobsResponse: type: object required: - ExportJobsResponse properties: ExportJobsResponse: $ref: '#/components/schemas/ExportJobsResponse' UpdateSmsChannelResponse: type: object required: - SMSChannelResponse properties: SMSChannelResponse: $ref: '#/components/schemas/SMSChannelResponse' JourneyPushMessage: type: object properties: TimeToLive: allOf: - $ref: '#/components/schemas/__string' - description:The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
description: Specifies the message configuration for a push notification that's sent to participants in a journey. MapOfAttributeDimension: type: object additionalProperties: $ref: '#/components/schemas/AttributeDimension' SimpleEmailPart: type: object properties: Charset: allOf: - $ref: '#/components/schemas/__string' - description: The applicable character set for the message content. Data: allOf: - $ref: '#/components/schemas/__string' - description: The textual data of the message content. description: Specifies the subject or body of an email message, represented as textual email data and the applicable character set. SimpleEmail: type: object properties: HtmlPart: allOf: - $ref: '#/components/schemas/SimpleEmailPart' - description: The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Subject: allOf: - $ref: '#/components/schemas/SimpleEmailPart' - description: The subject line, or title, of the email. TextPart: allOf: - $ref: '#/components/schemas/SimpleEmailPart' - description: The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. description: Specifies the contents of an email message, composed of a subject, a text part, and an HTML part. MessageBody: type: object properties: Message: allOf: - $ref: '#/components/schemas/__string' - description: The message that's returned from the API. RequestID: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the request or response. description: Provides information about an API request or response. ListOfSegmentReference: type: array items: $ref: '#/components/schemas/SegmentReference' UpdateApnsVoipSandboxChannelResponse: type: object required: - APNSVoipSandboxChannelResponse properties: APNSVoipSandboxChannelResponse: $ref: '#/components/schemas/APNSVoipSandboxChannelResponse' BadRequestException: {} DefaultMessage: type: object properties: Body: allOf: - $ref: '#/components/schemas/__string' - description: The default body of the message. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The default message variables to use in the message. You can override these default variables with individual address variables. description: Specifies the default message for all channels. APNSMessage: type: object properties: APNSPushType: allOf: - $ref: '#/components/schemas/__string' - description:The type of push notification to send. Valid values are:
alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
complication - For a notification that contains update information for an app’s complication timeline.
fileprovider - For a notification that signals changes to a File Provider extension.
mdm - For a notification that tells managed devices to contact the MDM server.
voip - For a notification that provides information about an incoming VoIP call.
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:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
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.
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.
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.
The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
Title: allOf: - $ref: '#/components/schemas/__string' - description: The title to display above the notification message on the recipient's device. Url: allOf: - $ref: '#/components/schemas/__string' - description: The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. description: Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel. ListOfInAppMessageContent: type: array items: $ref: '#/components/schemas/InAppMessageContent' MethodNotAllowedException: {} SendUsersMessagesResponse: type: object required: - SendUsersMessageResponse properties: SendUsersMessageResponse: $ref: '#/components/schemas/SendUsersMessageResponse' RecencyType: type: string enum: - ACTIVE - INACTIVE GPSCoordinates: type: object required: - Latitude - Longitude properties: Latitude: allOf: - $ref: '#/components/schemas/__double' - description: The latitude coordinate of the location. Longitude: allOf: - $ref: '#/components/schemas/__double' - description: The longitude coordinate of the location. description: Specifies the GPS coordinates of a location. EndpointSendConfiguration: type: object properties: BodyOverride: allOf: - $ref: '#/components/schemas/__string' - description: The body of the message. If specified, this value overrides the default message body. Context: allOf: - $ref: '#/components/schemas/MapOf__string' - description:A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
RawContent: allOf: - $ref: '#/components/schemas/__string' - description: The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables. TitleOverride: allOf: - $ref: '#/components/schemas/__string' - description: The title or subject line of the message. If specified, this value overrides the default message title or subject line. description: Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint. DeleteApnsSandboxChannelResponse: type: object required: - APNSSandboxChannelResponse properties: APNSSandboxChannelResponse: $ref: '#/components/schemas/APNSSandboxChannelResponse' WaitTime: type: object properties: WaitFor: allOf: - $ref: '#/components/schemas/__string' - description: The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey. WaitUntil: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey. description: Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey. SMSMessageActivity: type: object properties: MessageConfig: allOf: - $ref: '#/components/schemas/JourneySMSMessage' - description: Specifies the sender ID and message type for an SMS message that's sent to participants in a journey. NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after the message is sent. TemplateName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template. TemplateVersion: allOf: - $ref: '#/components/schemas/__string' - description:The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
description: Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants. NotFoundException: {} UpdateApplicationSettingsResponse: type: object required: - ApplicationSettingsResource properties: ApplicationSettingsResource: $ref: '#/components/schemas/ApplicationSettingsResource' DirectMessageConfiguration: type: object properties: ADMMessage: allOf: - $ref: '#/components/schemas/ADMMessage' - description: The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage). APNSMessage: allOf: - $ref: '#/components/schemas/APNSMessage' - description: The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage). BaiduMessage: allOf: - $ref: '#/components/schemas/BaiduMessage' - description: The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage). DefaultMessage: allOf: - $ref: '#/components/schemas/DefaultMessage' - description: The default message for all channels. DefaultPushNotificationMessage: allOf: - $ref: '#/components/schemas/DefaultPushNotificationMessage' - description: The default push notification message for all push notification channels. EmailMessage: allOf: - $ref: '#/components/schemas/EmailMessage' - description: The default message for the email channel. This message overrides the default message (DefaultMessage). GCMMessage: allOf: - $ref: '#/components/schemas/GCMMessage' - description: The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage). SMSMessage: allOf: - $ref: '#/components/schemas/SMSMessage' - description: The default message for the SMS channel. This message overrides the default message (DefaultMessage). VoiceMessage: allOf: - $ref: '#/components/schemas/VoiceMessage' - description: The default message for the voice channel. This message overrides the default message (DefaultMessage). description: Specifies the settings and content for the default message and any default messages that you tailored for specific channels. Layout: type: string enum: - BOTTOM_BANNER - TOP_BANNER - OVERLAYS - MOBILE_FEED - MIDDLE_BANNER - CAROUSEL SetDimension: type: object required: - Values properties: DimensionType: allOf: - $ref: '#/components/schemas/DimensionType' - description: 'The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.' Values: allOf: - $ref: '#/components/schemas/ListOf__string' - description: The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values. description: Specifies the dimension type and values for a segment dimension. VoiceMessage: type: object properties: Body: allOf: - $ref: '#/components/schemas/__string' - description: The text of the script to use for the voice message. LanguageCode: allOf: - $ref: '#/components/schemas/__string' - description: The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. OriginationNumber: allOf: - $ref: '#/components/schemas/__string' - description: The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The default message variables to use in the voice message. You can override the default variables with individual address variables. VoiceId: allOf: - $ref: '#/components/schemas/__string' - description: The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide. description: Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel. Duration: type: string enum: - HR_24 - DAY_7 - DAY_14 - DAY_30 ListOfExportJobResponse: type: array items: $ref: '#/components/schemas/ExportJobResponse' ApplicationDateRangeKpiResponse: type: object required: - KpiResult - KpiName - EndTime - StartTime - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the metric applies to. EndTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. KpiName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide. KpiResult: allOf: - $ref: '#/components/schemas/BaseKpiResult' - description: An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value. NextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page. StartTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. description: Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query. MessageConfiguration: type: object properties: ADMMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message. APNSMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message. BaiduMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message. CustomMessage: allOf: - $ref: '#/components/schemas/CampaignCustomMessage' - description: 'The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
' DefaultMessage: allOf: - $ref: '#/components/schemas/Message' - description: The default message that the campaign sends through all the channels that are configured for the campaign. EmailMessage: allOf: - $ref: '#/components/schemas/CampaignEmailMessage' - description: The message that the campaign sends through the email channel. If specified, this message overrides the default message. GCMMessage: allOf: - $ref: '#/components/schemas/Message' - description: The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message. SMSMessage: allOf: - $ref: '#/components/schemas/CampaignSmsMessage' - description: The message that the campaign sends through the SMS channel. If specified, this message overrides the default message. InAppMessage: allOf: - $ref: '#/components/schemas/CampaignInAppMessage' - description: The in-app message configuration. description: Specifies the message configuration settings for a campaign. EventDimensions: type: object properties: Attributes: allOf: - $ref: '#/components/schemas/MapOfAttributeDimension' - description: One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter. EventType: allOf: - $ref: '#/components/schemas/SetDimension' - description: The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide. Metrics: allOf: - $ref: '#/components/schemas/MapOfMetricDimension' - description: One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter. description: Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed. TooManyRequestsException: {} ListOfOpenHoursRules: type: array items: allOf: - $ref: '#/components/schemas/OpenHoursRule' - description: Open Hour Rule Details. CreateExportJobResponse: type: object required: - ExportJobResponse properties: ExportJobResponse: $ref: '#/components/schemas/ExportJobResponse' UpdateSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: '#/components/schemas/SegmentResponse' ResultRow: type: object required: - GroupedBys - Values properties: GroupedBys: allOf: - $ref: '#/components/schemas/ListOfResultRowValue' - description: An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped. Values: allOf: - $ref: '#/components/schemas/ListOfResultRowValue' - description: An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey. description: Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey. JourneyDateRangeKpiResponse: type: object required: - KpiResult - KpiName - JourneyId - EndTime - StartTime - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the metric applies to. EndTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. JourneyId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the journey that the metric applies to. KpiName: allOf: - $ref: '#/components/schemas/__string' - description: The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide. KpiResult: allOf: - $ref: '#/components/schemas/BaseKpiResult' - description: An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value. NextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page. StartTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. description: Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query. RemoveAttributesResponse: type: object required: - AttributesResource properties: AttributesResource: $ref: '#/components/schemas/AttributesResource' SegmentReference: type: object required: - Id properties: Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment. Version: allOf: - $ref: '#/components/schemas/__integer' - description: The version number of the segment. description: Specifies the segment identifier and version of a segment. UpdateGcmChannelResponse: type: object required: - GCMChannelResponse properties: GCMChannelResponse: $ref: '#/components/schemas/GCMChannelResponse' DefaultButtonConfiguration: type: object required: - ButtonAction - Text properties: BackgroundColor: allOf: - $ref: '#/components/schemas/__string' - description: The background color of the button. BorderRadius: allOf: - $ref: '#/components/schemas/__integer' - description: The border radius of the button. ButtonAction: allOf: - $ref: '#/components/schemas/ButtonAction' - description: Action triggered by the button. Link: allOf: - $ref: '#/components/schemas/__string' - description: Button destination. Text: allOf: - $ref: '#/components/schemas/__string' - description: Button text. TextColor: allOf: - $ref: '#/components/schemas/__string' - description: The text color of the button. description: Default button configuration. ForbiddenException: {} SegmentBehaviors: type: object properties: Recency: allOf: - $ref: '#/components/schemas/RecencyDimension' - description: The dimension settings that are based on how recently an endpoint was active. description: Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active. ApplicationSettingsResource: type: object required: - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. CampaignHook: allOf: - $ref: '#/components/schemas/CampaignHook' - description: The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the application's settings were last modified. Limits: allOf: - $ref: '#/components/schemas/CampaignLimits' - description: The default sending limits for campaigns in the application. QuietTime: allOf: - $ref: '#/components/schemas/QuietTime' - description:The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
description: Provides information about an application, including the default settings for an application. AttributeDimension: type: object required: - Values properties: AttributeType: allOf: - $ref: '#/components/schemas/AttributeType' - description: 'The type of segment dimension to use. Valid values are: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: Specifies the name and version of the message template to use for the message. SendMessagesResponse: type: object required: - MessageResponse properties: MessageResponse: $ref: '#/components/schemas/MessageResponse' PayloadTooLargeException: {} JourneyCustomMessage: type: object properties: Data: allOf: - $ref: '#/components/schemas/__string' - description: The message content that's passed to an AWS Lambda function or to a web hook. description: Specifies the message content for a custom channel message that's sent to participants in a journey. ImportJobResponse: type: object required: - JobStatus - CreationDate - Type - Definition - Id - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that's associated with the import job. CompletedPieces: allOf: - $ref: '#/components/schemas/__integer' - description: The number of pieces that were processed successfully (completed) by the import job, as of the time of the request. CompletionDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the import job was completed. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the import job was created. Definition: allOf: - $ref: '#/components/schemas/ImportJobResource' - description: The resource settings that apply to the import job. FailedPieces: allOf: - $ref: '#/components/schemas/__integer' - description: The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request. Failures: allOf: - $ref: '#/components/schemas/ListOf__string' - description: An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the import job. JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job. TotalFailures: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred. TotalPieces: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job. TotalProcessed: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoint definitions that were processed by the import job. Type: allOf: - $ref: '#/components/schemas/__string' - description: The job type. This value is IMPORT for import jobs. description: Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console. UpdateApnsVoipChannelResponse: type: object required: - APNSVoipChannelResponse properties: APNSVoipChannelResponse: $ref: '#/components/schemas/APNSVoipChannelResponse' 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,\n UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30,\n UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02,\n UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09,\n UTC-09:30, UTC-10, and UTC-11." description: Specifies the schedule settings for a journey. SegmentResponse: type: object required: - SegmentType - CreationDate - Id - Arn - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the segment is associated with. Arn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the segment. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the segment was created. Dimensions: allOf: - $ref: '#/components/schemas/SegmentDimensions' - description: The dimension settings for the segment. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the segment. ImportDefinition: allOf: - $ref: '#/components/schemas/SegmentImportResource' - description: The settings for the import job that's associated with the segment. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time when the segment was last modified. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the segment. SegmentGroups: allOf: - $ref: '#/components/schemas/SegmentGroupList' - description: A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments. SegmentType: allOf: - $ref: '#/components/schemas/SegmentType' - description:The segment type. Valid values are:
DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
description: Provides information about the status of a campaign. ExportJobResponse: type: object required: - JobStatus - CreationDate - Type - Definition - Id - ApplicationId properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that's associated with the export job. CompletedPieces: allOf: - $ref: '#/components/schemas/__integer' - description: The number of pieces that were processed successfully (completed) by the export job, as of the time of the request. CompletionDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the export job was completed. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the export job was created. Definition: allOf: - $ref: '#/components/schemas/ExportJobResource' - description: The resource settings that apply to the export job. FailedPieces: allOf: - $ref: '#/components/schemas/__integer' - description: The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request. Failures: allOf: - $ref: '#/components/schemas/ListOf__string' - description: An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the export job. JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job. TotalFailures: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred. TotalPieces: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job. TotalProcessed: allOf: - $ref: '#/components/schemas/__integer' - description: The total number of endpoint definitions that were processed by the export job. Type: allOf: - $ref: '#/components/schemas/__string' - description: The job type. This value is EXPORT for export jobs. description: Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console. CreateSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: '#/components/schemas/SegmentResponse' 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. JourneyResponse: type: object required: - Name - Id - ApplicationId 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. ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the journey applies to. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date, in ISO 8601 format, when the journey was created. Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the journey. 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. If this value is true, the schedule uses each participant's local time. Name: allOf: - $ref: '#/components/schemas/__string' - description: The name of the journey. 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:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
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. 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 current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
Title: allOf: - $ref: '#/components/schemas/__string' - description: The title to display 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 the push notification and the value of the Action property is URL. description: Specifies the content and settings for a push notification that's sent to recipients of a campaign. JobStatus: type: string enum: - CREATED - PREPARING_FOR_INITIALIZATION - INITIALIZING - PROCESSING - PENDING_JOB - COMPLETING - COMPLETED - FAILING - FAILED DeleteVoiceChannelResponse: type: object required: - VoiceChannelResponse properties: VoiceChannelResponse: $ref: '#/components/schemas/VoiceChannelResponse' MapOfMessageResult: type: object additionalProperties: $ref: '#/components/schemas/MessageResult' GetSegmentVersionResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: '#/components/schemas/SegmentResponse' DeliveryStatus: type: string enum: - SUCCESSFUL - THROTTLED - TEMPORARY_FAILURE - PERMANENT_FAILURE - UNKNOWN_FAILURE - OPT_OUT - DUPLICATE GetApplicationSettingsResponse: type: object required: - ApplicationSettingsResource properties: ApplicationSettingsResource: $ref: '#/components/schemas/ApplicationSettingsResource' 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. Action: type: string enum: - OPEN_APP - DEEP_LINK - URL GetAppResponse: type: object required: - ApplicationResponse properties: ApplicationResponse: $ref: '#/components/schemas/ApplicationResponse' DeleteUserEndpointsResponse: type: object required: - EndpointsResponse properties: EndpointsResponse: $ref: '#/components/schemas/EndpointsResponse' CreateAppResponse: type: object required: - ApplicationResponse properties: ApplicationResponse: $ref: '#/components/schemas/ApplicationResponse' GetCampaignDateRangeKpiResponse: type: object required: - CampaignDateRangeKpiResponse properties: CampaignDateRangeKpiResponse: $ref: '#/components/schemas/CampaignDateRangeKpiResponse' 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. WriteTreatmentResource: type: object required: - SizePercent properties: CustomDeliveryConfiguration: allOf: - $ref: '#/components/schemas/CustomDeliveryConfiguration' - description: The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object. MessageConfiguration: allOf: - $ref: '#/components/schemas/MessageConfiguration' - description: The message configuration settings for the treatment. Schedule: allOf: - $ref: '#/components/schemas/Schedule' - description: The schedule settings for the treatment. SizePercent: allOf: - $ref: '#/components/schemas/__integer' - description: The allocated percentage of users (segment members) to send the treatment to. TemplateConfiguration: allOf: - $ref: '#/components/schemas/TemplateConfiguration' - description: The message template to use for the treatment. TreatmentDescription: allOf: - $ref: '#/components/schemas/__string' - description: A custom description of the treatment. TreatmentName: allOf: - $ref: '#/components/schemas/__string' - description: A custom name for the treatment. description: Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign. MapOfMetricDimension: type: object additionalProperties: $ref: '#/components/schemas/MetricDimension' ListOfMultiConditionalBranch: type: array items: $ref: '#/components/schemas/MultiConditionalBranch' Format: type: string enum: - CSV - JSON DeleteEndpointResponse: type: object required: - EndpointResponse properties: EndpointResponse: $ref: '#/components/schemas/EndpointResponse' SendOTPMessageResponse: type: object required: - MessageResponse properties: MessageResponse: $ref: '#/components/schemas/MessageResponse' DeleteEventStreamResponse: type: object required: - EventStream properties: EventStream: $ref: '#/components/schemas/EventStream' 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. Operator: type: string enum: - ALL - ANY DeleteJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: '#/components/schemas/JourneyResponse' 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. PublicEndpoint: type: object properties: Address: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the recipient, such as a device token, email address, or mobile phone number. 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. You can use these attributes as filter criteria when you create segments. ChannelType: allOf: - $ref: '#/components/schemas/ChannelType' - description: The channel that's used when sending messages or push notifications to the endpoint. Demographic: allOf: - $ref: '#/components/schemas/EndpointDemographic' - description: The demographic information for the endpoint, such as the time zone and platform. EffectiveDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the endpoint was last 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: A unique identifier that's generated each time the endpoint is updated. User: allOf: - $ref: '#/components/schemas/EndpointUser' - description: One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint. description: Specifies the properties and attributes of an endpoint that's associated with an event. 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:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
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.
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
' Id: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application. 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 user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint. description: Provides information about the channel type and other settings for an endpoint. ListOfApplicationResponse: type: array items: $ref: '#/components/schemas/ApplicationResponse' InAppMessageHeaderConfig: type: object required: - Alignment - Header - TextColor properties: Alignment: allOf: - $ref: '#/components/schemas/Alignment' - description: 'The alignment of the text. Valid values: LEFT, CENTER, RIGHT.' Header: allOf: - $ref: '#/components/schemas/__string' - description: Message Header. TextColor: allOf: - $ref: '#/components/schemas/__string' - description: The text color. description: Text config for Message Header. Alignment: type: string enum: - LEFT - CENTER - RIGHT GetJourneyResponse: type: object required: - JourneyResponse properties: JourneyResponse: $ref: '#/components/schemas/JourneyResponse' UpdateEndpointResponse: type: object required: - MessageBody properties: MessageBody: $ref: '#/components/schemas/MessageBody' DeleteCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: '#/components/schemas/CampaignResponse' 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. GetAdmChannelResponse: type: object required: - ADMChannelResponse properties: ADMChannelResponse: $ref: '#/components/schemas/ADMChannelResponse' ListOfSimpleCondition: type: array items: $ref: '#/components/schemas/SimpleCondition' 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. __blob: type: string GetApnsSandboxChannelResponse: type: object required: - APNSSandboxChannelResponse properties: APNSSandboxChannelResponse: $ref: '#/components/schemas/APNSSandboxChannelResponse' CampaignInAppMessage: type: object properties: Body: allOf: - $ref: '#/components/schemas/__string' - description: The message body of the notification, the email body or the text message. Content: allOf: - $ref: '#/components/schemas/ListOfInAppMessageContent' - description: In-app message content. CustomConfig: allOf: - $ref: '#/components/schemas/MapOf__string' - description: Custom config to be sent to client. Layout: allOf: - $ref: '#/components/schemas/Layout' - description: In-app message layout. description: In-app message configuration. GetExportJobResponse: type: object required: - ExportJobResponse properties: ExportJobResponse: $ref: '#/components/schemas/ExportJobResponse' Condition: type: object properties: Conditions: allOf: - $ref: '#/components/schemas/ListOfSimpleCondition' - description: The conditions to evaluate for the activity. Operator: allOf: - $ref: '#/components/schemas/Operator' - description: Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed. description: Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions. 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. ExportJobsResponse: type: object required: - Item properties: Item: allOf: - $ref: '#/components/schemas/ListOfExportJobResponse' - description: An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource). 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 the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file. SegmentGroup: type: object properties: Dimensions: allOf: - $ref: '#/components/schemas/ListOfSegmentDimensions' - description: An array that defines the dimensions for the segment. SourceSegments: allOf: - $ref: '#/components/schemas/ListOfSegmentReference' - description:The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
SourceType: allOf: - $ref: '#/components/schemas/SourceType' - description: Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments. Type: allOf: - $ref: '#/components/schemas/Type' - description: Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions. description: Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions. GetSegmentResponse: type: object required: - SegmentResponse properties: SegmentResponse: $ref: '#/components/schemas/SegmentResponse' ButtonAction: type: string enum: - LINK - DEEP_LINK - CLOSE ListOfEndpointBatchItem: type: array items: $ref: '#/components/schemas/EndpointBatchItem' SegmentsResponse: type: object required: - Item properties: Item: allOf: - $ref: '#/components/schemas/ListOfSegmentResponse' - description: An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource). 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 the segments that are associated with an application. SegmentLocation: type: object properties: Country: allOf: - $ref: '#/components/schemas/SetDimension' - description: The country or region code, in ISO 3166-1 alpha-2 format, for the segment. GPSPoint: allOf: - $ref: '#/components/schemas/GPSPointDimension' - description: The GPS location and range for the segment. description: Specifies geographical dimension settings for a segment. EventStartCondition: type: object properties: EventFilter: $ref: '#/components/schemas/EventFilter' SegmentId: $ref: '#/components/schemas/__string' description: Specifies the settings for an event that causes a journey activity to start. RandomSplitEntry: type: object properties: NextActivity: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the next activity to perform, after completing the activity for the path. Percentage: allOf: - $ref: '#/components/schemas/__integer' - description:The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
description: Specifies the settings for a path in a random split activity in a journey. GetSmsChannelResponse: type: object required: - SMSChannelResponse properties: SMSChannelResponse: $ref: '#/components/schemas/SMSChannelResponse' OpenHoursRule: type: object properties: StartTime: allOf: - $ref: '#/components/schemas/__string' - description: Local start time in ISO 8601 format. EndTime: allOf: - $ref: '#/components/schemas/__string' - description: Local start time in ISO 8601 format. description: List of OpenHours Rules. 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. MapOfEvent: type: object additionalProperties: $ref: '#/components/schemas/Event' EventItemResponse: type: object properties: Message: allOf: - $ref: '#/components/schemas/__string' - description: A custom message that's returned in the response as a result of processing the event. StatusCode: allOf: - $ref: '#/components/schemas/__integer' - description: 'The status code that''s returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren''t valid.' description: Provides the status code and message that result from processing an event. PutEventStreamResponse: type: object required: - EventStream properties: EventStream: $ref: '#/components/schemas/EventStream' 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. RawEmail: type: object properties: Data: allOf: - $ref: '#/components/schemas/__blob' - description: The email message, represented as a raw MIME message. The entire message must be base64 encoded. description: Specifies the contents of an email message, represented as a raw MIME message. GetCampaignResponse: type: object required: - CampaignResponse properties: CampaignResponse: $ref: '#/components/schemas/CampaignResponse' ListOfResultRow: type: array items: $ref: '#/components/schemas/ResultRow' MapOfMapOfEndpointMessageResult: type: object additionalProperties: $ref: '#/components/schemas/MapOfEndpointMessageResult' ImportJobResource: type: object required: - Format - S3Url - RoleArn properties: DefineSegment: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the import job creates 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 files are stored in an Amazon S3 location and that location contains 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 the import job registers 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://
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
Data: allOf: - $ref: '#/components/schemas/MapOf__string' - description: The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. IconReference: allOf: - $ref: '#/components/schemas/__string' - description: The icon image name of the asset saved in your app. ImageIconUrl: allOf: - $ref: '#/components/schemas/__string' - description: The URL of the large icon image to display in the content view of the push notification. ImageUrl: allOf: - $ref: '#/components/schemas/__string' - description: The URL of an image to display in the push notification. Priority: allOf: - $ref: '#/components/schemas/__string' - description:para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem>high - The notification is sent immediately and might wake a sleeping device.
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM 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. RestrictedPackageName: allOf: - $ref: '#/components/schemas/__string' - description: The package name of the application where registration tokens must match in order for the recipient to receive the message. SilentPush: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. SmallImageIconUrl: allOf: - $ref: '#/components/schemas/__string' - description: The URL of the small icon image to display in the status bar and the content view of the push notification. Sound: allOf: - $ref: '#/components/schemas/__string' - description: The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. Substitutions: allOf: - $ref: '#/components/schemas/MapOfListOf__string' - description: The default message variables to use in the notification message. You can override the default variables with individual address variables. TimeToLive: allOf: - $ref: '#/components/schemas/__integer' - description:The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
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 GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. CampaignStatus: type: string enum: - SCHEDULED - EXECUTING - PENDING_NEXT_RUN - COMPLETED - PAUSED - DELETED - INVALID MapOfEventItemResponse: type: object additionalProperties: $ref: '#/components/schemas/EventItemResponse' ListOfTreatmentResource: type: array items: $ref: '#/components/schemas/TreatmentResource' GetEventStreamResponse: type: object required: - EventStream properties: EventStream: $ref: '#/components/schemas/EventStream' GetEndpointResponse: type: object required: - EndpointResponse properties: EndpointResponse: $ref: '#/components/schemas/EndpointResponse' 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. SegmentDemographics: type: object properties: AppVersion: allOf: - $ref: '#/components/schemas/SetDimension' - description: The app version criteria for the segment. Channel: allOf: - $ref: '#/components/schemas/SetDimension' - description: The channel criteria for the segment. DeviceType: allOf: - $ref: '#/components/schemas/SetDimension' - description: The device type criteria for the segment. Make: allOf: - $ref: '#/components/schemas/SetDimension' - description: The device make criteria for the segment. Model: allOf: - $ref: '#/components/schemas/SetDimension' - description: The device model criteria for the segment. Platform: allOf: - $ref: '#/components/schemas/SetDimension' - description: The device platform criteria for the segment. description: Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model. GetAppsResponse: type: object required: - ApplicationsResponse properties: ApplicationsResponse: $ref: '#/components/schemas/ApplicationsResponse' __timestampIso8601: type: string format: date-time MapOfAddressConfiguration: type: object additionalProperties: $ref: '#/components/schemas/AddressConfiguration' SegmentImportResource: type: object required: - Format - S3Url - Size - ExternalId - RoleArn properties: ChannelCounts: allOf: - $ref: '#/components/schemas/MapOf__integer' - description: The number of channel types in the endpoint definitions that were imported to create the segment. 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 were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.' RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized 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 the endpoint definitions were imported from to create the segment. Size: allOf: - $ref: '#/components/schemas/__integer' - description: The number of endpoint definitions that were imported successfully to create the segment. description: Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions. ChannelType: type: string enum: - PUSH - GCM - APNS - APNS_SANDBOX - APNS_VOIP - APNS_VOIP_SANDBOX - ADM - SMS - VOICE - EMAIL - BAIDU - CUSTOM - IN_APP MapOf__integer: type: object additionalProperties: $ref: '#/components/schemas/__integer' 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. UpdateEmailChannelResponse: type: object required: - EmailChannelResponse properties: EmailChannelResponse: $ref: '#/components/schemas/EmailChannelResponse' EmailChannelResponse: type: object required: - Platform properties: ApplicationId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the application that the email channel applies to. ConfigurationSet: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon SES configuration set that's applied to messages that are sent through the channel. CreationDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the email channel was enabled. Enabled: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the email channel is enabled for the application. FromAddress: allOf: - $ref: '#/components/schemas/__string' - description: The verified email address that email is sent from when you send email through the channel. 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 email channel. This property is retained only for backward compatibility. Identity: allOf: - $ref: '#/components/schemas/__string' - description: 'The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that''s used when you send email through the channel.
' IsArchived: allOf: - $ref: '#/components/schemas/__boolean' - description: Specifies whether the email channel is archived. LastModifiedBy: allOf: - $ref: '#/components/schemas/__string' - description: The user who last modified the email channel. LastModifiedDate: allOf: - $ref: '#/components/schemas/__string' - description: The date and time, in ISO 8601 format, when the email channel was last modified. MessagesPerSecond: allOf: - $ref: '#/components/schemas/__integer' - description: The maximum number of emails that can be sent through the channel each second. Platform: allOf: - $ref: '#/components/schemas/__string' - description: The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL. RoleArn: allOf: - $ref: '#/components/schemas/__string' - description: 'The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
' Version: allOf: - $ref: '#/components/schemas/__integer' - description: The current version of the email channel. description: Provides information about the status and settings of the email channel for an application. 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. 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. MapOfChannelResponse: type: object additionalProperties: $ref: '#/components/schemas/ChannelResponse' InAppMessageBodyConfig: type: object required: - Alignment - TextColor - Body properties: Alignment: allOf: - $ref: '#/components/schemas/Alignment' - description: 'The alignment of the text. Valid values: LEFT, CENTER, RIGHT.' Body: allOf: - $ref: '#/components/schemas/__string' - description: Message Body. TextColor: allOf: - $ref: '#/components/schemas/__string' - description: The text color. description: Text config for Message Body. 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. MapOf__string: type: object additionalProperties: $ref: '#/components/schemas/__string' 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.
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.