openapi: 3.0.0 info: version: '2018-09-17' x-release: v4 title: AWS Marketplace Catalog Service description: '
Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace.
You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.
' 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: marketplace-catalog x-aws-signingName: aws-marketplace x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/marketplace-catalog-2018-09-17.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/marketplace/' servers: - url: 'http://catalog.marketplace.{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 AWS Marketplace Catalog multi-region endpoint - url: 'https://catalog.marketplace.{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 AWS Marketplace Catalog multi-region endpoint - url: 'http://catalog.marketplace.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Marketplace Catalog endpoint for China (Beijing) and China (Ningxia) - url: 'https://catalog.marketplace.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Marketplace Catalog endpoint for China (Beijing) and China (Ningxia) paths: /CancelChangeSet#catalog&changeSetId: patch: operationId: CancelChangeSet description: 'Used to cancel an open change request. Must be sent before the status of the request changes toAPPLYING, the final stage of completing your change request. You can describe
a change during the 60-day request history retention period for API calls.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelChangeSetResponse'
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: catalog
in: query
required: true
description: 'Required. The catalog related to the request. Fixed value: AWSMarketplace.'
schema:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
- name: changeSetId
in: query
required: true
description: Required. The unique identifier of the StartChangeSet request that you want to cancel.
schema:
type: string
pattern: '^[\w\-]+$'
minLength: 1
maxLength: 255
summary: Amazon Marketplace Cancel Change Set
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'
/DeleteResourcePolicy#resourceArn:
delete:
operationId: DeleteResourcePolicy
description: Deletes a resource-based policy on an Entity that is identified by its resource ARN.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResourcePolicyResponse'
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: resourceArn
in: query
required: true
description: The Amazon Resource Name (ARN) of the Entity resource that is associated with the resource policy.
schema:
type: string
pattern: '^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$'
minLength: 1
maxLength: 255
summary: Amazon Marketplace Delete Resource Policy
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'
/DescribeChangeSet#catalog&changeSetId:
get:
operationId: DescribeChangeSet
description: Provides information about a given change set.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeChangeSetResponse'
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: catalog
in: query
required: true
description: 'Required. The catalog related to the request. Fixed value: AWSMarketplace '
schema:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
- name: changeSetId
in: query
required: true
description: Required. The unique identifier for the StartChangeSet request that you want to describe the details for.
schema:
type: string
pattern: '^[\w\-]+$'
minLength: 1
maxLength: 255
summary: Amazon Marketplace Describe Change Set
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'
/DescribeEntity#catalog&entityId:
get:
operationId: DescribeEntity
description: Returns the metadata and content of the entity.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeEntityResponse'
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotSupportedException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: catalog
in: query
required: true
description: 'Required. The catalog related to the request. Fixed value: AWSMarketplace '
schema:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
- name: entityId
in: query
required: true
description: Required. The unique ID of the entity to describe.
schema:
type: string
pattern: '^[\w\-]+$'
minLength: 1
maxLength: 255
summary: Amazon Marketplace Describe Entity
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'
/GetResourcePolicy#resourceArn:
get:
operationId: GetResourcePolicy
description: Gets a resource-based policy of an Entity that is identified by its resource ARN.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResourcePolicyResponse'
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: resourceArn
in: query
required: true
description: The Amazon Resource Name (ARN) of the Entity resource that is associated with the resource policy.
schema:
type: string
pattern: '^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$'
minLength: 1
maxLength: 255
summary: Amazon Marketplace Get Resource Policy
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'
/ListChangeSets:
post:
operationId: ListChangeSets
description: 'Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName,
and status. If you provide more than one filter, the API operation applies a logical AND between the filters.
You can describe a change during the 60-day request history retention period for API calls.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListChangeSetsResponse' '480': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - Catalog properties: Catalog: description: 'The catalog related to the request. Fixed value:AWSMarketplace '
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
FilterList:
description: An array of filter objects.
type: array
items:
$ref: '#/components/schemas/Filter'
minItems: 1
maxItems: 8
Sort:
description: 'An object that contains two attributes, SortBy and SortOrder.'
type: object
properties:
SortBy:
allOf:
- $ref: '#/components/schemas/SortBy'
- description: 'For ListEntities, supported attributes include LastModifiedDate (default), Visibility, EntityId, and Name.
For ListChangeSets, supported attributes include StartTime and EndTime.
ASCENDING or DESCENDING. The default value is DESCENDING.
MaxResults:
description: 'The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20.'
type: integer
minimum: 1
maximum: 20
NextToken:
description: The token value retrieved from a previous call to access the next page of results.
type: string
pattern: '^[\w+=.:@\-\/]$'
minLength: 1
maxLength: 2048
summary: Amazon Marketplace List Change Sets
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'
/ListEntities:
post:
operationId: ListEntities
description: Provides the list of entities of a given type.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEntitiesResponse'
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Catalog
- EntityType
properties:
Catalog:
description: 'The catalog related to the request. Fixed value: AWSMarketplace '
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
EntityType:
description: The type of entities to retrieve.
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 255
FilterList:
description: 'An array of filter objects. Each filter object contains two attributes, filterName and filterValues.'
type: array
items:
$ref: '#/components/schemas/Filter'
minItems: 1
maxItems: 8
Sort:
description: 'An object that contains two attributes, SortBy and SortOrder.'
type: object
properties:
SortBy:
allOf:
- $ref: '#/components/schemas/SortBy'
- description: 'For ListEntities, supported attributes include LastModifiedDate (default), Visibility, EntityId, and Name.
For ListChangeSets, supported attributes include StartTime and EndTime.
ASCENDING or DESCENDING. The default value is DESCENDING.
NextToken:
description: 'The value of the next token, if it exists. Null if there are no more results.'
type: string
pattern: '^[\w+=.:@\-\/]$'
minLength: 1
maxLength: 2048
MaxResults:
description: 'Specifies the upper limit of the elements on a single page. If a value isn''t provided, the default value is 20.'
type: integer
minimum: 1
maximum: 50
OwnershipType:
description: ''
type: string
enum:
- SELF
- SHARED
summary: Amazon Marketplace List Entities
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'
/ListTagsForResource:
post:
operationId: ListTagsForResource
description: 'Lists all tags that have been added to a resource (either an entity
or change set).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ResourceArn
properties:
ResourceArn:
description: Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
type: string
pattern: '^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$'
minLength: 1
maxLength: 255
summary: Amazon Marketplace List Tags for Resource
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/PutResourcePolicy:
post:
operationId: PutResourcePolicy
description: 'Attaches a resource-based policy to an Entity. Examples of an entity include: AmiProduct and ContainerProduct.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyResponse'
'480':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ResourceArn
- Policy
properties:
ResourceArn:
description: 'The Amazon Resource Name (ARN) of the Entity resource you want to associate with a resource policy. '
type: string
pattern: '^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$'
minLength: 1
maxLength: 255
Policy:
description: The policy document to set; formatted in JSON.
type: string
pattern: '^[\u0009\u000A\u000D\u0020-\u00FF]+$'
minLength: 1
maxLength: 10240
summary: Amazon Marketplace Put Resource Policy
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'
/StartChangeSet:
post:
operationId: StartChangeSet
description: 'Allows you to request changes for your entities. Within a single ChangeSet, you can''t start the same change type against the same entity multiple times. Additionally,
when a ChangeSet is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to
start a change set containing a change against an entity that is already locked, you will receive a ResourceInUseException error.
For example, you can''t start the ChangeSet
described in the example later in this topic because it contains
two changes to run the same change type (AddRevisions) against the same entity (entity-id@1).
For more information about working with change sets, see Working with change sets. For information on change types for single-AMI products, see Working with single-AMI products. Als, for more information on change types available for container-based products, see Working with container products.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartChangeSetResponse' '480': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Catalog - ChangeSet properties: Catalog: description: 'The catalog related to the request. Fixed value:AWSMarketplace '
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
ChangeSet:
description: Array of change object.
type: array
items:
$ref: '#/components/schemas/Change'
minItems: 1
maxItems: 20
ChangeSetName:
description: 'Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets. '
type: string
pattern: '^[\w\s+=.:@-]+$'
minLength: 1
maxLength: 100
ClientRequestToken:
description: A unique token to identify the request to ensure idempotency.
type: string
pattern: '^[!-~]+$'
minLength: 1
maxLength: 64
ChangeSetTags:
description: A list of objects specifying each key name and value for the ChangeSetTags property.
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 200
summary: Amazon Marketplace Start Change Set
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'
/TagResource:
post:
operationId: TagResource
description: 'Tags a resource (either an entity or change
set).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ResourceArn
- Tags
properties:
ResourceArn:
description: Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.
type: string
pattern: '^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$'
minLength: 1
maxLength: 255
Tags:
description: 'Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.'
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 200
summary: Amazon Marketplace Tag Resource
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/UntagResource:
post:
operationId: UntagResource
description: 'Removes a tag or list of tags from a resource (either an entity or
change set).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ResourceArn
- TagKeys
properties:
ResourceArn:
description: Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
type: string
pattern: '^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$'
minLength: 1
maxLength: 255
TagKeys:
description: 'Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.'
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 1
maxItems: 200
summary: Amazon Marketplace Untag Resource
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
CancelChangeSetResponse:
type: object
properties:
ChangeSetId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The unique identifier for the change set referenced in this request.
ChangeSetArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN associated with the change set referenced in this request.
InternalServiceException: {}
AccessDeniedException: {}
ValidationException: {}
ResourceNotFoundException: {}
ResourceInUseException: {}
ThrottlingException: {}
DeleteResourcePolicyResponse:
type: object
properties: {}
DescribeChangeSetResponse:
type: object
properties:
ChangeSetId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: Required. The unique identifier for the change set referenced in this request.
ChangeSetArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN associated with the unique identifier for the change set referenced in this request.
ChangeSetName:
allOf:
- $ref: '#/components/schemas/ChangeSetName'
- description: 'The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.'
StartTime:
allOf:
- $ref: '#/components/schemas/DateTimeISO8601'
- description: 'The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started. '
EndTime:
allOf:
- $ref: '#/components/schemas/DateTimeISO8601'
- description: 'The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request
is not in a terminal state. '
Status:
allOf:
- $ref: '#/components/schemas/ChangeStatus'
- description: The status of the change request.
FailureCode:
allOf:
- $ref: '#/components/schemas/FailureCode'
- description: 'Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList),
or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.'
FailureDescription:
allOf:
- $ref: '#/components/schemas/ExceptionMessageContent'
- description: 'Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.'
ChangeSet:
allOf:
- $ref: '#/components/schemas/ChangeSetDescription'
- description: An array of ChangeSummary objects.
DescribeEntityResponse:
type: object
properties:
EntityType:
allOf:
- $ref: '#/components/schemas/EntityType'
- description: 'The named type of the entity, in the format of EntityType@Version.'
EntityIdentifier:
allOf:
- $ref: '#/components/schemas/Identifier'
- description: 'The identifier of the entity, in the format of EntityId@RevisionId.'
EntityArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN associated to the unique identifier for the entity referenced in this request.
LastModifiedDate:
allOf:
- $ref: '#/components/schemas/DateTimeISO8601'
- description: 'The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).'
Details:
allOf:
- $ref: '#/components/schemas/Json'
- description: This stringified JSON object includes the details of the entity.
ResourceNotSupportedException: {}
GetResourcePolicyResponse:
type: object
properties:
Policy:
allOf:
- $ref: '#/components/schemas/ResourcePolicyJson'
- description: The policy document to set; formatted in JSON.
ListChangeSetsResponse:
type: object
properties:
ChangeSetSummaryList:
allOf:
- $ref: '#/components/schemas/ChangeSetSummaryList'
- description: ' Array of ChangeSetSummaryListItem objects.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The value of the next token, if it exists. Null if there are no more results.'
Filter:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/FilterName'
- description: 'For ListEntities, the supported value for this is an EntityId.
For ListChangeSets, the supported values are as follows:
ListEntities - This is a list of unique EntityIds.
ListChangeSets - The supported filter names and associated ValueLists
is as follows:
ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames. These are defined when you call the
StartChangeSet action.
Status - The supported ValueList is a list of statuses for all change set requests.
EntityId
- The supported ValueList is a list of unique EntityIds.
BeforeStartTime - The supported ValueList is a list of all change
sets that started before the filter value.
AfterStartTime - The supported ValueList is a list of all change sets that started after the filter
value.
BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.
AfterEndTime
- The supported ValueList is a list of all change sets that ended after the filter value.
ListEntities and ListChangeSets actions.'
SortBy:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 255
SortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
ListEntitiesResponse:
type: object
properties:
EntitySummaryList:
allOf:
- $ref: '#/components/schemas/EntitySummaryList'
- description: ' Array of EntitySummary object.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The value of the next token if it exists. Null if there is no more result.
ListTagsForResourceResponse:
type: object
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: Required. The ARN associated with the resource you want to list tags on.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.'
PutResourcePolicyResponse:
type: object
properties: {}
StartChangeSetResponse:
type: object
properties:
ChangeSetId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: Unique identifier generated for the request.
ChangeSetArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN associated to the unique identifier generated for the request.
Change:
type: object
required:
- ChangeType
- Entity
- Details
properties:
ChangeType:
allOf:
- $ref: '#/components/schemas/ChangeType'
- description: 'Change types are single string values that describe your intention for the change. Each change type is unique for each EntityType provided in the change''s scope.
For more information on change types available for single-AMI products, see Working
with single-AMI products. Also, for more information on change types available for container-based products, see Working
with container products.'
Entity:
allOf:
- $ref: '#/components/schemas/Entity'
- description: The entity to be changed.
EntityTags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags associated with the change.
Details:
allOf:
- $ref: '#/components/schemas/Json'
- description: 'This object contains details specific to the change type of the requested change. For more information on change types available for single-AMI products, see Working
with single-AMI products. Also, for more information on change types available for container-based products, see Working
with container products.'
ChangeName:
allOf:
- $ref: '#/components/schemas/ChangeName'
- description: Optional name for the change.
description: 'An object that contains the ChangeType, Details, and Entity.'
Tag:
type: object
required:
- Key
- Value
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The key associated with the tag.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The value associated with the tag.
description: A list of objects specifying each key name and value.
ServiceQuotaExceededException: {}
TagResourceResponse:
type: object
properties: {}
UntagResourceResponse:
type: object
properties: {}
TagKey:
type: string
pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$'
minLength: 1
maxLength: 128
ARN:
type: string
pattern: '^[a-zA-Z0-9:*/-]+$'
minLength: 1
maxLength: 2048
Catalog:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
ResourceId:
type: string
pattern: '^[\w\-]+$'
minLength: 1
maxLength: 255
CancelChangeSetRequest:
type: object
title: CancelChangeSetRequest
properties: {}
ChangeType:
type: string
pattern: '^[A-Z][\w]*$'
minLength: 1
maxLength: 255
Entity:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/EntityType'
- description: The type of entity.
Identifier:
allOf:
- $ref: '#/components/schemas/Identifier'
- description: The identifier for the entity.
description: 'An entity contains data that describes your product, its supported features, and how it can be used or launched by your customer. '
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 200
Json:
type: string
pattern: '^[\s]*\{[\s\S]*\}[\s]*$'
minLength: 2
maxLength: 16384
ChangeName:
type: string
pattern: '^[a-zA-Z]$'
minLength: 1
maxLength: 72
ChangeSummary:
type: object
properties:
ChangeType:
allOf:
- $ref: '#/components/schemas/ChangeType'
- description: The type of the change.
Entity:
allOf:
- $ref: '#/components/schemas/Entity'
- description: The entity to be changed.
Details:
allOf:
- $ref: '#/components/schemas/Json'
- description: This object contains details specific to the change type of the requested change.
ErrorDetailList:
allOf:
- $ref: '#/components/schemas/ErrorDetailList'
- description: An array of ErrorDetail objects associated with the change.
ChangeName:
allOf:
- $ref: '#/components/schemas/ChangeName'
- description: Optional name for the change.
description: This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.
ChangeSetDescription:
type: array
items:
$ref: '#/components/schemas/ChangeSummary'
ChangeSetName:
type: string
pattern: '^[\w\s+=.:@-]+$'
minLength: 1
maxLength: 100
ChangeSetSummaryListItem:
type: object
properties:
ChangeSetId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The unique identifier for a change set.
ChangeSetArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN associated with the unique identifier for the change set referenced in this request.
ChangeSetName:
allOf:
- $ref: '#/components/schemas/ChangeSetName'
- description: The non-unique name for the change set.
StartTime:
allOf:
- $ref: '#/components/schemas/DateTimeISO8601'
- description: 'The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.'
EndTime:
allOf:
- $ref: '#/components/schemas/DateTimeISO8601'
- description: 'The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.'
Status:
allOf:
- $ref: '#/components/schemas/ChangeStatus'
- description: The current status of the change set.
EntityIdList:
allOf:
- $ref: '#/components/schemas/ResourceIdList'
- description: This object is a list of entity IDs (string) that are a part of a change set. The entity ID list is a maximum of 20 entities. It must contain at least one entity.
FailureCode:
allOf:
- $ref: '#/components/schemas/FailureCode'
- description: 'Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList
of DescribeChangeSet), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.'
description: A summary of a change set returned in a list of change sets when the ListChangeSets action is called.
ChangeSetSummaryList:
type: array
items:
$ref: '#/components/schemas/ChangeSetSummaryListItem'
DateTimeISO8601:
type: string
pattern: '^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$'
minLength: 20
maxLength: 20
ChangeStatus:
type: string
enum:
- PREPARING
- APPLYING
- SUCCEEDED
- CANCELLED
- FAILED
ResourceIdList:
type: array
items:
$ref: '#/components/schemas/ResourceId'
FailureCode:
type: string
enum:
- CLIENT_ERROR
- SERVER_FAULT
ErrorDetailList:
type: array
items:
$ref: '#/components/schemas/ErrorDetail'
ClientRequestToken:
type: string
pattern: '^[!-~]+$'
minLength: 1
maxLength: 64
ResourceARN:
type: string
pattern: '^arn:[\w+=/,.@-]+:aws-marketplace:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*$'
minLength: 1
maxLength: 255
DeleteResourcePolicyRequest:
type: object
title: DeleteResourcePolicyRequest
properties: {}
DescribeChangeSetRequest:
type: object
title: DescribeChangeSetRequest
properties: {}
ExceptionMessageContent:
type: string
pattern: ^(.)+$
minLength: 1
maxLength: 2048
DescribeEntityRequest:
type: object
title: DescribeEntityRequest
properties: {}
EntityType:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 255
Identifier:
type: string
pattern: '^[\w\-@]+$'
minLength: 1
maxLength: 255
EntityNameString:
type: string
pattern: '^\\S+[\\S\\s]*'
minLength: 1
maxLength: 255
VisibilityValue:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 64
EntitySummary:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/EntityNameString'
- description: The name for the entity. This value is not unique. It is defined by the seller.
EntityType:
allOf:
- $ref: '#/components/schemas/EntityType'
- description: The type of the entity.
EntityId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The unique identifier for the entity.
EntityArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN associated with the unique identifier for the entity.
LastModifiedDate:
allOf:
- $ref: '#/components/schemas/DateTimeISO8601'
- description: 'The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).'
Visibility:
allOf:
- $ref: '#/components/schemas/VisibilityValue'
- description: 'The visibility status of the entity to buyers. This value can be Public (everyone can view the entity), Limited (the entity is visible to limited accounts
only), or Restricted (the entity was published and then unpublished and only existing buyers can view it). '
description: 'This object is a container for common summary information about the entity. The summary doesn''t contain the whole entity structure, but it does contain information common across all
entities.'
EntitySummaryList:
type: array
items:
$ref: '#/components/schemas/EntitySummary'
ErrorCodeString:
type: string
pattern: '^[a-zA-Z_]+$'
minLength: 1
maxLength: 72
ErrorDetail:
type: object
properties:
ErrorCode:
allOf:
- $ref: '#/components/schemas/ErrorCodeString'
- description: The error code that identifies the type of error.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/ExceptionMessageContent'
- description: The message for the error.
description: Details about the error.
FilterName:
type: string
pattern: '^[a-zA-Z]+$'
minLength: 1
maxLength: 255
ValueList:
type: array
items:
$ref: '#/components/schemas/FilterValueContent'
minItems: 1
maxItems: 10
FilterList:
type: array
items:
$ref: '#/components/schemas/Filter'
minItems: 1
maxItems: 8
FilterValueContent:
type: string
pattern: ^(.)+$
minLength: 1
maxLength: 255
GetResourcePolicyRequest:
type: object
title: GetResourcePolicyRequest
properties: {}
ResourcePolicyJson:
type: string
pattern: '^[\u0009\u000A\u000D\u0020-\u00FF]+$'
minLength: 1
maxLength: 10240
ListChangeSetsMaxResultInteger:
type: integer
minimum: 1
maximum: 20
Sort:
type: object
properties:
SortBy:
allOf:
- $ref: '#/components/schemas/SortBy'
- description: 'For ListEntities, supported attributes include LastModifiedDate (default), Visibility, EntityId, and Name.
For ListChangeSets, supported attributes include StartTime and EndTime.
ASCENDING or DESCENDING. The default value is DESCENDING.
description: 'An object that contains two attributes, SortBy and SortOrder.'
NextToken:
type: string
pattern: '^[\w+=.:@\-\/]$'
minLength: 1
maxLength: 2048
ListChangeSetsRequest:
type: object
required:
- Catalog
title: ListChangeSetsRequest
properties:
Catalog:
allOf:
- $ref: '#/components/schemas/Catalog'
- description: 'The catalog related to the request. Fixed value: AWSMarketplace '
FilterList:
allOf:
- $ref: '#/components/schemas/FilterList'
- description: An array of filter objects.
Sort:
allOf:
- $ref: '#/components/schemas/Sort'
- description: 'An object that contains two attributes, SortBy and SortOrder.'
MaxResults:
allOf:
- $ref: '#/components/schemas/ListChangeSetsMaxResultInteger'
- description: 'The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token value retrieved from a previous call to access the next page of results.
ListEntitiesMaxResultInteger:
type: integer
minimum: 1
maximum: 50
OwnershipType:
type: string
enum:
- SELF
- SHARED
ListEntitiesRequest:
type: object
required:
- Catalog
- EntityType
title: ListEntitiesRequest
properties:
Catalog:
allOf:
- $ref: '#/components/schemas/Catalog'
- description: 'The catalog related to the request. Fixed value: AWSMarketplace '
EntityType:
allOf:
- $ref: '#/components/schemas/EntityType'
- description: The type of entities to retrieve.
FilterList:
allOf:
- $ref: '#/components/schemas/FilterList'
- description: 'An array of filter objects. Each filter object contains two attributes, filterName and filterValues.'
Sort:
allOf:
- $ref: '#/components/schemas/Sort'
- description: 'An object that contains two attributes, SortBy and SortOrder.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The value of the next token, if it exists. Null if there are no more results.'
MaxResults:
allOf:
- $ref: '#/components/schemas/ListEntitiesMaxResultInteger'
- description: 'Specifies the upper limit of the elements on a single page. If a value isn''t provided, the default value is 20.'
OwnershipType:
$ref: '#/components/schemas/OwnershipType'
ListTagsForResourceRequest:
type: object
required:
- ResourceArn
title: ListTagsForResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
PutResourcePolicyRequest:
type: object
required:
- ResourceArn
- Policy
title: PutResourcePolicyRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: 'The Amazon Resource Name (ARN) of the Entity resource you want to associate with a resource policy. '
Policy:
allOf:
- $ref: '#/components/schemas/ResourcePolicyJson'
- description: The policy document to set; formatted in JSON.
RequestedChangeList:
type: array
items:
$ref: '#/components/schemas/Change'
minItems: 1
maxItems: 20
StartChangeSetRequest:
type: object
required:
- Catalog
- ChangeSet
title: StartChangeSetRequest
properties:
Catalog:
allOf:
- $ref: '#/components/schemas/Catalog'
- description: 'The catalog related to the request. Fixed value: AWSMarketplace '
ChangeSet:
allOf:
- $ref: '#/components/schemas/RequestedChangeList'
- description: Array of change object.
ChangeSetName:
allOf:
- $ref: '#/components/schemas/ChangeSetName'
- description: 'Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets. '
ClientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: A unique token to identify the request to ensure idempotency.
ChangeSetTags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of objects specifying each key name and value for the ChangeSetTags property.
TagValue:
type: string
pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$'
minLength: 0
maxLength: 256
TagKeyList:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 1
maxItems: 200
TagResourceRequest:
type: object
required:
- ResourceArn
- Tags
title: TagResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.'
UntagResourceRequest:
type: object
required:
- ResourceArn
- TagKeys
title: UntagResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
TagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: 'Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.'
security:
- hmac: []