{ "version": "2.0", "service": "

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.

", "operations": { "BatchDescribeEntities": "

Returns metadata and content for multiple entities.

", "CancelChangeSet": "

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.

", "DeleteResourcePolicy": "

Deletes a resource-based policy on an entity that is identified by its resource ARN.

", "DescribeChangeSet": "

Provides information about a given change set.

", "DescribeEntity": "

Returns the metadata and content of the entity.

", "GetResourcePolicy": "

Gets a resource-based policy of an entity that is identified by its resource ARN.

", "ListChangeSets": "

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": "

Provides the list of entities of a given type.

", "ListTagsForResource": "

Lists all tags that have been added to a resource (either an entity or change set).

", "PutResourcePolicy": "

Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.

", "StartChangeSet": "

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": "

Tags a resource (either an entity or change set).

", "UntagResource": "

Removes a tag or list of tags from a resource (either an entity or change set).

" }, "shapes": { "ARN": { "base": null, "refs": { "CancelChangeSetResponse$ChangeSetArn": "

The ARN associated with the change set referenced in this request.

", "ChangeSetSummaryListItem$ChangeSetArn": "

The ARN associated with the unique identifier for the change set referenced in this request.

", "DescribeChangeSetResponse$ChangeSetArn": "

The ARN associated with the unique identifier for the change set referenced in this request.

", "DescribeEntityResponse$EntityArn": "

The ARN associated to the unique identifier for the entity referenced in this request.

", "EntityDetail$EntityArn": "

The Amazon Resource Name (ARN) of the entity.

", "EntitySummary$EntityArn": "

The ARN associated with the unique identifier for the entity.

", "StartChangeSetResponse$ChangeSetArn": "

The ARN associated to the unique identifier generated for the request.

" } }, "AccessDeniedException": { "base": "

Access is denied.

HTTP status code: 403

", "refs": { } }, "AmiProductEntityIdFilter": { "base": "

Object that allows filtering on entity id of an AMI product.

", "refs": { "AmiProductFilters$EntityId": "

Unique identifier for the AMI product.

" } }, "AmiProductEntityIdFilterValueList": { "base": null, "refs": { "AmiProductEntityIdFilter$ValueList": "

A string array of unique entity id values to be filtered on.

" } }, "AmiProductEntityIdString": { "base": null, "refs": { "AmiProductEntityIdFilterValueList$member": null } }, "AmiProductFilters": { "base": "

Object containing all the filter fields for AMI products. Client can add a maximum of 8 filters in a single ListEntities request.

", "refs": { "EntityTypeFilters$AmiProductFilters": "

A filter for AMI products.

" } }, "AmiProductLastModifiedDateFilter": { "base": "

Object that allows filtering based on the last modified date of AMI products.

", "refs": { "AmiProductFilters$LastModifiedDate": "

The last date on which the AMI product was modified.

" } }, "AmiProductLastModifiedDateFilterDateRange": { "base": "

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.

", "refs": { "AmiProductLastModifiedDateFilter$DateRange": "

Dates between which the AMI product was last modified.

" } }, "AmiProductSort": { "base": "

Objects that allows sorting on AMI products based on certain fields and sorting order.

", "refs": { "EntityTypeSort$AmiProductSort": "

A sort for AMI products.

" } }, "AmiProductSortBy": { "base": null, "refs": { "AmiProductSort$SortBy": "

Field to sort the AMI products by.

" } }, "AmiProductSummary": { "base": "

Object that contains summarized information about an AMI product.

", "refs": { "EntitySummary$AmiProductSummary": "

An object that contains summary information about the AMI product.

" } }, "AmiProductTitleFilter": { "base": "

Object that allows filtering on product title.

", "refs": { "AmiProductFilters$ProductTitle": "

The title of the AMI product.

" } }, "AmiProductTitleFilterValueList": { "base": null, "refs": { "AmiProductTitleFilter$ValueList": "

A string array of unique product title values to be filtered on.

" } }, "AmiProductTitleString": { "base": null, "refs": { "AmiProductSummary$ProductTitle": "

The title of the AMI product.

", "AmiProductTitleFilter$WildCardValue": "

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

", "AmiProductTitleFilterValueList$member": null } }, "AmiProductVisibilityFilter": { "base": "

Object that allows filtering on the visibility of the product in the AWS Marketplace.

", "refs": { "AmiProductFilters$Visibility": "

The visibility of the AMI product.

" } }, "AmiProductVisibilityFilterValueList": { "base": null, "refs": { "AmiProductVisibilityFilter$ValueList": "

A string array of unique visibility values to be filtered on.

" } }, "AmiProductVisibilityString": { "base": null, "refs": { "AmiProductSummary$Visibility": "

The lifecycle of the AMI product.

", "AmiProductVisibilityFilterValueList$member": null } }, "BatchDescribeEntitiesRequest": { "base": null, "refs": { } }, "BatchDescribeEntitiesResponse": { "base": null, "refs": { } }, "BatchDescribeErrorCodeString": { "base": null, "refs": { "BatchDescribeErrorDetail$ErrorCode": "

The error code returned.

" } }, "BatchDescribeErrorDetail": { "base": "

An object that contains an error code and error message.

", "refs": { "Errors$value": null } }, "BatchDescribeErrorMessageContent": { "base": null, "refs": { "BatchDescribeErrorDetail$ErrorMessage": "

The error message returned.

" } }, "CancelChangeSetRequest": { "base": null, "refs": { } }, "CancelChangeSetResponse": { "base": null, "refs": { } }, "Catalog": { "base": null, "refs": { "CancelChangeSetRequest$Catalog": "

Required. The catalog related to the request. Fixed value: AWSMarketplace.

", "DescribeChangeSetRequest$Catalog": "

Required. The catalog related to the request. Fixed value: AWSMarketplace

", "DescribeEntityRequest$Catalog": "

Required. The catalog related to the request. Fixed value: AWSMarketplace

", "EntityRequest$Catalog": "

The name of the catalog the entity is present in. The only value at this time is AWSMarketplace.

", "ListChangeSetsRequest$Catalog": "

The catalog related to the request. Fixed value: AWSMarketplace

", "ListEntitiesRequest$Catalog": "

The catalog related to the request. Fixed value: AWSMarketplace

", "StartChangeSetRequest$Catalog": "

The catalog related to the request. Fixed value: AWSMarketplace

" } }, "Change": { "base": "

An object that contains the ChangeType, Details, and Entity.

", "refs": { "RequestedChangeList$member": null } }, "ChangeName": { "base": null, "refs": { "Change$ChangeName": "

Optional name for the change.

", "ChangeSummary$ChangeName": "

Optional name for the change.

" } }, "ChangeSetDescription": { "base": null, "refs": { "DescribeChangeSetResponse$ChangeSet": "

An array of ChangeSummary objects.

" } }, "ChangeSetName": { "base": null, "refs": { "ChangeSetSummaryListItem$ChangeSetName": "

The non-unique name for the change set.

", "DescribeChangeSetResponse$ChangeSetName": "

The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.

", "StartChangeSetRequest$ChangeSetName": "

Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets.

" } }, "ChangeSetSummaryList": { "base": null, "refs": { "ListChangeSetsResponse$ChangeSetSummaryList": "

Array of ChangeSetSummaryListItem objects.

" } }, "ChangeSetSummaryListItem": { "base": "

A summary of a change set returned in a list of change sets when the ListChangeSets action is called.

", "refs": { "ChangeSetSummaryList$member": null } }, "ChangeStatus": { "base": null, "refs": { "ChangeSetSummaryListItem$Status": "

The current status of the change set.

", "DescribeChangeSetResponse$Status": "

The status of the change request.

" } }, "ChangeSummary": { "base": "

This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.

", "refs": { "ChangeSetDescription$member": null } }, "ChangeType": { "base": null, "refs": { "Change$ChangeType": "

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.

", "ChangeSummary$ChangeType": "

The type of the change.

" } }, "ClientRequestToken": { "base": null, "refs": { "StartChangeSetRequest$ClientRequestToken": "

A unique token to identify the request to ensure idempotency.

" } }, "ContainerProductEntityIdFilter": { "base": "

Object that allows filtering on entity id of a container product.

", "refs": { "ContainerProductFilters$EntityId": "

Unique identifier for the container product.

" } }, "ContainerProductEntityIdFilterValueList": { "base": null, "refs": { "ContainerProductEntityIdFilter$ValueList": "

A string array of unique entity id values to be filtered on.

" } }, "ContainerProductEntityIdString": { "base": null, "refs": { "ContainerProductEntityIdFilterValueList$member": null } }, "ContainerProductFilters": { "base": "

Object containing all the filter fields for container products. Client can add a maximum of 8 filters in a single ListEntities request.

", "refs": { "EntityTypeFilters$ContainerProductFilters": "

A filter for container products.

" } }, "ContainerProductLastModifiedDateFilter": { "base": "

Object that allows filtering based on the last modified date of container products.

", "refs": { "ContainerProductFilters$LastModifiedDate": "

The last date on which the container product was modified.

" } }, "ContainerProductLastModifiedDateFilterDateRange": { "base": "

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.

", "refs": { "ContainerProductLastModifiedDateFilter$DateRange": "

Dates between which the container product was last modified.

" } }, "ContainerProductSort": { "base": "

Objects that allows sorting on container products based on certain fields and sorting order.

", "refs": { "EntityTypeSort$ContainerProductSort": "

A sort for container products.

" } }, "ContainerProductSortBy": { "base": null, "refs": { "ContainerProductSort$SortBy": "

Field to sort the container products by.

" } }, "ContainerProductSummary": { "base": "

Object that contains summarized information about a container product.

", "refs": { "EntitySummary$ContainerProductSummary": "

An object that contains summary information about the container product.

" } }, "ContainerProductTitleFilter": { "base": "

Object that allows filtering on product title.

", "refs": { "ContainerProductFilters$ProductTitle": "

The title of the container product.

" } }, "ContainerProductTitleFilterValueList": { "base": null, "refs": { "ContainerProductTitleFilter$ValueList": "

A string array of unique product title values to be filtered on.

" } }, "ContainerProductTitleString": { "base": null, "refs": { "ContainerProductSummary$ProductTitle": "

The title of the container product.

", "ContainerProductTitleFilter$WildCardValue": "

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

", "ContainerProductTitleFilterValueList$member": null } }, "ContainerProductVisibilityFilter": { "base": "

Object that allows filtering on the visibility of the product in the AWS Marketplace.

", "refs": { "ContainerProductFilters$Visibility": "

The visibility of the container product.

" } }, "ContainerProductVisibilityFilterValueList": { "base": null, "refs": { "ContainerProductVisibilityFilter$ValueList": "

A string array of unique visibility values to be filtered on.

" } }, "ContainerProductVisibilityString": { "base": null, "refs": { "ContainerProductSummary$Visibility": "

The lifecycle of the product.

", "ContainerProductVisibilityFilterValueList$member": null } }, "DataProductEntityIdFilter": { "base": "

Object that allows filtering on entity id of a data product.

", "refs": { "DataProductFilters$EntityId": "

Unique identifier for the data product.

" } }, "DataProductEntityIdFilterValueList": { "base": null, "refs": { "DataProductEntityIdFilter$ValueList": "

A string array of unique entity id values to be filtered on.

" } }, "DataProductEntityIdString": { "base": null, "refs": { "DataProductEntityIdFilterValueList$member": null } }, "DataProductFilters": { "base": "

Object containing all the filter fields for data products. Client can add a maximum of 8 filters in a single ListEntities request.

", "refs": { "EntityTypeFilters$DataProductFilters": "

A filter for data products.

" } }, "DataProductLastModifiedDateFilter": { "base": "

Object that allows filtering based on the last modified date of data products.

", "refs": { "DataProductFilters$LastModifiedDate": "

The last date on which the data product was modified.

" } }, "DataProductLastModifiedDateFilterDateRange": { "base": "

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.

", "refs": { "DataProductLastModifiedDateFilter$DateRange": "

Dates between which the data product was last modified.

" } }, "DataProductSort": { "base": "

Objects that allows sorting on data products based on certain fields and sorting order.

", "refs": { "EntityTypeSort$DataProductSort": "

A sort for data products.

" } }, "DataProductSortBy": { "base": null, "refs": { "DataProductSort$SortBy": "

Field to sort the data products by.

" } }, "DataProductSummary": { "base": "

Object that contains summarized information about a data product.

", "refs": { "EntitySummary$DataProductSummary": "

An object that contains summary information about the data product.

" } }, "DataProductTitleFilter": { "base": "

Object that allows filtering on product title.

", "refs": { "DataProductFilters$ProductTitle": "

The title of the data product.

" } }, "DataProductTitleFilterValueList": { "base": null, "refs": { "DataProductTitleFilter$ValueList": "

A string array of unique product title values to be filtered on.

" } }, "DataProductTitleString": { "base": null, "refs": { "DataProductSummary$ProductTitle": "

The title of the data product.

", "DataProductTitleFilter$WildCardValue": "

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

", "DataProductTitleFilterValueList$member": null } }, "DataProductVisibilityFilter": { "base": "

Object that allows filtering on the visibility of the product in the AWS Marketplace.

", "refs": { "DataProductFilters$Visibility": "

The visibility of the data product.

" } }, "DataProductVisibilityFilterValueList": { "base": null, "refs": { "DataProductVisibilityFilter$ValueList": "

A string array of unique visibility values to be filtered on.

" } }, "DataProductVisibilityString": { "base": null, "refs": { "DataProductSummary$Visibility": "

The lifecycle of the data product.

", "DataProductVisibilityFilterValueList$member": null } }, "DateTimeISO8601": { "base": null, "refs": { "AmiProductLastModifiedDateFilterDateRange$AfterValue": "

Date after which the AMI product was last modified.

", "AmiProductLastModifiedDateFilterDateRange$BeforeValue": "

Date before which the AMI product was last modified.

", "ChangeSetSummaryListItem$StartTime": "

The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.

", "ChangeSetSummaryListItem$EndTime": "

The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.

", "ContainerProductLastModifiedDateFilterDateRange$AfterValue": "

Date after which the container product was last modified.

", "ContainerProductLastModifiedDateFilterDateRange$BeforeValue": "

Date before which the container product was last modified.

", "DataProductLastModifiedDateFilterDateRange$AfterValue": "

Date after which the data product was last modified.

", "DataProductLastModifiedDateFilterDateRange$BeforeValue": "

Date before which the data product was last modified.

", "DescribeChangeSetResponse$StartTime": "

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.

", "DescribeChangeSetResponse$EndTime": "

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.

", "DescribeEntityResponse$LastModifiedDate": "

The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).

", "EntityDetail$LastModifiedDate": "

The last time the entity was modified.

", "EntitySummary$LastModifiedDate": "

The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).

", "OfferAvailabilityEndDateFilterDateRange$AfterValue": "

Allows filtering on the AvailabilityEndDate of an offer after a date.

", "OfferAvailabilityEndDateFilterDateRange$BeforeValue": "

Allows filtering on the AvailabilityEndDate of an offer before a date.

", "OfferLastModifiedDateFilterDateRange$AfterValue": "

Allows filtering on the LastModifiedDate of an offer after a date.

", "OfferLastModifiedDateFilterDateRange$BeforeValue": "

Allows filtering on the LastModifiedDate of an offer before a date.

", "OfferReleaseDateFilterDateRange$AfterValue": "

Allows filtering on the ReleaseDate of offers after a date.

", "OfferReleaseDateFilterDateRange$BeforeValue": "

Allows filtering on the ReleaseDate of offers before a date.

", "OfferSummary$ReleaseDate": "

The release date of the offer.

", "OfferSummary$AvailabilityEndDate": "

The availability end date of the offer.

", "ResaleAuthorizationAvailabilityEndDateFilterDateRange$AfterValue": "

Allows filtering on AvailabilityEndDate of a ResaleAuthorization after a date.

