Table of Contents
MarketplaceCatalog.Client¶A low-level client representing AWS Marketplace Catalog 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.
import boto3
client = boto3.client('marketplace-catalog')
These are the available methods:
can_paginate()cancel_change_set()close()describe_change_set()describe_entity()get_paginator()get_waiter()list_change_sets()list_entities()start_change_set()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_change_set(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.cancel_change_set(
Catalog='string',
ChangeSetId='string'
)
[REQUIRED]
Required. The catalog related to the request. Fixed value: AWSMarketplace .
[REQUIRED]
Required. The unique identifier of the StartChangeSet request that you want to cancel.
dict
Response Syntax
{
'ChangeSetId': 'string',
'ChangeSetArn': 'string'
}
Response Structure
(dict) --
ChangeSetId (string) --
The unique identifier for the change set referenced in this request.
ChangeSetArn (string) --
The ARN associated with the change set referenced in this request.
Exceptions
MarketplaceCatalog.Client.exceptions.InternalServiceExceptionMarketplaceCatalog.Client.exceptions.AccessDeniedExceptionMarketplaceCatalog.Client.exceptions.ValidationExceptionMarketplaceCatalog.Client.exceptions.ResourceNotFoundExceptionMarketplaceCatalog.Client.exceptions.ResourceInUseExceptionMarketplaceCatalog.Client.exceptions.ThrottlingExceptionclose()¶Closes underlying endpoint connections.
describe_change_set(**kwargs)¶Provides information about a given change set.
See also: AWS API Documentation
Request Syntax
response = client.describe_change_set(
Catalog='string',
ChangeSetId='string'
)
[REQUIRED]
Required. The catalog related to the request. Fixed value: AWSMarketplace
[REQUIRED]
Required. The unique identifier for the StartChangeSet request that you want to describe the details for.
dict
Response Syntax
{
'ChangeSetId': 'string',
'ChangeSetArn': 'string',
'ChangeSetName': 'string',
'StartTime': 'string',
'EndTime': 'string',
'Status': 'PREPARING'|'APPLYING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
'FailureCode': 'CLIENT_ERROR'|'SERVER_FAULT',
'FailureDescription': 'string',
'ChangeSet': [
{
'ChangeType': 'string',
'Entity': {
'Type': 'string',
'Identifier': 'string'
},
'Details': 'string',
'ErrorDetailList': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'ChangeName': 'string'
},
]
}
Response Structure
(dict) --
ChangeSetId (string) --
Required. The unique identifier for the change set referenced in this request.
ChangeSetArn (string) --
The ARN associated with the unique identifier for the change set referenced in this request.
ChangeSetName (string) --
The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.
StartTime (string) --
The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.
EndTime (string) --
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 (string) --
The status of the change request.
FailureCode (string) --
Returned if the change set is in FAILED status. Can be either CLIENT_ERROR , which means that there are issues with the request (see the ErrorDetailList ), or SERVER_FAULT , which means that there is a problem in the system, and you should retry your request.
FailureDescription (string) --
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 (list) --
An array of ChangeSummary objects.
(dict) --
This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.
ChangeType (string) --
The type of the change.
Entity (dict) --
The entity to be changed.
Type (string) --
The type of entity.
Identifier (string) --
The identifier for the entity.
Details (string) --
This object contains details specific to the change type of the requested change.
ErrorDetailList (list) --
An array of ErrorDetail objects associated with the change.
(dict) --
Details about the error.
ErrorCode (string) --
The error code that identifies the type of error.
ErrorMessage (string) --
The message for the error.
ChangeName (string) --
Optional name for the change.
Exceptions
MarketplaceCatalog.Client.exceptions.InternalServiceExceptionMarketplaceCatalog.Client.exceptions.AccessDeniedExceptionMarketplaceCatalog.Client.exceptions.ValidationExceptionMarketplaceCatalog.Client.exceptions.ResourceNotFoundExceptionMarketplaceCatalog.Client.exceptions.ThrottlingExceptiondescribe_entity(**kwargs)¶Returns the metadata and content of the entity.
See also: AWS API Documentation
Request Syntax
response = client.describe_entity(
Catalog='string',
EntityId='string'
)
[REQUIRED]
Required. The catalog related to the request. Fixed value: AWSMarketplace
[REQUIRED]
Required. The unique ID of the entity to describe.
dict
Response Syntax
{
'EntityType': 'string',
'EntityIdentifier': 'string',
'EntityArn': 'string',
'LastModifiedDate': 'string',
'Details': 'string'
}
Response Structure
(dict) --
EntityType (string) --
The named type of the entity, in the format of EntityType@Version .
EntityIdentifier (string) --
The identifier of the entity, in the format of EntityId@RevisionId .
EntityArn (string) --
The ARN associated to the unique identifier for the entity referenced in this request.
LastModifiedDate (string) --
The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
Details (string) --
This stringified JSON object includes the details of the entity.
Exceptions
MarketplaceCatalog.Client.exceptions.InternalServiceExceptionMarketplaceCatalog.Client.exceptions.AccessDeniedExceptionMarketplaceCatalog.Client.exceptions.ValidationExceptionMarketplaceCatalog.Client.exceptions.ResourceNotSupportedExceptionMarketplaceCatalog.Client.exceptions.ResourceNotFoundExceptionMarketplaceCatalog.Client.exceptions.ThrottlingExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_change_sets(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_change_sets(
Catalog='string',
FilterList=[
{
'Name': 'string',
'ValueList': [
'string',
]
},
],
Sort={
'SortBy': 'string',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The catalog related to the request. Fixed value: AWSMarketplace
An array of filter objects.
A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.
For ListEntities , the supported value for this is an EntityId .
For ListChangeSets , the supported values are as follows:
ListEntities- This is a list of uniqueEntityIds.
ListChangeSets- The supported filter names and associatedValueLists 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.An object that contains two attributes, SortBy and SortOrder .
For ListEntities , supported attributes include LastModifiedDate (default), Visibility , EntityId , and Name .
For ListChangeSets , supported attributes include StartTime and EndTime .
The sorting order. Can be ASCENDING or DESCENDING . The default value is DESCENDING .
dict
Response Syntax
{
'ChangeSetSummaryList': [
{
'ChangeSetId': 'string',
'ChangeSetArn': 'string',
'ChangeSetName': 'string',
'StartTime': 'string',
'EndTime': 'string',
'Status': 'PREPARING'|'APPLYING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
'EntityIdList': [
'string',
],
'FailureCode': 'CLIENT_ERROR'|'SERVER_FAULT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChangeSetSummaryList (list) --
Array of ChangeSetSummaryListItem objects.
(dict) --
A summary of a change set returned in a list of change sets when the ListChangeSets action is called.
ChangeSetId (string) --
The unique identifier for a change set.
ChangeSetArn (string) --
The ARN associated with the unique identifier for the change set referenced in this request.
ChangeSetName (string) --
The non-unique name for the change set.
StartTime (string) --
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
EndTime (string) --
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
Status (string) --
The current status of the change set.
EntityIdList (list) --
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 (string) --
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.
NextToken (string) --
The value of the next token, if it exists. Null if there are no more results.
Exceptions
MarketplaceCatalog.Client.exceptions.InternalServiceExceptionMarketplaceCatalog.Client.exceptions.AccessDeniedExceptionMarketplaceCatalog.Client.exceptions.ValidationExceptionMarketplaceCatalog.Client.exceptions.ThrottlingExceptionlist_entities(**kwargs)¶Provides the list of entities of a given type.
See also: AWS API Documentation
Request Syntax
response = client.list_entities(
Catalog='string',
EntityType='string',
FilterList=[
{
'Name': 'string',
'ValueList': [
'string',
]
},
],
Sort={
'SortBy': 'string',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
NextToken='string',
MaxResults=123
)
[REQUIRED]
The catalog related to the request. Fixed value: AWSMarketplace
[REQUIRED]
The type of entities to retrieve.
An array of filter objects. Each filter object contains two attributes, filterName and filterValues .
A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.
For ListEntities , the supported value for this is an EntityId .
For ListChangeSets , the supported values are as follows:
ListEntities- This is a list of uniqueEntityIds.
ListChangeSets- The supported filter names and associatedValueLists 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.An object that contains two attributes, SortBy and SortOrder .
For ListEntities , supported attributes include LastModifiedDate (default), Visibility , EntityId , and Name .
For ListChangeSets , supported attributes include StartTime and EndTime .
The sorting order. Can be ASCENDING or DESCENDING . The default value is DESCENDING .
dict
Response Syntax
{
'EntitySummaryList': [
{
'Name': 'string',
'EntityType': 'string',
'EntityId': 'string',
'EntityArn': 'string',
'LastModifiedDate': 'string',
'Visibility': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EntitySummaryList (list) --
Array of EntitySummary object.
(dict) --
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.
Name (string) --
The name for the entity. This value is not unique. It is defined by the seller.
EntityType (string) --
The type of the entity.
EntityId (string) --
The unique identifier for the entity.
EntityArn (string) --
The ARN associated with the unique identifier for the entity.
LastModifiedDate (string) --
The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
Visibility (string) --
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).
NextToken (string) --
The value of the next token if it exists. Null if there is no more result.
Exceptions
MarketplaceCatalog.Client.exceptions.InternalServiceExceptionMarketplaceCatalog.Client.exceptions.AccessDeniedExceptionMarketplaceCatalog.Client.exceptions.ValidationExceptionMarketplaceCatalog.Client.exceptions.ResourceNotFoundExceptionMarketplaceCatalog.Client.exceptions.ThrottlingExceptionstart_change_set(**kwargs)¶This operation allows you to request changes for your entities. Within a single ChangeSet, you cannot 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 ChangeSet has completed (either succeeded, cancelled, or failed). If you try to start a ChangeSet containing a change against an entity that is already locked, you will receive a ResourceInUseException .
For example, you cannot start the ChangeSet described in the example later in this topic, because it contains two changes to execute 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 .
See also: AWS API Documentation
Request Syntax
response = client.start_change_set(
Catalog='string',
ChangeSet=[
{
'ChangeType': 'string',
'Entity': {
'Type': 'string',
'Identifier': 'string'
},
'Details': 'string',
'ChangeName': 'string'
},
],
ChangeSetName='string',
ClientRequestToken='string'
)
[REQUIRED]
The catalog related to the request. Fixed value: AWSMarketplace
[REQUIRED]
Array of change object.
An object that contains the ChangeType , Details , and Entity .
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.
The entity to be changed.
The type of entity.
The identifier for the entity.
This object contains details specific to the change type of the requested change.
Optional name for the change.
A unique token to identify the request to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ChangeSetId': 'string',
'ChangeSetArn': 'string'
}
Response Structure
(dict) --
ChangeSetId (string) --
Unique identifier generated for the request.
ChangeSetArn (string) --
The ARN associated to the unique identifier generated for the request.
Exceptions
MarketplaceCatalog.Client.exceptions.InternalServiceExceptionMarketplaceCatalog.Client.exceptions.AccessDeniedExceptionMarketplaceCatalog.Client.exceptions.ValidationExceptionMarketplaceCatalog.Client.exceptions.ResourceNotFoundExceptionMarketplaceCatalog.Client.exceptions.ResourceInUseExceptionMarketplaceCatalog.Client.exceptions.ThrottlingExceptionMarketplaceCatalog.Client.exceptions.ServiceQuotaExceededExceptionThe available paginators are: