openapi-directory/api/amazonaws.com/pinpoint.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2016-12-01","x-release":"v4","title":"Amazon Pinpoint","description":"Doc Engage API - Amazon Pinpoint API","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"pinpoint","x-aws-signingName":"mobiletargeting","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pinpoint-2016-12-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/pinpoint/"},"servers":[{"url":"http://pinpoint.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Pinpoint multi-region endpoint"},{"url":"https://pinpoint.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Pinpoint multi-region endpoint"},{"url":"http://pinpoint.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://pinpoint.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/v1/apps":{"post":{"operationId":"CreateApp","description":" <p>Creates an application.</p>","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 <b>Project name</b> 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."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetApps","description":"Retrieves information about all the applications that are associated with your Amazon Pinpoint account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAppsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"page-size","in":"query","required":false,"description":"The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.","schema":{"type":"string"}},{"name":"token","in":"query","required":false,"description":"The NextToken string that specifies which page of results to return in a paginated response.","schema":{"type":"string"}}]}},"/v1/apps/{application-id}/campaigns":{"post":{"operationId":"CreateCampaign","description":"Creates a new campaign for an application or updates the settings of an existing campaign for an application.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"application-id","in":"path","required":true,"description":"The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> 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":"<note><p>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html\">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href=\"https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html\">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href=\"https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html\">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(Deprecated) 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.</p>"}]},"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 <i>treatment</i> 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."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetCampaigns","description":"Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"application-id","in":"path","required":true,"description":"The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> 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"}}]}},"/v1/templates/{template-name}/email":{"post":{"operationId":"CreateEmailTemplate","description":"Creates a message template for messages that are sent through the email channel.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmailTemplateResponse"}}}},"480":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"template-name","in":"path","required":true,"description":"The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmailTemplateRequest"],"properties":{"EmailTemplateRequest":{"description":"Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.","type":"object","properties":{"DefaultSubstitutions":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values."}]},"HtmlPart":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message."}]},"RecommenderId":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data."}]},"Subject":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The subject line, or title, to use in email messages that are based on the message template."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOf__string"},{"description":"<note><p>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html\">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href=\"https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html\">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href=\"https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html\">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>"}]},"TemplateDescription":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"A custom description of the message template."}]},"TextPart":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteEmailTemplate","description":"Deletes a message template for messages that were sent through the email channel.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEmailTemplateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"template-name","in":"path","required":true,"description":"The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.","schema":{"type":"string"}},{"name":"version","in":"query","required":false,"description":"<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link  linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>","schema":{"type":"string"}}]},"get":{"operationId":"GetEmailTemplate","description":"Retrieves the content and settings of a message template for messages that are sent through the email channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEmailTemplateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"template-name","in":"path","required":true,"description":"The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.","schema":{"type":"string"}},{"name":"version","in":"query","required":false,"description":"<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link  linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>","schema":{"type":"string"}}]},"put":{"operationId":"UpdateEmailTemplate","description":"Updates an existing message template for messages that are sent through the email channel.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailTemplateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"create-new-version","in":"query","required":false,"description":"<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>","schema":{"type":"boolean"}},{"name":"template-name","in":"path","required":true,"description":"The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.","schema":{"type":"string"}},{"name":"version","in":"query","required":false,"description":"<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link  linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmailTemplateRequest"],"properties":{"EmailTemplateRequest":{"description":"Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.","type":"object","properties":{"DefaultSubstitutions":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values."}]},"HtmlPart":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message."}]},"RecommenderId":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data."}]},"Subject":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The subject line, or title, to use in email messages that are based on the message template."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOf__string"},{"description":"<note><p>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html\">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href=\"https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html\">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href=\"https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html\">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>"}]},"TemplateDescription":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"A custom description of the message template."}]},"TextPart":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices."}]}}}}}}}}}},"/v1/apps/{application-id}/jobs/export":{"post":{"operationId":"CreateExportJob","description":"Creates an export job for an application.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExportJobResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"application-id","in":"path","required":true,"description":"The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> 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://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/."}]},"SegmentId":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application."}]},"SegmentVersion":{"allOf":[{"$ref":"#/components/schemas/__integer"},{"description":"The version of the segment to export endpoint definitions from, if specified."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetExportJobs","description":"Retrieves information about the status and settings of all the export jobs for an application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExportJobsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"application-id","in":"path","required":true,"description":"The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> 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"}}]}},"/v1/apps/{application-id}/jobs/import":{"post":{"operationId":"CreateImportJob","description":"Creates an import job for an application.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportJobResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"application-id","in":"path","required":true,"description":"The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImportJobRequest"],"properties":{"ImportJobRequest":{"description":"Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.","type":"object","properties":{"DefineSegment":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"description":"Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported."}]},"ExternalId":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint."}]},"Format":{"allOf":[{"$ref":"#/components/schemas/Format"},{"description":"The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format."}]},"RegisterEndpoints":{"allOf":[{"$ref":"#/components/schemas/__boolean"},{"description":"Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported."}]},"RoleArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from."}]},"S3Url":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"<p>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.</p> <p>The URL should be in the following format: s3://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/<replaceable>file-name</replaceable>. The location can end with the key for an individual object or a prefix that qualifies multiple objects.</p>"}]},"SegmentId":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment."}]},"SegmentName":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetImportJobs","description":"Retrieves information about the status and settings of all the import jobs for an application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportJobsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"application-id","in":"path","required":true,"description":"The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> 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"}}]}},"/v1/templates/{template-name}/inapp":{"post":{"operationId":"CreateInAppTemplate","description":"Creates a new message template for messages using the in-app message channel.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInAppTemplateResponse"}}}},"480":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"template-name","in":"path","required":true,"description":"The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InAppTemplateRequest"],"properties":{"InAppTemplateRequest":{"description":"InApp Template Request.","type":"object","properties":{"Content":{"allOf":[{"$ref":"#/components/schemas/ListOfInAppMessageContent"},{"description":"The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional."}]},"CustomConfig":{"allOf":[{"$ref":"#/components/schemas/MapOf__string"},{"description":"Custom config to be sent to client."}]},"Layout":{"allOf":[{"$ref":"#/components/schemas/Layout"},{"description":"The layout of the message."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/MapOf__string"},{"description":"<note><p>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html\">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href=\"https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html\">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href=\"https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html\">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>"}]},"TemplateDescription":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The description of the template."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteInAppTemplate","description":"Deletes a message template for messages sent using the in-app message channel.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInAppTemplateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"PayloadTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"485":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"486":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"template-name","in":"path","required":true,"description":"The name of the message template. A template name must start with an alphanumeric character and can contain a maximum