", "ResaleAuthorizationAvailabilityEndDateFilterDateRange$BeforeValue": "

Allows filtering on AvailabilityEndDate of a ResaleAuthorization before a date.

", "ResaleAuthorizationAvailabilityEndDateFilterValueList$member": null, "ResaleAuthorizationCreatedDateFilterDateRange$AfterValue": "

Allows filtering on CreatedDate of a ResaleAuthorization after a date.

", "ResaleAuthorizationCreatedDateFilterDateRange$BeforeValue": "

Allows filtering on CreatedDate of a ResaleAuthorization before a date.

", "ResaleAuthorizationCreatedDateFilterValueList$member": null, "ResaleAuthorizationLastModifiedDateFilterDateRange$AfterValue": "

Allows filtering on the LastModifiedDate of a ResaleAuthorization after a date.

", "ResaleAuthorizationLastModifiedDateFilterDateRange$BeforeValue": "

Allows filtering on the LastModifiedDate of a ResaleAuthorization before a date.

", "ResaleAuthorizationSummary$CreatedDate": "

The created date of the ResaleAuthorization.

", "ResaleAuthorizationSummary$AvailabilityEndDate": "

The availability end date of the ResaleAuthorization.

", "SaaSProductLastModifiedDateFilterDateRange$AfterValue": "

Date after which the SaaS product was last modified.

", "SaaSProductLastModifiedDateFilterDateRange$BeforeValue": "

Date before which the SaaS product was last modified.

" } }, "DeleteResourcePolicyRequest": { "base": null, "refs": { } }, "DeleteResourcePolicyResponse": { "base": null, "refs": { } }, "DescribeChangeSetRequest": { "base": null, "refs": { } }, "DescribeChangeSetResponse": { "base": null, "refs": { } }, "DescribeEntityRequest": { "base": null, "refs": { } }, "DescribeEntityResponse": { "base": null, "refs": { } }, "Entity": { "base": "

