{ "version": "2.0", "metadata": { "apiVersion": "2018-09-17", "endpointPrefix": "catalog.marketplace", "jsonVersion": "1.1", "protocol": "rest-json", "serviceAbbreviation": "AWS Marketplace Catalog", "serviceFullName": "AWS Marketplace Catalog Service", "serviceId": "Marketplace Catalog", "signatureVersion": "v4", "signingName": "aws-marketplace", "uid": "marketplace-catalog-2018-09-17" }, "operations": { "BatchDescribeEntities": { "name": "BatchDescribeEntities", "http": { "method": "POST", "requestUri": "/BatchDescribeEntities" }, "input": { "shape": "BatchDescribeEntitiesRequest" }, "output": { "shape": "BatchDescribeEntitiesResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServiceException" }, { "shape": "ThrottlingException" }, { "shape": "ValidationException" } ], "documentation": "
Returns metadata and content for multiple entities. This is the Batch version of the DescribeEntity
API and uses the same IAM permission action as DescribeEntity
API.
Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING
, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.
Deletes a resource-based policy on an entity that is identified by its resource ARN.
" }, "DescribeChangeSet": { "name": "DescribeChangeSet", "http": { "method": "GET", "requestUri": "/DescribeChangeSet" }, "input": { "shape": "DescribeChangeSetRequest" }, "output": { "shape": "DescribeChangeSetResponse" }, "errors": [ { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "Provides information about a given change set.
" }, "DescribeEntity": { "name": "DescribeEntity", "http": { "method": "GET", "requestUri": "/DescribeEntity" }, "input": { "shape": "DescribeEntityRequest" }, "output": { "shape": "DescribeEntityResponse" }, "errors": [ { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotSupportedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "Returns the metadata and content of the entity.
" }, "GetResourcePolicy": { "name": "GetResourcePolicy", "http": { "method": "GET", "requestUri": "/GetResourcePolicy" }, "input": { "shape": "GetResourcePolicyRequest" }, "output": { "shape": "GetResourcePolicyResponse" }, "errors": [ { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "Gets a resource-based policy of an entity that is identified by its resource ARN.
" }, "ListChangeSets": { "name": "ListChangeSets", "http": { "method": "POST", "requestUri": "/ListChangeSets" }, "input": { "shape": "ListChangeSetsRequest" }, "output": { "shape": "ListChangeSetsResponse" }, "errors": [ { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ThrottlingException" } ], "documentation": "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.
" }, "ListEntities": { "name": "ListEntities", "http": { "method": "POST", "requestUri": "/ListEntities" }, "input": { "shape": "ListEntitiesRequest" }, "output": { "shape": "ListEntitiesResponse" }, "errors": [ { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "Provides the list of entities of a given type.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/ListTagsForResource" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ThrottlingException" } ], "documentation": "Lists all tags that have been added to a resource (either an entity or change set).
" }, "PutResourcePolicy": { "name": "PutResourcePolicy", "http": { "method": "POST", "requestUri": "/PutResourcePolicy" }, "input": { "shape": "PutResourcePolicyRequest" }, "output": { "shape": "PutResourcePolicyResponse" }, "errors": [ { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct
and ContainerProduct
.
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 about change types for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/TagResource" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ThrottlingException" } ], "documentation": "Tags a resource (either an entity or change set).
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/UntagResource" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServiceException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ThrottlingException" } ], "documentation": "Removes a tag or list of tags from a resource (either an entity or change set).
" } }, "shapes": { "ARN": { "type": "string", "max": 2048, "min": 1, "pattern": "^[a-zA-Z0-9:*/-]+$" }, "AmiProductEntityIdFilter": { "type": "structure", "members": { "ValueList": { "shape": "AmiProductEntityIdFilterValueList", "documentation": "A string array of unique entity id values to be filtered on.
" } }, "documentation": "Object that allows filtering on entity id of an AMI product.
" }, "AmiProductEntityIdFilterValueList": { "type": "list", "member": { "shape": "AmiProductEntityIdString" }, "max": 10, "min": 1 }, "AmiProductEntityIdString": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" }, "AmiProductFilters": { "type": "structure", "members": { "EntityId": { "shape": "AmiProductEntityIdFilter", "documentation": "Unique identifier for the AMI product.
" }, "LastModifiedDate": { "shape": "AmiProductLastModifiedDateFilter", "documentation": "The last date on which the AMI product was modified.
" }, "ProductTitle": { "shape": "AmiProductTitleFilter", "documentation": "The title of the AMI product.
" }, "Visibility": { "shape": "AmiProductVisibilityFilter", "documentation": "The visibility of the AMI product.
" } }, "documentation": "Object containing all the filter fields for AMI products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities
request.
Dates between which the AMI product was last modified.
" } }, "documentation": "Object that allows filtering based on the last modified date of AMI products.
" }, "AmiProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "shape": "DateTimeISO8601", "documentation": "Date after which the AMI product was last modified.
" }, "BeforeValue": { "shape": "DateTimeISO8601", "documentation": "Date before which the AMI product was last modified.
" } }, "documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue
and/or AfterValue
. Both are inclusive.
Field to sort the AMI products by.
" }, "SortOrder": { "shape": "SortOrder", "documentation": "The sorting order. Can be ASCENDING
or DESCENDING
. The default value is DESCENDING
.
Objects that allows sorting on AMI products based on certain fields and sorting order.
" }, "AmiProductSortBy": { "type": "string", "enum": [ "EntityId", "LastModifiedDate", "ProductTitle", "Visibility" ] }, "AmiProductSummary": { "type": "structure", "members": { "ProductTitle": { "shape": "AmiProductTitleString", "documentation": "The title of the AMI product.
" }, "Visibility": { "shape": "AmiProductVisibilityString", "documentation": "The lifecycle of the AMI product.
" } }, "documentation": "Object that contains summarized information about an AMI product.
" }, "AmiProductTitleFilter": { "type": "structure", "members": { "ValueList": { "shape": "AmiProductTitleFilterValueList", "documentation": "A string array of unique product title values to be filtered on.
" }, "WildCardValue": { "shape": "AmiProductTitleString", "documentation": "A string that will be the wildCard
input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on product title.
" }, "AmiProductTitleFilterValueList": { "type": "list", "member": { "shape": "AmiProductTitleString" }, "max": 10, "min": 1 }, "AmiProductTitleString": { "type": "string", "max": 255, "min": 1, "pattern": "^(.)+$" }, "AmiProductVisibilityFilter": { "type": "structure", "members": { "ValueList": { "shape": "AmiProductVisibilityFilterValueList", "documentation": "A string array of unique visibility values to be filtered on.
" } }, "documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" }, "AmiProductVisibilityFilterValueList": { "type": "list", "member": { "shape": "AmiProductVisibilityString" }, "max": 10, "min": 1 }, "AmiProductVisibilityString": { "type": "string", "enum": [ "Limited", "Public", "Restricted", "Draft" ] }, "BatchDescribeEntitiesRequest": { "type": "structure", "required": [ "EntityRequestList" ], "members": { "EntityRequestList": { "shape": "EntityRequestList", "documentation": "List of entity IDs and the catalogs the entities are present in.
" } } }, "BatchDescribeEntitiesResponse": { "type": "structure", "members": { "EntityDetails": { "shape": "EntityDetails", "documentation": "Details about each entity.
" }, "Errors": { "shape": "Errors", "documentation": "A map of errors returned, with EntityId
as the key and errorDetail
as the value.
The error code returned.
" }, "ErrorMessage": { "shape": "BatchDescribeErrorMessageContent", "documentation": "The error message returned.
" } }, "documentation": "An object that contains an error code and error message.
" }, "BatchDescribeErrorMessageContent": { "type": "string", "max": 2048, "min": 1, "pattern": "^(.)+$" }, "CancelChangeSetRequest": { "type": "structure", "required": [ "Catalog", "ChangeSetId" ], "members": { "Catalog": { "shape": "Catalog", "documentation": "Required. The catalog related to the request. Fixed value: AWSMarketplace
.
Required. The unique identifier of the StartChangeSet
request that you want to cancel.
The unique identifier for the change set referenced in this request.
" }, "ChangeSetArn": { "shape": "ARN", "documentation": "The ARN associated with the change set referenced in this request.
" } } }, "Catalog": { "type": "string", "max": 64, "min": 1, "pattern": "^[a-zA-Z]+$" }, "Change": { "type": "structure", "required": [ "ChangeType", "Entity" ], "members": { "ChangeType": { "shape": "ChangeType", "documentation": "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 about change types available for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.
The entity to be changed.
" }, "EntityTags": { "shape": "TagList", "documentation": "The tags associated with the change.
" }, "Details": { "shape": "Json", "documentation": "This object contains details specific to the change type of the requested change. For more information about change types available for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.
" }, "DetailsDocument": { "shape": "JsonDocumentType", "documentation": "Alternative field that accepts a JSON value instead of a string for ChangeType
details. You can use either Details
or DetailsDocument
, but not both.
Optional name for the change.
" } }, "documentation": "An object that contains the ChangeType
, Details
, and Entity
.
The unique identifier for a change set.
" }, "ChangeSetArn": { "shape": "ARN", "documentation": "The ARN associated with the unique identifier for the change set referenced in this request.
" }, "ChangeSetName": { "shape": "ChangeSetName", "documentation": "The non-unique name for the change set.
" }, "StartTime": { "shape": "DateTimeISO8601", "documentation": "The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
" }, "EndTime": { "shape": "DateTimeISO8601", "documentation": "The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
" }, "Status": { "shape": "ChangeStatus", "documentation": "The current status of the change set.
" }, "EntityIdList": { "shape": "ResourceIdList", "documentation": "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": { "shape": "FailureCode", "documentation": "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.
A summary of a change set returned in a list of change sets when the ListChangeSets
action is called.
The type of the change.
" }, "Entity": { "shape": "Entity", "documentation": "The entity to be changed.
" }, "Details": { "shape": "Json", "documentation": "This object contains details specific to the change type of the requested change.
" }, "DetailsDocument": { "shape": "JsonDocumentType", "documentation": "The JSON value of the details specific to the change type of the requested change.
" }, "ErrorDetailList": { "shape": "ErrorDetailList", "documentation": "An array of ErrorDetail
objects associated with the change.
Optional name for the change.
" } }, "documentation": "This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.
" }, "ChangeType": { "type": "string", "max": 255, "min": 1, "pattern": "^[A-Z][\\w]*$" }, "ClientRequestToken": { "type": "string", "max": 64, "min": 1, "pattern": "^[!-~]+$" }, "ContainerProductEntityIdFilter": { "type": "structure", "members": { "ValueList": { "shape": "ContainerProductEntityIdFilterValueList", "documentation": "A string array of unique entity id values to be filtered on.
" } }, "documentation": "Object that allows filtering on entity id of a container product.
" }, "ContainerProductEntityIdFilterValueList": { "type": "list", "member": { "shape": "ContainerProductEntityIdString" }, "max": 10, "min": 1 }, "ContainerProductEntityIdString": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" }, "ContainerProductFilters": { "type": "structure", "members": { "EntityId": { "shape": "ContainerProductEntityIdFilter", "documentation": "Unique identifier for the container product.
" }, "LastModifiedDate": { "shape": "ContainerProductLastModifiedDateFilter", "documentation": "The last date on which the container product was modified.
" }, "ProductTitle": { "shape": "ContainerProductTitleFilter", "documentation": "The title of the container product.
" }, "Visibility": { "shape": "ContainerProductVisibilityFilter", "documentation": "The visibility of the container product.
" } }, "documentation": "Object containing all the filter fields for container products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities
request.
Dates between which the container product was last modified.
" } }, "documentation": "Object that allows filtering based on the last modified date of container products.
" }, "ContainerProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "shape": "DateTimeISO8601", "documentation": "Date after which the container product was last modified.
" }, "BeforeValue": { "shape": "DateTimeISO8601", "documentation": "Date before which the container product was last modified.
" } }, "documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue
and/or AfterValue
. Both are inclusive.
Field to sort the container products by.
" }, "SortOrder": { "shape": "SortOrder", "documentation": "The sorting order. Can be ASCENDING
or DESCENDING
. The default value is DESCENDING
.
Objects that allows sorting on container products based on certain fields and sorting order.
" }, "ContainerProductSortBy": { "type": "string", "enum": [ "EntityId", "LastModifiedDate", "ProductTitle", "Visibility" ] }, "ContainerProductSummary": { "type": "structure", "members": { "ProductTitle": { "shape": "ContainerProductTitleString", "documentation": "The title of the container product.
" }, "Visibility": { "shape": "ContainerProductVisibilityString", "documentation": "The lifecycle of the product.
" } }, "documentation": "Object that contains summarized information about a container product.
" }, "ContainerProductTitleFilter": { "type": "structure", "members": { "ValueList": { "shape": "ContainerProductTitleFilterValueList", "documentation": "A string array of unique product title values to be filtered on.
" }, "WildCardValue": { "shape": "ContainerProductTitleString", "documentation": "A string that will be the wildCard
input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on product title.
" }, "ContainerProductTitleFilterValueList": { "type": "list", "member": { "shape": "ContainerProductTitleString" }, "max": 10, "min": 1 }, "ContainerProductTitleString": { "type": "string", "max": 255, "min": 1, "pattern": "^(.)+$" }, "ContainerProductVisibilityFilter": { "type": "structure", "members": { "ValueList": { "shape": "ContainerProductVisibilityFilterValueList", "documentation": "A string array of unique visibility values to be filtered on.
" } }, "documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" }, "ContainerProductVisibilityFilterValueList": { "type": "list", "member": { "shape": "ContainerProductVisibilityString" }, "max": 10, "min": 1 }, "ContainerProductVisibilityString": { "type": "string", "enum": [ "Limited", "Public", "Restricted", "Draft" ] }, "DataProductEntityIdFilter": { "type": "structure", "members": { "ValueList": { "shape": "DataProductEntityIdFilterValueList", "documentation": "A string array of unique entity id values to be filtered on.
" } }, "documentation": "Object that allows filtering on entity id of a data product.
" }, "DataProductEntityIdFilterValueList": { "type": "list", "member": { "shape": "DataProductEntityIdString" }, "max": 10, "min": 1 }, "DataProductEntityIdString": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" }, "DataProductFilters": { "type": "structure", "members": { "EntityId": { "shape": "DataProductEntityIdFilter", "documentation": "Unique identifier for the data product.
" }, "ProductTitle": { "shape": "DataProductTitleFilter", "documentation": "The title of the data product.
" }, "Visibility": { "shape": "DataProductVisibilityFilter", "documentation": "The visibility of the data product.
" }, "LastModifiedDate": { "shape": "DataProductLastModifiedDateFilter", "documentation": "The last date on which the data product was modified.
" } }, "documentation": "Object containing all the filter fields for data products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities
request.
Dates between which the data product was last modified.
" } }, "documentation": "Object that allows filtering based on the last modified date of data products.
" }, "DataProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "shape": "DateTimeISO8601", "documentation": "Date after which the data product was last modified.
" }, "BeforeValue": { "shape": "DateTimeISO8601", "documentation": "Date before which the data product was last modified.
" } }, "documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue
and/or AfterValue
. Both are inclusive.
Field to sort the data products by.
" }, "SortOrder": { "shape": "SortOrder", "documentation": "The sorting order. Can be ASCENDING
or DESCENDING
. The default value is DESCENDING
.
Objects that allows sorting on data products based on certain fields and sorting order.
" }, "DataProductSortBy": { "type": "string", "enum": [ "EntityId", "ProductTitle", "Visibility", "LastModifiedDate" ] }, "DataProductSummary": { "type": "structure", "members": { "ProductTitle": { "shape": "DataProductTitleString", "documentation": "The title of the data product.
" }, "Visibility": { "shape": "DataProductVisibilityString", "documentation": "The lifecycle of the data product.
" } }, "documentation": "Object that contains summarized information about a data product.
" }, "DataProductTitleFilter": { "type": "structure", "members": { "ValueList": { "shape": "DataProductTitleFilterValueList", "documentation": "A string array of unique product title values to be filtered on.
" }, "WildCardValue": { "shape": "DataProductTitleString", "documentation": "A string that will be the wildCard
input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on product title.
" }, "DataProductTitleFilterValueList": { "type": "list", "member": { "shape": "DataProductTitleString" }, "max": 10, "min": 1 }, "DataProductTitleString": { "type": "string", "max": 255, "min": 1, "pattern": "^(.)+$" }, "DataProductVisibilityFilter": { "type": "structure", "members": { "ValueList": { "shape": "DataProductVisibilityFilterValueList", "documentation": "A string array of unique visibility values to be filtered on.
" } }, "documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" }, "DataProductVisibilityFilterValueList": { "type": "list", "member": { "shape": "DataProductVisibilityString" }, "max": 10, "min": 1 }, "DataProductVisibilityString": { "type": "string", "enum": [ "Limited", "Public", "Restricted", "Unavailable", "Draft" ] }, "DateTimeISO8601": { "type": "string", "max": 20, "min": 20, "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$" }, "DeleteResourcePolicyRequest": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ResourceARN", "documentation": "The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.
", "location": "querystring", "locationName": "resourceArn" } } }, "DeleteResourcePolicyResponse": { "type": "structure", "members": {} }, "DescribeChangeSetRequest": { "type": "structure", "required": [ "Catalog", "ChangeSetId" ], "members": { "Catalog": { "shape": "Catalog", "documentation": "Required. The catalog related to the request. Fixed value: AWSMarketplace
Required. The unique identifier for the StartChangeSet
request that you want to describe the details for.
Required. The unique identifier for the change set referenced in this request.
" }, "ChangeSetArn": { "shape": "ARN", "documentation": "The ARN associated with the unique identifier for the change set referenced in this request.
" }, "ChangeSetName": { "shape": "ChangeSetName", "documentation": "The optional name provided in the StartChangeSet
request. If you do not provide a name, one is set by default.
The optional intent provided in the StartChangeSet
request. If you do not provide an intent, APPLY
is set by default.
The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.
" }, "EndTime": { "shape": "DateTimeISO8601", "documentation": "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": { "shape": "ChangeStatus", "documentation": "The status of the change request.
" }, "FailureCode": { "shape": "FailureCode", "documentation": "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.
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": { "shape": "ChangeSetDescription", "documentation": "An array of ChangeSummary
objects.
Required. The catalog related to the request. Fixed value: AWSMarketplace
Required. The unique ID of the entity to describe.
", "location": "querystring", "locationName": "entityId" } } }, "DescribeEntityResponse": { "type": "structure", "members": { "EntityType": { "shape": "EntityType", "documentation": "The named type of the entity, in the format of EntityType@Version
.
The identifier of the entity, in the format of EntityId@RevisionId
.
The ARN associated to the unique identifier for the entity referenced in this request.
" }, "LastModifiedDate": { "shape": "DateTimeISO8601", "documentation": "The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
" }, "Details": { "shape": "Json", "documentation": "This stringified JSON object includes the details of the entity.
" }, "DetailsDocument": { "shape": "JsonDocumentType", "documentation": "The JSON value of the details specific to the entity.
" } } }, "Entity": { "type": "structure", "required": [ "Type" ], "members": { "Type": { "shape": "EntityType", "documentation": "The type of entity.
" }, "Identifier": { "shape": "Identifier", "documentation": "The identifier for the entity.
" } }, "documentation": "An entity contains data that describes your product, its supported features, and how it can be used or launched by your customer.
" }, "EntityDetail": { "type": "structure", "members": { "EntityType": { "shape": "EntityType", "documentation": "The entity type of the entity, in the format of EntityType@Version
.
The Amazon Resource Name (ARN) of the entity.
" }, "EntityIdentifier": { "shape": "Identifier", "documentation": "The ID of the entity, in the format of EntityId@RevisionId
.
The last time the entity was modified.
" }, "DetailsDocument": { "shape": "JsonDocumentType", "documentation": "An object that contains all the details of the entity.
" } }, "documentation": "An object that contains metadata and details about the entity.
" }, "EntityDetails": { "type": "map", "key": { "shape": "EntityId" }, "value": { "shape": "EntityDetail" } }, "EntityId": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" }, "EntityNameString": { "type": "string", "max": 255, "min": 1, "pattern": "^\\\\S+[\\\\S\\\\s]*" }, "EntityRequest": { "type": "structure", "required": [ "Catalog", "EntityId" ], "members": { "Catalog": { "shape": "Catalog", "documentation": "The name of the catalog the entity is present in. The only value at this time is AWSMarketplace
.
The ID of the entity.
" } }, "documentation": "An object that contains entity ID and the catalog in which the entity is present.
" }, "EntityRequestList": { "type": "list", "member": { "shape": "EntityRequest" }, "max": 20, "min": 1 }, "EntitySummary": { "type": "structure", "members": { "Name": { "shape": "EntityNameString", "documentation": "The name for the entity. This value is not unique. It is defined by the seller.
" }, "EntityType": { "shape": "EntityType", "documentation": "The type of the entity.
" }, "EntityId": { "shape": "ResourceId", "documentation": "The unique identifier for the entity.
" }, "EntityArn": { "shape": "ARN", "documentation": "The ARN associated with the unique identifier for the entity.
" }, "LastModifiedDate": { "shape": "DateTimeISO8601", "documentation": "The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
" }, "Visibility": { "shape": "VisibilityValue", "documentation": "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).
An object that contains summary information about the AMI product.
" }, "ContainerProductSummary": { "shape": "ContainerProductSummary", "documentation": "An object that contains summary information about the container product.
" }, "DataProductSummary": { "shape": "DataProductSummary", "documentation": "An object that contains summary information about the data product.
" }, "SaaSProductSummary": { "shape": "SaaSProductSummary", "documentation": "An object that contains summary information about the SaaS product.
" }, "OfferSummary": { "shape": "OfferSummary", "documentation": "An object that contains summary information about the offer.
" }, "ResaleAuthorizationSummary": { "shape": "ResaleAuthorizationSummary", "documentation": "An object that contains summary information about the Resale Authorization.
" } }, "documentation": "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": "list", "member": { "shape": "EntitySummary" } }, "EntityType": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z]+$" }, "EntityTypeFilters": { "type": "structure", "members": { "DataProductFilters": { "shape": "DataProductFilters", "documentation": "A filter for data products.
" }, "SaaSProductFilters": { "shape": "SaaSProductFilters", "documentation": "A filter for SaaS products.
" }, "AmiProductFilters": { "shape": "AmiProductFilters", "documentation": "A filter for AMI products.
" }, "OfferFilters": { "shape": "OfferFilters", "documentation": "A filter for offers.
" }, "ContainerProductFilters": { "shape": "ContainerProductFilters", "documentation": "A filter for container products.
" }, "ResaleAuthorizationFilters": { "shape": "ResaleAuthorizationFilters", "documentation": "A filter for Resale Authorizations.
" } }, "documentation": "Object containing all the filter fields per entity type.
", "union": true }, "EntityTypeSort": { "type": "structure", "members": { "DataProductSort": { "shape": "DataProductSort", "documentation": "A sort for data products.
" }, "SaaSProductSort": { "shape": "SaaSProductSort", "documentation": "A sort for SaaS products.
" }, "AmiProductSort": { "shape": "AmiProductSort", "documentation": "A sort for AMI products.
" }, "OfferSort": { "shape": "OfferSort", "documentation": "A sort for offers.
" }, "ContainerProductSort": { "shape": "ContainerProductSort", "documentation": "A sort for container products.
" }, "ResaleAuthorizationSort": { "shape": "ResaleAuthorizationSort", "documentation": "A sort for Resale Authorizations.
" } }, "documentation": "Object containing all the sort fields per entity type.
", "union": true }, "ErrorCodeString": { "type": "string", "max": 72, "min": 1, "pattern": "^[a-zA-Z_]+$" }, "ErrorDetail": { "type": "structure", "members": { "ErrorCode": { "shape": "ErrorCodeString", "documentation": "The error code that identifies the type of error.
" }, "ErrorMessage": { "shape": "ExceptionMessageContent", "documentation": "The message for the error.
" } }, "documentation": "Details about the error.
" }, "ErrorDetailList": { "type": "list", "member": { "shape": "ErrorDetail" } }, "Errors": { "type": "map", "key": { "shape": "EntityId" }, "value": { "shape": "BatchDescribeErrorDetail" } }, "ExceptionMessageContent": { "type": "string", "max": 2048, "min": 1, "pattern": "^(.)+$" }, "FailureCode": { "type": "string", "enum": [ "CLIENT_ERROR", "SERVER_FAULT" ] }, "Filter": { "type": "structure", "members": { "Name": { "shape": "FilterName", "documentation": "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 EntityId
s.
ListChangeSets
- The supported filter names and associated ValueList
s is as follows:
ChangeSetName
- The supported ValueList
is a list of non-unique ChangeSetName
s. 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 EntityId
s.
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.
A filter object, used to optionally filter results from calls to the ListEntities
and ListChangeSets
actions.
The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.
", "location": "querystring", "locationName": "resourceArn" } } }, "GetResourcePolicyResponse": { "type": "structure", "members": { "Policy": { "shape": "ResourcePolicyJson", "documentation": "The policy document to set; formatted in JSON.
" } } }, "Identifier": { "type": "string", "max": 255, "min": 1, "pattern": "^[\\w\\-@]+$" }, "Intent": { "type": "string", "enum": [ "VALIDATE", "APPLY" ] }, "Json": { "type": "string", "max": 16384, "min": 2, "pattern": "^[\\s]*\\{[\\s\\S]*\\}[\\s]*$" }, "JsonDocumentType": { "type": "structure", "members": {}, "document": true }, "ListChangeSetsMaxResultInteger": { "type": "integer", "box": true, "max": 20, "min": 1 }, "ListChangeSetsRequest": { "type": "structure", "required": [ "Catalog" ], "members": { "Catalog": { "shape": "Catalog", "documentation": "The catalog related to the request. Fixed value: AWSMarketplace
An array of filter objects.
" }, "Sort": { "shape": "Sort", "documentation": "An object that contains two attributes, SortBy
and SortOrder
.
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": { "shape": "NextToken", "documentation": "The token value retrieved from a previous call to access the next page of results.
" } } }, "ListChangeSetsResponse": { "type": "structure", "members": { "ChangeSetSummaryList": { "shape": "ChangeSetSummaryList", "documentation": " Array of ChangeSetSummaryListItem
objects.
The value of the next token, if it exists. Null if there are no more results.
" } } }, "ListEntitiesMaxResultInteger": { "type": "integer", "box": true, "max": 50, "min": 1 }, "ListEntitiesRequest": { "type": "structure", "required": [ "Catalog", "EntityType" ], "members": { "Catalog": { "shape": "Catalog", "documentation": "The catalog related to the request. Fixed value: AWSMarketplace
The type of entities to retrieve. Valid values are: AmiProduct
, ContainerProduct
, DataProduct
, SaaSProduct
, ProcurementPolicy
, Experience
, Audience
, BrandingSettings
, Offer
, Seller
, ResaleAuthorization
.
An array of filter objects. Each filter object contains two attributes, filterName
and filterValues
.
An object that contains two attributes, SortBy
and SortOrder
.
The value of the next token, if it exists. Null if there are no more results.
" }, "MaxResults": { "shape": "ListEntitiesMaxResultInteger", "documentation": "Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
" }, "OwnershipType": { "shape": "OwnershipType", "documentation": "Filters the returned set of entities based on their owner. The default is SELF
. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED
. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy
operation can't be discovered through the SHARED
parameter.
A Union object containing filter shapes for all EntityType
s. Each EntityTypeFilter
shape will have filters applicable for that EntityType
that can be used to search or filter entities.
A Union object containing Sort
shapes for all EntityType
s. Each EntityTypeSort
shape will have SortBy
and SortOrder
applicable for fields on that EntityType
. This can be used to sort the results of the filter query.
Array of EntitySummary
objects.
The value of the next token if it exists. Null if there is no more result.
" } } }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ResourceARN", "documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "ResourceArn": { "shape": "ResourceARN", "documentation": "Required. The ARN associated with the resource you want to list tags on.
" }, "Tags": { "shape": "TagList", "documentation": "Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.
" } } }, "NextToken": { "type": "string", "max": 2048, "min": 1, "pattern": "^[\\w+=.:@\\-\\/]$" }, "OfferAvailabilityEndDateFilter": { "type": "structure", "members": { "DateRange": { "shape": "OfferAvailabilityEndDateFilterDateRange", "documentation": "Allows filtering on the AvailabilityEndDate
of an offer with date range as input.
Allows filtering on the AvailabilityEndDate
of an offer.
Allows filtering on the AvailabilityEndDate
of an offer after a date.
Allows filtering on the AvailabilityEndDate
of an offer before a date.
Allows filtering on the AvailabilityEndDate
of an offer with date range as input.
Allows filtering on the BuyerAccounts
of an offer with wild card input.
Allows filtering on the BuyerAccounts
of an offer.
Allows filtering on entity id of an offer with list input.
" } }, "documentation": "Allows filtering on the entity id of an offer.
" }, "OfferEntityIdFilterValueList": { "type": "list", "member": { "shape": "OfferEntityIdString" }, "max": 10, "min": 1 }, "OfferEntityIdString": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" }, "OfferFilters": { "type": "structure", "members": { "EntityId": { "shape": "OfferEntityIdFilter", "documentation": "Allows filtering on EntityId
of an offer.
Allows filtering on the Name
of an offer.
Allows filtering on the ProductId
of an offer.
Allows filtering on the ResaleAuthorizationId
of an offer.
Not all offers have a ResaleAuthorizationId
. The response will only include offers for which you have permissions.
Allows filtering on the ReleaseDate
of an offer.
Allows filtering on the AvailabilityEndDate
of an offer.
Allows filtering on the BuyerAccounts
of an offer.
Allows filtering on the State
of an offer.
Allows filtering on the Targeting
of an offer.
Allows filtering on the LastModifiedDate
of an offer.
Object containing all the filter fields for offers entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities
request.
Allows filtering on the LastModifiedDate
of an offer with date range as input.
Allows filtering on the LastModifiedDate
of an offer.
Allows filtering on the LastModifiedDate
of an offer after a date.
Allows filtering on the LastModifiedDate
of an offer before a date.
Allows filtering on the LastModifiedDate
of an offer with date range as input.
Allows filtering on the Name
of an offer with list input.
Allows filtering on the Name
of an offer with wild card input.
Allows filtering on the Name
of an offer.
Allows filtering on the ProductId
of an offer with list input.
Allows filtering on the ProductId
of an offer.
Allows filtering on the ReleaseDate
of an offer with date range as input.
Allows filtering on the ReleaseDate
of an offer.
Allows filtering on the ReleaseDate
of offers after a date.
Allows filtering on the ReleaseDate
of offers before a date.
Allows filtering on the ReleaseDate
of an offer with date range as input.
Allows filtering on the ResaleAuthorizationId
of an offer with list input.
Allows filtering on the ResaleAuthorizationId
of an offer.
Not all offers have a ResaleAuthorizationId
. The response will only include offers for which you have permissions.
Allows to sort offers.
" }, "SortOrder": { "shape": "SortOrder", "documentation": "Allows to sort offers.
" } }, "documentation": "Allows to sort offers.
" }, "OfferSortBy": { "type": "string", "enum": [ "EntityId", "Name", "ProductId", "ResaleAuthorizationId", "ReleaseDate", "AvailabilityEndDate", "BuyerAccounts", "State", "Targeting", "LastModifiedDate" ] }, "OfferStateFilter": { "type": "structure", "members": { "ValueList": { "shape": "OfferStateFilterValueList", "documentation": "Allows filtering on the State
of an offer with list input.
Allows filtering on the State
of an offer.
The name of the offer.
" }, "ProductId": { "shape": "OfferProductIdString", "documentation": "The product ID of the offer.
" }, "ResaleAuthorizationId": { "shape": "OfferResaleAuthorizationIdString", "documentation": "The ResaleAuthorizationId of the offer.
" }, "ReleaseDate": { "shape": "DateTimeISO8601", "documentation": "The release date of the offer.
" }, "AvailabilityEndDate": { "shape": "DateTimeISO8601", "documentation": "The availability end date of the offer.
" }, "BuyerAccounts": { "shape": "OfferBuyerAccountsList", "documentation": "The buyer accounts in the offer.
" }, "State": { "shape": "OfferStateString", "documentation": "The status of the offer.
" }, "Targeting": { "shape": "OfferTargetingList", "documentation": "The targeting in the offer.
" } }, "documentation": "Summarized information about an offer.
" }, "OfferTargetingFilter": { "type": "structure", "members": { "ValueList": { "shape": "OfferTargetingFilterValueList", "documentation": "Allows filtering on the Targeting
of an offer with list input.
Allows filtering on the Targeting
of an offer.
The Amazon Resource Name (ARN) of the entity resource you want to associate with a resource policy.
" }, "Policy": { "shape": "ResourcePolicyJson", "documentation": "The policy document to set; formatted in JSON.
" } } }, "PutResourcePolicyResponse": { "type": "structure", "members": {} }, "RequestedChangeList": { "type": "list", "member": { "shape": "Change" }, "max": 20, "min": 1 }, "ResaleAuthorizationAvailabilityEndDateFilter": { "type": "structure", "members": { "DateRange": { "shape": "ResaleAuthorizationAvailabilityEndDateFilterDateRange", "documentation": "Allows filtering on AvailabilityEndDate
of a ResaleAuthorization with date range as input
Allows filtering on AvailabilityEndDate
of a ResaleAuthorization with date value as input.
Allows filtering on AvailabilityEndDate
of a ResaleAuthorization.
Allows filtering on AvailabilityEndDate
of a ResaleAuthorization after a date.
Allows filtering on AvailabilityEndDate
of a ResaleAuthorization before a date.
Allows filtering on AvailabilityEndDate
of a ResaleAuthorization with date range as input.
Allows filtering on CreatedDate
of a ResaleAuthorization with date range as input.
Allows filtering on CreatedDate
of a ResaleAuthorization with date value as input.
Allows filtering on CreatedDate
of a ResaleAuthorization.
Allows filtering on CreatedDate
of a ResaleAuthorization after a date.
Allows filtering on CreatedDate
of a ResaleAuthorization before a date.
Allows filtering on CreatedDate
of a ResaleAuthorization with date range as input.
Allows filtering on EntityId
of a ResaleAuthorization with list input.
Allows filtering on EntityId
of a ResaleAuthorization.
Allows filtering on the EntityId
of a ResaleAuthorization.
Allows filtering on the Name
of a ResaleAuthorization.
Allows filtering on the ProductId
of a ResaleAuthorization.
Allows filtering on the CreatedDate
of a ResaleAuthorization.
Allows filtering on the AvailabilityEndDate
of a ResaleAuthorization.
Allows filtering on the ManufacturerAccountId
of a ResaleAuthorization.
Allows filtering on the ProductName
of a ResaleAuthorization.
Allows filtering on the ManufacturerLegalName
of a ResaleAuthorization.
Allows filtering on the ResellerAccountID
of a ResaleAuthorization.
Allows filtering on the ResellerLegalName
of a ResaleAuthorization.
Allows filtering on the Status
of a ResaleAuthorization.
Allows filtering on the OfferExtendedStatus
of a ResaleAuthorization.
Allows filtering on the LastModifiedDate
of a ResaleAuthorization.
Object containing all the filter fields for resale authorization entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities
request.
Allows filtering on the LastModifiedDate
of a ResaleAuthorization with date range as input.
Allows filtering on the LastModifiedDate
of a ResaleAuthorization.
Allows filtering on the LastModifiedDate
of a ResaleAuthorization after a date.
Allows filtering on the LastModifiedDate
of a ResaleAuthorization before a date.
Allows filtering on the LastModifiedDate
of a ResaleAuthorization with date range as input.
Allows filtering on the ManufacturerAccountId
of a ResaleAuthorization with list input.
Allows filtering on the ManufacturerAccountId
of a ResaleAuthorization with wild card input.
Allows filtering on the ManufacturerAccountId
of a ResaleAuthorization.
Allows filtering on the ManufacturerLegalName
of a ResaleAuthorization with list input.
Allows filtering on the ManufacturerLegalName
of a ResaleAuthorization with wild card input.
Allows filtering on the ManufacturerLegalName
of a ResaleAuthorization.
Allows filtering on the Name
of a ResaleAuthorization with list input.
Allows filtering on the Name
of a ResaleAuthorization with wild card input.
Allows filtering on the Name
of a ResaleAuthorization.
Allows filtering on the OfferExtendedStatus
of a ResaleAuthorization with list input.
Allows filtering on the OfferExtendedStatus
of a ResaleAuthorization.
Allows filtering on the ProductId
of a ResaleAuthorization with list input.
Allows filtering on the ProductId
of a ResaleAuthorization with wild card input.
Allows filtering on the ProductId
of a ResaleAuthorization.
Allows filtering on the ProductName
of a ResaleAuthorization with list input.
Allows filtering on the ProductName
of a ResaleAuthorization with wild card input.
Allows filtering on the ProductName
of a ResaleAuthorization.
Allows filtering on the ResellerAccountID
of a ResaleAuthorization with list input.
Allows filtering on the ResellerAccountID
of a ResaleAuthorization with wild card input.
Allows filtering on the ResellerAccountID
of a ResaleAuthorization.
Allows filtering on the ResellerLegalNameProductName of a ResaleAuthorization with list input.
" }, "WildCardValue": { "shape": "ResaleAuthorizationResellerLegalNameFilterWildcard", "documentation": "Allows filtering on the ResellerLegalName of a ResaleAuthorization with wild card input.
" } }, "documentation": "Allows filtering on the ResellerLegalName of a ResaleAuthorization.
" }, "ResaleAuthorizationResellerLegalNameFilterValueList": { "type": "list", "member": { "shape": "ResaleAuthorizationResellerLegalNameString" }, "max": 10, "min": 1 }, "ResaleAuthorizationResellerLegalNameFilterWildcard": { "type": "string", "max": 255, "min": 1, "pattern": "^(.)+$" }, "ResaleAuthorizationResellerLegalNameString": { "type": "string", "max": 255, "min": 1, "pattern": "^(.)+$" }, "ResaleAuthorizationSort": { "type": "structure", "members": { "SortBy": { "shape": "ResaleAuthorizationSortBy", "documentation": "Allows to sort ResaleAuthorization.
" }, "SortOrder": { "shape": "SortOrder", "documentation": "Allows to sort ResaleAuthorization.
" } }, "documentation": "Allows to sort ResaleAuthorization.
" }, "ResaleAuthorizationSortBy": { "type": "string", "enum": [ "EntityId", "Name", "ProductId", "ProductName", "ManufacturerAccountId", "ManufacturerLegalName", "ResellerAccountID", "ResellerLegalName", "Status", "OfferExtendedStatus", "CreatedDate", "AvailabilityEndDate", "LastModifiedDate" ] }, "ResaleAuthorizationStatusFilter": { "type": "structure", "members": { "ValueList": { "shape": "ResaleAuthorizationStatusFilterValueList", "documentation": "Allows filtering on the Status
of a ResaleAuthorization with list input.
Allows filtering on the Status
of a ResaleAuthorization.
The name of the ResaleAuthorization.
" }, "ProductId": { "shape": "ResaleAuthorizationProductIdString", "documentation": "The product ID of the ResaleAuthorization.
" }, "ProductName": { "shape": "ResaleAuthorizationProductNameString", "documentation": "The product name of the ResaleAuthorization.
" }, "ManufacturerAccountId": { "shape": "ResaleAuthorizationManufacturerAccountIdString", "documentation": "The manufacturer account ID of the ResaleAuthorization.
" }, "ManufacturerLegalName": { "shape": "ResaleAuthorizationManufacturerLegalNameString", "documentation": "The manufacturer legal name of the ResaleAuthorization.
" }, "ResellerAccountID": { "shape": "ResaleAuthorizationResellerAccountIDString", "documentation": "The reseller account ID of the ResaleAuthorization.
" }, "ResellerLegalName": { "shape": "ResaleAuthorizationResellerLegalNameString", "documentation": "The reseller legal name of the ResaleAuthorization
" }, "Status": { "shape": "ResaleAuthorizationStatusString", "documentation": "The status of the ResaleAuthorization.
" }, "OfferExtendedStatus": { "shape": "ResaleAuthorizationOfferExtendedStatusString", "documentation": "The offer extended status of the ResaleAuthorization
" }, "CreatedDate": { "shape": "DateTimeISO8601", "documentation": "The created date of the ResaleAuthorization.
" }, "AvailabilityEndDate": { "shape": "DateTimeISO8601", "documentation": "The availability end date of the ResaleAuthorization.
" } }, "documentation": "Summarized information about a Resale Authorization.
" }, "ResourceARN": { "type": "string", "max": 255, "min": 1, "pattern": "^arn:[\\w+=/,.@-]+:aws-marketplace:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" }, "ResourceId": { "type": "string", "max": 255, "min": 1, "pattern": "^[\\w\\-]+$" }, "ResourceIdList": { "type": "list", "member": { "shape": "ResourceId" } }, "ResourcePolicyJson": { "type": "string", "max": 10240, "min": 1, "pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" }, "SaaSProductEntityIdFilter": { "type": "structure", "members": { "ValueList": { "shape": "SaaSProductEntityIdFilterValueList", "documentation": "A string array of unique entity id values to be filtered on.
" } }, "documentation": "Object that allows filtering on entity id of a SaaS product.
" }, "SaaSProductEntityIdFilterValueList": { "type": "list", "member": { "shape": "SaaSProductEntityIdString" }, "max": 10, "min": 1 }, "SaaSProductEntityIdString": { "type": "string", "max": 255, "min": 1, "pattern": "^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$" }, "SaaSProductFilters": { "type": "structure", "members": { "EntityId": { "shape": "SaaSProductEntityIdFilter", "documentation": "Unique identifier for the SaaS product.
" }, "ProductTitle": { "shape": "SaaSProductTitleFilter", "documentation": "The title of the SaaS product.
" }, "Visibility": { "shape": "SaaSProductVisibilityFilter", "documentation": "The visibility of the SaaS product.
" }, "LastModifiedDate": { "shape": "SaaSProductLastModifiedDateFilter", "documentation": "The last date on which the SaaS product was modified.
" } }, "documentation": "Object containing all the filter fields for SaaS products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities
request.
Dates between which the SaaS product was last modified.
" } }, "documentation": "Object that allows filtering based on the last modified date of SaaS products
" }, "SaaSProductLastModifiedDateFilterDateRange": { "type": "structure", "members": { "AfterValue": { "shape": "DateTimeISO8601", "documentation": "Date after which the SaaS product was last modified.
" }, "BeforeValue": { "shape": "DateTimeISO8601", "documentation": "Date before which the SaaS product was last modified.
" } }, "documentation": "Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue
and/or AfterValue
. Both are inclusive.
Field to sort the SaaS products by.
" }, "SortOrder": { "shape": "SortOrder", "documentation": "The sorting order. Can be ASCENDING
or DESCENDING
. The default value is DESCENDING
.
Objects that allows sorting on SaaS products based on certain fields and sorting order.
" }, "SaaSProductSortBy": { "type": "string", "enum": [ "EntityId", "ProductTitle", "Visibility", "LastModifiedDate" ] }, "SaaSProductSummary": { "type": "structure", "members": { "ProductTitle": { "shape": "SaaSProductTitleString", "documentation": "The title of the SaaS product.
" }, "Visibility": { "shape": "SaaSProductVisibilityString", "documentation": "The lifecycle of the SaaS product.
" } }, "documentation": "Object that contains summarized information about a SaaS product.
" }, "SaaSProductTitleFilter": { "type": "structure", "members": { "ValueList": { "shape": "SaaSProductTitleFilterValueList", "documentation": "A string array of unique product title values to be filtered on.
" }, "WildCardValue": { "shape": "SaaSProductTitleString", "documentation": "A string that will be the wildCard
input for product tile filter. It matches the provided value as a substring in the actual value.
Object that allows filtering on product title.
" }, "SaaSProductTitleFilterValueList": { "type": "list", "member": { "shape": "SaaSProductTitleString" }, "max": 10, "min": 1 }, "SaaSProductTitleString": { "type": "string", "max": 255, "min": 1, "pattern": "^(.)+$" }, "SaaSProductVisibilityFilter": { "type": "structure", "members": { "ValueList": { "shape": "SaaSProductVisibilityFilterValueList", "documentation": "A string array of unique visibility values to be filtered on.
" } }, "documentation": "Object that allows filtering on the visibility of the product in the AWS Marketplace.
" }, "SaaSProductVisibilityFilterValueList": { "type": "list", "member": { "shape": "SaaSProductVisibilityString" }, "max": 10, "min": 1 }, "SaaSProductVisibilityString": { "type": "string", "enum": [ "Limited", "Public", "Restricted", "Draft" ] }, "Sort": { "type": "structure", "members": { "SortBy": { "shape": "SortBy", "documentation": "For ListEntities
, supported attributes include LastModifiedDate
(default) and EntityId
. In addition to LastModifiedDate
and EntityId
, each EntityType
might support additional fields.
For ListChangeSets
, supported attributes include StartTime
and EndTime
.
The sorting order. Can be ASCENDING
or DESCENDING
. The default value is DESCENDING
.
An object that contains two attributes, SortBy
and SortOrder
.
The catalog related to the request. Fixed value: AWSMarketplace
Array of change
object.
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": { "shape": "ClientRequestToken", "documentation": "A unique token to identify the request to ensure idempotency.
", "idempotencyToken": true }, "ChangeSetTags": { "shape": "TagList", "documentation": "A list of objects specifying each key name and value for the ChangeSetTags
property.
The intent related to the request. The default is APPLY
. To test your request before applying changes to your entities, use VALIDATE
. This feature is currently available for adding versions to single-AMI products. For more information, see Add a new version.
Unique identifier generated for the request.
" }, "ChangeSetArn": { "shape": "ARN", "documentation": "The ARN associated to the unique identifier generated for the request.
" } } }, "Tag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "TagKey", "documentation": "The key associated with the tag.
" }, "Value": { "shape": "TagValue", "documentation": "The value associated with the tag.
" } }, "documentation": "A list of objects specifying each key name and value.
" }, "TagKey": { "type": "string", "max": 128, "min": 1, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 200, "min": 1 }, "TagList": { "type": "list", "member": { "shape": "Tag" }, "max": 200, "min": 1 }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceArn", "Tags" ], "members": { "ResourceArn": { "shape": "ResourceARN", "documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.
" }, "Tags": { "shape": "TagList", "documentation": "Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.
" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256, "min": 0, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "UntagResourceRequest": { "type": "structure", "required": [ "ResourceArn", "TagKeys" ], "members": { "ResourceArn": { "shape": "ResourceARN", "documentation": "Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
" }, "TagKeys": { "shape": "TagKeyList", "documentation": "Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.
" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "ValueList": { "type": "list", "member": { "shape": "FilterValueContent" }, "max": 10, "min": 1 }, "VisibilityValue": { "type": "string", "max": 64, "min": 1, "pattern": "^[a-zA-Z]+$" } }, "documentation": "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.
" }