An entity contains data that describes your product, its supported features, and how it can be used or launched by your customer.

", "refs": { "Change$Entity": "

The entity to be changed.

", "ChangeSummary$Entity": "

The entity to be changed.

" } }, "EntityDetail": { "base": "

An object that contains metadata and details about the entity.

", "refs": { "EntityDetails$value": null } }, "EntityDetails": { "base": null, "refs": { "BatchDescribeEntitiesResponse$EntityDetails": "

Details about each entity.

" } }, "EntityId": { "base": null, "refs": { "EntityDetails$key": null, "EntityRequest$EntityId": "

The ID of the entity.

", "Errors$key": null } }, "EntityNameString": { "base": null, "refs": { "EntitySummary$Name": "

The name for the entity. This value is not unique. It is defined by the seller.

" } }, "EntityRequest": { "base": "

An object that contains entity ID and the catalog in which the entity is present.

", "refs": { "EntityRequestList$member": null } }, "EntityRequestList": { "base": null, "refs": { "BatchDescribeEntitiesRequest$EntityRequestList": "

List of entity IDs and the catalogs the entities are present in.

" } }, "EntitySummary": { "base": "

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.

", "refs": { "EntitySummaryList$member": null } }, "EntitySummaryList": { "base": null, "refs": { "ListEntitiesResponse$EntitySummaryList": "

Array of EntitySummary objects.

" } }, "EntityType": { "base": null, "refs": { "DescribeEntityResponse$EntityType": "

The named type of the entity, in the format of EntityType@Version.

", "Entity$Type": "

The type of entity.

", "EntityDetail$EntityType": "

The entity type of the entity, in the format of EntityType@Version.

", "EntitySummary$EntityType": "

The type of the entity.

", "ListEntitiesRequest$EntityType": "

The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

" } }, "EntityTypeFilters": { "base": "

Object containing all the filter fields per entity type.

", "refs": { "ListEntitiesRequest$EntityTypeFilters": "

A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

" } }, "EntityTypeSort": { "base": "

Object containing all the sort fields per entity type.

", "refs": { "ListEntitiesRequest$EntityTypeSort": "

A Union object containing Sort shapes for all EntityTypes. 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.

" } }, "ErrorCodeString": { "base": null, "refs": { "ErrorDetail$ErrorCode": "

The error code that identifies the type of error.

" } }, "ErrorDetail": { "base": "

Details about the error.

", "refs": { "ErrorDetailList$member": null } }, "ErrorDetailList": { "base": null, "refs": { "ChangeSummary$ErrorDetailList": "

An array of ErrorDetail objects associated with the change.

" } }, "Errors": { "base": null, "refs": { "BatchDescribeEntitiesResponse$Errors": "

A map of errors returned, with EntityId as the key and errorDetail as the value.

" } }, "ExceptionMessageContent": { "base": null, "refs": { "AccessDeniedException$Message": null, "DescribeChangeSetResponse$FailureDescription": "

Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.

", "ErrorDetail$ErrorMessage": "

The message for the error.

", "InternalServiceException$Message": null, "ResourceInUseException$Message": null, "ResourceNotFoundException$Message": null, "ResourceNotSupportedException$Message": null, "ServiceQuotaExceededException$Message": null, "ThrottlingException$Message": null, "ValidationException$Message": null } }, "FailureCode": { "base": null, "refs": { "ChangeSetSummaryListItem$FailureCode": "

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.

", "DescribeChangeSetResponse$FailureCode": "

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.

" } }, "Filter": { "base": "

A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.

", "refs": { "FilterList$member": null } }, "FilterList": { "base": null, "refs": { "ListChangeSetsRequest$FilterList": "

An array of filter objects.

", "ListEntitiesRequest$FilterList": "

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

" } }, "FilterName": { "base": null, "refs": { "Filter$Name": "

For ListEntities, the supported value for this is an EntityId.

For ListChangeSets, the supported values are as follows:

" } }, "FilterValueContent": { "base": null, "refs": { "ValueList$member": null } }, "GetResourcePolicyRequest": { "base": null, "refs": { } }, "GetResourcePolicyResponse": { "base": null, "refs": { } }, "Identifier": { "base": null, "refs": { "DescribeEntityResponse$EntityIdentifier": "

The identifier of the entity, in the format of EntityId@RevisionId.

", "Entity$Identifier": "

The identifier for the entity.

", "EntityDetail$EntityIdentifier": "

The ID of the entity, in the format of EntityId@RevisionId.

" } }, "InternalServiceException": { "base": "

There was an internal service exception.

HTTP status code: 500

", "refs": { } }, "Json": { "base": null, "refs": { "Change$Details": "

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.

", "ChangeSummary$Details": "

This object contains details specific to the change type of the requested change.

", "DescribeEntityResponse$Details": "

This stringified JSON object includes the details of the entity.

" } }, "JsonDocumentType": { "base": null, "refs": { "Change$DetailsDocument": "

Alternative field that accepts a JSON value instead of a string for ChangeType details. You can use either Details or DetailsDocument, but not both.

", "ChangeSummary$DetailsDocument": "

The JSON value of the details specific to the change type of the requested change.

", "DescribeEntityResponse$DetailsDocument": "

The JSON value of the details specific to the entity.

", "EntityDetail$DetailsDocument": "

An object that contains all the details of the entity.

" } }, "ListChangeSetsMaxResultInteger": { "base": null, "refs": { "ListChangeSetsRequest$MaxResults": "

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.

" } }, "ListChangeSetsRequest": { "base": null, "refs": { } }, "ListChangeSetsResponse": { "base": null, "refs": { } }, "ListEntitiesMaxResultInteger": { "base": null, "refs": { "ListEntitiesRequest$MaxResults": "

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

" } }, "ListEntitiesRequest": { "base": null, "refs": { } }, "ListEntitiesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "NextToken": { "base": null, "refs": { "ListChangeSetsRequest$NextToken": "

The token value retrieved from a previous call to access the next page of results.

", "ListChangeSetsResponse$NextToken": "

The value of the next token, if it exists. Null if there are no more results.

", "ListEntitiesRequest$NextToken": "

The value of the next token, if it exists. Null if there are no more results.

", "ListEntitiesResponse$NextToken": "

The value of the next token if it exists. Null if there is no more result.

" } }, "OfferAvailabilityEndDateFilter": { "base": "

Allows filtering on the AvailabilityEndDate of an offer.

", "refs": { "OfferFilters$AvailabilityEndDate": "

Allows filtering on the AvailabilityEndDate of an offer.

" } }, "OfferAvailabilityEndDateFilterDateRange": { "base": "

Allows filtering on the AvailabilityEndDate of an offer with date range as input.

", "refs": { "OfferAvailabilityEndDateFilter$DateRange": "

Allows filtering on the AvailabilityEndDate of an offer with date range as input.

" } }, "OfferBuyerAccountsFilter": { "base": "

Allows filtering on the BuyerAccounts of an offer.

", "refs": { "OfferFilters$BuyerAccounts": "

Allows filtering on the BuyerAccounts of an offer.

" } }, "OfferBuyerAccountsFilterWildcard": { "base": null, "refs": { "OfferBuyerAccountsFilter$WildCardValue": "

Allows filtering on the BuyerAccounts of an offer with wild card input.

" } }, "OfferBuyerAccountsList": { "base": null, "refs": { "OfferSummary$BuyerAccounts": "

The buyer accounts in the offer.

" } }, "OfferBuyerAccountsString": { "base": null, "refs": { "OfferBuyerAccountsList$member": null } }, "OfferEntityIdFilter": { "base": "

Allows filtering on the entity id of an offer.

", "refs": { "OfferFilters$EntityId": "

Allows filtering on EntityId of an offer.

" } }, "OfferEntityIdFilterValueList": { "base": null, "refs": { "OfferEntityIdFilter$ValueList": "

Allows filtering on entity id of an offer with list input.

" } }, "OfferEntityIdString": { "base": null, "refs": { "OfferEntityIdFilterValueList$member": null } }, "OfferFilters": { "base": "

A filter for offers entity.

", "refs": { "EntityTypeFilters$OfferFilters": "

A filter for offers.

" } }, "OfferLastModifiedDateFilter": { "base": "

Allows filtering on the LastModifiedDate of an offer.

", "refs": { "OfferFilters$LastModifiedDate": "

Allows filtering on the LastModifiedDate of an offer.

" } }, "OfferLastModifiedDateFilterDateRange": { "base": "

Allows filtering on the LastModifiedDate of an offer with date range as input.

", "refs": { "OfferLastModifiedDateFilter$DateRange": "

Allows filtering on the LastModifiedDate of an offer with date range as input.

" } }, "OfferNameFilter": { "base": "

Allows filtering on the Name of an offer.

", "refs": { "OfferFilters$Name": "

Allows filtering on the Name of an offer.

" } }, "OfferNameFilterValueList": { "base": null, "refs": { "OfferNameFilter$ValueList": "

Allows filtering on the Name of an offer with list input.

" } }, "OfferNameString": { "base": null, "refs": { "OfferNameFilter$WildCardValue": "

Allows filtering on the Name of an offer with wild card input.

", "OfferNameFilterValueList$member": null, "OfferSummary$Name": "

The name of the offer.

" } }, "OfferProductIdFilter": { "base": "

Allows filtering on the ProductId of an offer.

", "refs": { "OfferFilters$ProductId": "

Allows filtering on the ProductId of an offer.

" } }, "OfferProductIdFilterValueList": { "base": null, "refs": { "OfferProductIdFilter$ValueList": "

Allows filtering on the ProductId of an offer with list input.

" } }, "OfferProductIdString": { "base": null, "refs": { "OfferProductIdFilterValueList$member": null, "OfferSummary$ProductId": "

The product ID of the offer.

" } }, "OfferReleaseDateFilter": { "base": "

Allows filtering on the ReleaseDate of an offer.

", "refs": { "OfferFilters$ReleaseDate": "

Allows filtering on the ReleaseDate of an offer.

" } }, "OfferReleaseDateFilterDateRange": { "base": "

Allows filtering on the ReleaseDate of an offer with date range as input.

", "refs": { "OfferReleaseDateFilter$DateRange": "

Allows filtering on the ReleaseDate of an offer with date range as input.

" } }, "OfferSort": { "base": "

Allows to sort offers.

", "refs": { "EntityTypeSort$OfferSort": "

A sort for offers.

" } }, "OfferSortBy": { "base": null, "refs": { "OfferSort$SortBy": "

Allows to sort offers.

" } }, "OfferStateFilter": { "base": "

Allows filtering on the State of an offer.

", "refs": { "OfferFilters$State": "

Allows filtering on the State of an offer.

" } }, "OfferStateFilterValueList": { "base": null, "refs": { "OfferStateFilter$ValueList": "

Allows filtering on the State of an offer with list input.

" } }, "OfferStateString": { "base": null, "refs": { "OfferStateFilterValueList$member": null, "OfferSummary$State": "

The status of the offer.

" } }, "OfferSummary": { "base": "

Summarized information about an offer.

", "refs": { "EntitySummary$OfferSummary": "

An object that contains summary information about the offer.

" } }, "OfferTargetingFilter": { "base": "

Allows filtering on the Targeting of an offer.

", "refs": { "OfferFilters$Targeting": "

Allows filtering on the Targeting of an offer.

" } }, "OfferTargetingFilterValueList": { "base": null, "refs": { "OfferTargetingFilter$ValueList": "

Allows filtering on the Targeting of an offer with list input.

" } }, "OfferTargetingList": { "base": null, "refs": { "OfferSummary$Targeting": "

The targeting in the offer.

" } }, "OfferTargetingString": { "base": null, "refs": { "OfferTargetingFilterValueList$member": null, "OfferTargetingList$member": null } }, "OwnershipType": { "base": null, "refs": { "ListEntitiesRequest$OwnershipType": "

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.

" } }, "PutResourcePolicyRequest": { "base": null, "refs": { } }, "PutResourcePolicyResponse": { "base": null, "refs": { } }, "RequestedChangeList": { "base": null, "refs": { "StartChangeSetRequest$ChangeSet": "

Array of change object.

" } }, "ResaleAuthorizationAvailabilityEndDateFilter": { "base": "

Allows filtering on AvailabilityEndDate of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$AvailabilityEndDate": "

Allows filtering on the AvailabilityEndDate of a ResaleAuthorization.

" } }, "ResaleAuthorizationAvailabilityEndDateFilterDateRange": { "base": "

Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input.

", "refs": { "ResaleAuthorizationAvailabilityEndDateFilter$DateRange": "

Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input

" } }, "ResaleAuthorizationAvailabilityEndDateFilterValueList": { "base": null, "refs": { "ResaleAuthorizationAvailabilityEndDateFilter$ValueList": "

Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date value as input.

" } }, "ResaleAuthorizationCreatedDateFilter": { "base": "

Allows filtering on CreatedDate of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$CreatedDate": "

Allows filtering on the CreatedDate of a ResaleAuthorization.

" } }, "ResaleAuthorizationCreatedDateFilterDateRange": { "base": "

Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.

", "refs": { "ResaleAuthorizationCreatedDateFilter$DateRange": "

Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.

" } }, "ResaleAuthorizationCreatedDateFilterValueList": { "base": null, "refs": { "ResaleAuthorizationCreatedDateFilter$ValueList": "

Allows filtering on CreatedDate of a ResaleAuthorization with date value as input.

" } }, "ResaleAuthorizationEntityIdFilter": { "base": "

Allows filtering on EntityId of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$EntityId": "

Allows filtering on the EntityId of a ResaleAuthorization.

" } }, "ResaleAuthorizationEntityIdFilterValueList": { "base": null, "refs": { "ResaleAuthorizationEntityIdFilter$ValueList": "

Allows filtering on EntityId of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationEntityIdString": { "base": null, "refs": { "ResaleAuthorizationEntityIdFilterValueList$member": null } }, "ResaleAuthorizationFilters": { "base": "

A filter for ResaleAuthorization entity.

", "refs": { "EntityTypeFilters$ResaleAuthorizationFilters": "

A filter for Resale Authorizations.

" } }, "ResaleAuthorizationLastModifiedDateFilter": { "base": "

Allows filtering on the LastModifiedDate of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$LastModifiedDate": "

Allows filtering on the LastModifiedDate of a ResaleAuthorization.

" } }, "ResaleAuthorizationLastModifiedDateFilterDateRange": { "base": "

Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.

", "refs": { "ResaleAuthorizationLastModifiedDateFilter$DateRange": "

Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.

" } }, "ResaleAuthorizationManufacturerAccountIdFilter": { "base": "

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$ManufacturerAccountId": "

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.

" } }, "ResaleAuthorizationManufacturerAccountIdFilterValueList": { "base": null, "refs": { "ResaleAuthorizationManufacturerAccountIdFilter$ValueList": "

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationManufacturerAccountIdFilterWildcard": { "base": null, "refs": { "ResaleAuthorizationManufacturerAccountIdFilter$WildCardValue": "

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with wild card input.

" } }, "ResaleAuthorizationManufacturerAccountIdString": { "base": null, "refs": { "ResaleAuthorizationManufacturerAccountIdFilterValueList$member": null, "ResaleAuthorizationSummary$ManufacturerAccountId": "

The manufacturer account ID of the ResaleAuthorization.

" } }, "ResaleAuthorizationManufacturerLegalNameFilter": { "base": "

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$ManufacturerLegalName": "

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.

" } }, "ResaleAuthorizationManufacturerLegalNameFilterValueList": { "base": null, "refs": { "ResaleAuthorizationManufacturerLegalNameFilter$ValueList": "

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationManufacturerLegalNameFilterWildcard": { "base": null, "refs": { "ResaleAuthorizationManufacturerLegalNameFilter$WildCardValue": "

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with wild card input.

" } }, "ResaleAuthorizationManufacturerLegalNameString": { "base": null, "refs": { "ResaleAuthorizationManufacturerLegalNameFilterValueList$member": null, "ResaleAuthorizationSummary$ManufacturerLegalName": "

The manufacturer legal name of the ResaleAuthorization.

" } }, "ResaleAuthorizationNameFilter": { "base": "

Allows filtering on the Name of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$Name": "

Allows filtering on the Name of a ResaleAuthorization.

" } }, "ResaleAuthorizationNameFilterValueList": { "base": null, "refs": { "ResaleAuthorizationNameFilter$ValueList": "

Allows filtering on the Name of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationNameFilterWildcard": { "base": null, "refs": { "ResaleAuthorizationNameFilter$WildCardValue": "

Allows filtering on the Name of a ResaleAuthorization with wild card input.

" } }, "ResaleAuthorizationNameString": { "base": null, "refs": { "ResaleAuthorizationNameFilterValueList$member": null, "ResaleAuthorizationSummary$Name": "

The name of the ResaleAuthorization.

" } }, "ResaleAuthorizationOfferExtendedStatusFilter": { "base": "

Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$OfferExtendedStatus": "

Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.

" } }, "ResaleAuthorizationOfferExtendedStatusFilterValueList": { "base": null, "refs": { "ResaleAuthorizationOfferExtendedStatusFilter$ValueList": "

Allows filtering on the OfferExtendedStatus of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationOfferExtendedStatusString": { "base": null, "refs": { "ResaleAuthorizationOfferExtendedStatusFilterValueList$member": null, "ResaleAuthorizationSummary$OfferExtendedStatus": "

The offer extended status of the ResaleAuthorization

" } }, "ResaleAuthorizationProductIdFilter": { "base": "

Allows filtering on the ProductId of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$ProductId": "

Allows filtering on the ProductId of a ResaleAuthorization.

" } }, "ResaleAuthorizationProductIdFilterValueList": { "base": null, "refs": { "ResaleAuthorizationProductIdFilter$ValueList": "

Allows filtering on the ProductId of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationProductIdFilterWildcard": { "base": null, "refs": { "ResaleAuthorizationProductIdFilter$WildCardValue": "

Allows filtering on the ProductId of a ResaleAuthorization with wild card input.

" } }, "ResaleAuthorizationProductIdString": { "base": null, "refs": { "ResaleAuthorizationProductIdFilterValueList$member": null, "ResaleAuthorizationSummary$ProductId": "

The product ID of the ResaleAuthorization.

" } }, "ResaleAuthorizationProductNameFilter": { "base": "

Allows filtering on the ProductName of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$ProductName": "

Allows filtering on the ProductName of a ResaleAuthorization.

" } }, "ResaleAuthorizationProductNameFilterValueList": { "base": null, "refs": { "ResaleAuthorizationProductNameFilter$ValueList": "

Allows filtering on the ProductName of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationProductNameFilterWildcard": { "base": null, "refs": { "ResaleAuthorizationProductNameFilter$WildCardValue": "

Allows filtering on the ProductName of a ResaleAuthorization with wild card input.

" } }, "ResaleAuthorizationProductNameString": { "base": null, "refs": { "ResaleAuthorizationProductNameFilterValueList$member": null, "ResaleAuthorizationSummary$ProductName": "

The product name of the ResaleAuthorization.

" } }, "ResaleAuthorizationResellerAccountIDFilter": { "base": "

Allows filtering on the ResellerAccountID of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$ResellerAccountID": "

Allows filtering on the ResellerAccountID of a ResaleAuthorization.

" } }, "ResaleAuthorizationResellerAccountIDFilterValueList": { "base": null, "refs": { "ResaleAuthorizationResellerAccountIDFilter$ValueList": "

Allows filtering on the ResellerAccountID of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationResellerAccountIDFilterWildcard": { "base": null, "refs": { "ResaleAuthorizationResellerAccountIDFilter$WildCardValue": "

Allows filtering on the ResellerAccountID of a ResaleAuthorization with wild card input.

" } }, "ResaleAuthorizationResellerAccountIDString": { "base": null, "refs": { "ResaleAuthorizationResellerAccountIDFilterValueList$member": null, "ResaleAuthorizationSummary$ResellerAccountID": "

The reseller account ID of the ResaleAuthorization.

" } }, "ResaleAuthorizationResellerLegalNameFilter": { "base": "

Allows filtering on the ResellerLegalName of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$ResellerLegalName": "

Allows filtering on the ResellerLegalName of a ResaleAuthorization.

" } }, "ResaleAuthorizationResellerLegalNameFilterValueList": { "base": null, "refs": { "ResaleAuthorizationResellerLegalNameFilter$ValueList": "

Allows filtering on the ResellerLegalNameProductName of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationResellerLegalNameFilterWildcard": { "base": null, "refs": { "ResaleAuthorizationResellerLegalNameFilter$WildCardValue": "

Allows filtering on the ResellerLegalName of a ResaleAuthorization with wild card input.

" } }, "ResaleAuthorizationResellerLegalNameString": { "base": null, "refs": { "ResaleAuthorizationResellerLegalNameFilterValueList$member": null, "ResaleAuthorizationSummary$ResellerLegalName": "

The reseller legal name of the ResaleAuthorization

" } }, "ResaleAuthorizationSort": { "base": "

Allows to sort ResaleAuthorization.

", "refs": { "EntityTypeSort$ResaleAuthorizationSort": "

A sort for Resale Authorizations.

" } }, "ResaleAuthorizationSortBy": { "base": null, "refs": { "ResaleAuthorizationSort$SortBy": "

Allows to sort ResaleAuthorization.

" } }, "ResaleAuthorizationStatusFilter": { "base": "

Allows filtering on the Status of a ResaleAuthorization.

", "refs": { "ResaleAuthorizationFilters$Status": "

Allows filtering on the Status of a ResaleAuthorization.

" } }, "ResaleAuthorizationStatusFilterValueList": { "base": null, "refs": { "ResaleAuthorizationStatusFilter$ValueList": "

Allows filtering on the Status of a ResaleAuthorization with list input.

" } }, "ResaleAuthorizationStatusString": { "base": null, "refs": { "ResaleAuthorizationStatusFilterValueList$member": null, "ResaleAuthorizationSummary$Status": "

The status of the ResaleAuthorization.

" } }, "ResaleAuthorizationSummary": { "base": "

Summarized information about a Resale Authorization.

", "refs": { "EntitySummary$ResaleAuthorizationSummary": "

An object that contains summary information about the Resale Authorization.

" } }, "ResourceARN": { "base": null, "refs": { "DeleteResourcePolicyRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

", "GetResourcePolicyRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

", "ListTagsForResourceRequest$ResourceArn": "

Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

", "ListTagsForResourceResponse$ResourceArn": "

Required. The ARN associated with the resource you want to list tags on.

", "PutResourcePolicyRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the entity resource you want to associate with a resource policy.

", "TagResourceRequest$ResourceArn": "

Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.

", "UntagResourceRequest$ResourceArn": "

Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

" } }, "ResourceId": { "base": null, "refs": { "CancelChangeSetRequest$ChangeSetId": "

Required. The unique identifier of the StartChangeSet request that you want to cancel.

", "CancelChangeSetResponse$ChangeSetId": "

The unique identifier for the change set referenced in this request.

", "ChangeSetSummaryListItem$ChangeSetId": "

The unique identifier for a change set.

", "DescribeChangeSetRequest$ChangeSetId": "

Required. The unique identifier for the StartChangeSet request that you want to describe the details for.

", "DescribeChangeSetResponse$ChangeSetId": "

Required. The unique identifier for the change set referenced in this request.

", "DescribeEntityRequest$EntityId": "

Required. The unique ID of the entity to describe.

", "EntitySummary$EntityId": "

The unique identifier for the entity.

", "ResourceIdList$member": null, "StartChangeSetResponse$ChangeSetId": "

Unique identifier generated for the request.

" } }, "ResourceIdList": { "base": null, "refs": { "ChangeSetSummaryListItem$EntityIdList": "

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.

" } }, "ResourceInUseException": { "base": "

The resource is currently in use.

", "refs": { } }, "ResourceNotFoundException": { "base": "

The specified resource wasn't found.

HTTP status code: 404

", "refs": { } }, "ResourceNotSupportedException": { "base": "

Currently, the specified resource is not supported.

", "refs": { } }, "ResourcePolicyJson": { "base": null, "refs": { "GetResourcePolicyResponse$Policy": "

The policy document to set; formatted in JSON.

", "PutResourcePolicyRequest$Policy": "

The policy document to set; formatted in JSON.

" } }, "SaaSProductEntityIdFilter": { "base": "

Object that allows filtering on entity id of a SaaS product.

", "refs": { "SaaSProductFilters$EntityId": "

Unique identifier for the SaaS product.

" } }, "SaaSProductEntityIdFilterValueList": { "base": null, "refs": { "SaaSProductEntityIdFilter$ValueList": "

A string array of unique entity id values to be filtered on.

" } }, "SaaSProductEntityIdString": { "base": null, "refs": { "SaaSProductEntityIdFilterValueList$member": null } }, "SaaSProductFilters": { "base": "

Object containing all the filter fields for SaaS products. Client can add a maximum of 8 filters in a single ListEntities request.

", "refs": { "EntityTypeFilters$SaaSProductFilters": "

A filter for SaaS products.

" } }, "SaaSProductLastModifiedDateFilter": { "base": "

Object that allows filtering based on the last modified date of SaaS products

", "refs": { "SaaSProductFilters$LastModifiedDate": "

The last date on which the SaaS product was modified.

" } }, "SaaSProductLastModifiedDateFilterDateRange": { "base": "

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.

", "refs": { "SaaSProductLastModifiedDateFilter$DateRange": "

Dates between which the SaaS product was last modified.

" } }, "SaaSProductSort": { "base": "

Objects that allows sorting on SaaS products based on certain fields and sorting order.

", "refs": { "EntityTypeSort$SaaSProductSort": "

A sort for SaaS products.

" } }, "SaaSProductSortBy": { "base": null, "refs": { "SaaSProductSort$SortBy": "

Field to sort the SaaS products by.

" } }, "SaaSProductSummary": { "base": "

Object that contains summarized information about a SaaS product.

", "refs": { "EntitySummary$SaaSProductSummary": "

An object that contains summary information about the SaaS product.

" } }, "SaaSProductTitleFilter": { "base": "

Object that allows filtering on product title.

", "refs": { "SaaSProductFilters$ProductTitle": "

The title of the SaaS product.

" } }, "SaaSProductTitleFilterValueList": { "base": null, "refs": { "SaaSProductTitleFilter$ValueList": "

A string array of unique product title values to be filtered on.

" } }, "SaaSProductTitleString": { "base": null, "refs": { "SaaSProductSummary$ProductTitle": "

The title of the SaaS product.

", "SaaSProductTitleFilter$WildCardValue": "

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

", "SaaSProductTitleFilterValueList$member": null } }, "SaaSProductVisibilityFilter": { "base": "

Object that allows filtering on the visibility of the product in the AWS Marketplace.

", "refs": { "SaaSProductFilters$Visibility": "

The visibility of the SaaS product.

" } }, "SaaSProductVisibilityFilterValueList": { "base": null, "refs": { "SaaSProductVisibilityFilter$ValueList": "

A string array of unique visibility values to be filtered on.

" } }, "SaaSProductVisibilityString": { "base": null, "refs": { "SaaSProductSummary$Visibility": "

The lifecycle of the SaaS product.

", "SaaSProductVisibilityFilterValueList$member": null } }, "ServiceQuotaExceededException": { "base": "

The maximum number of open requests per account has been exceeded.

", "refs": { } }, "Sort": { "base": "

An object that contains two attributes, SortBy and SortOrder.

", "refs": { "ListChangeSetsRequest$Sort": "

An object that contains two attributes, SortBy and SortOrder.

", "ListEntitiesRequest$Sort": "

An object that contains two attributes, SortBy and SortOrder.

" } }, "SortBy": { "base": null, "refs": { "Sort$SortBy": "

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.

" } }, "SortOrder": { "base": null, "refs": { "AmiProductSort$SortOrder": "

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

", "ContainerProductSort$SortOrder": "

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

", "DataProductSort$SortOrder": "

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

", "OfferSort$SortOrder": "

Allows to sort offers.

", "ResaleAuthorizationSort$SortOrder": "

Allows to sort ResaleAuthorization.

", "SaaSProductSort$SortOrder": "

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

", "Sort$SortOrder": "

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

" } }, "StartChangeSetRequest": { "base": null, "refs": { } }, "StartChangeSetResponse": { "base": null, "refs": { } }, "Tag": { "base": "

A list of objects specifying each key name and value.

", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "

The key associated with the tag.

", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "

Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.

" } }, "TagList": { "base": null, "refs": { "Change$EntityTags": "

The tags associated with the change.

", "ListTagsForResourceResponse$Tags": "

Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.

", "StartChangeSetRequest$ChangeSetTags": "

A list of objects specifying each key name and value for the ChangeSetTags property.

", "TagResourceRequest$Tags": "

Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.

" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "

The value associated with the tag.

" } }, "ThrottlingException": { "base": "

Too many requests.

HTTP status code: 429

", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "

An error occurred during validation.

HTTP status code: 422

", "refs": { } }, "ValueList": { "base": null, "refs": { "Filter$ValueList": "

ListEntities - This is a list of unique EntityIds.

ListChangeSets - The supported filter names and associated ValueLists is as follows:

" } }, "VisibilityValue": { "base": null, "refs": { "EntitySummary$Visibility": "

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).

" } } } }