MarketplaceCatalog

Client

class 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(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Returns
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'
)
Parameters
  • Catalog (string) --

    [REQUIRED]

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

  • ChangeSetId (string) --

    [REQUIRED]

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

Return type

dict

Returns

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.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.ResourceInUseException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
close()

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'
)
Parameters
  • Catalog (string) --

    [REQUIRED]

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

  • ChangeSetId (string) --

    [REQUIRED]

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

Return type

dict

Returns

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.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
describe_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'
)
Parameters
  • Catalog (string) --

    [REQUIRED]

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

  • EntityId (string) --

    [REQUIRED]

    Required. The unique ID of the entity to describe.

Return type

dict

Returns

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.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ResourceNotSupportedException
  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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'
)
Parameters
  • Catalog (string) --

    [REQUIRED]

    The catalog related to the request. Fixed value: AWSMarketplace

  • FilterList (list) --

    An array of filter objects.

    • (dict) --

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

      • Name (string) --

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

        For ListChangeSets , the supported values are as follows:

      • ValueList (list) --
        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.
        • (string) --
  • Sort (dict) --

    An object that contains two attributes, SortBy and SortOrder .

    • SortBy (string) --

      For ListEntities , supported attributes include LastModifiedDate (default), Visibility , EntityId , and Name .

      For ListChangeSets , supported attributes include StartTime and EndTime .

    • SortOrder (string) --

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

  • MaxResults (integer) -- 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 (string) -- The token value retrieved from a previous call to access the next page of results.
Return type

dict

Returns

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.

          • (string) --
        • 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.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
list_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
)
Parameters
  • Catalog (string) --

    [REQUIRED]

    The catalog related to the request. Fixed value: AWSMarketplace

  • EntityType (string) --

    [REQUIRED]

    The type of entities to retrieve.

  • FilterList (list) --

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

    • (dict) --

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

      • Name (string) --

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

        For ListChangeSets , the supported values are as follows:

      • ValueList (list) --
        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.
        • (string) --
  • Sort (dict) --

    An object that contains two attributes, SortBy and SortOrder .

    • SortBy (string) --

      For ListEntities , supported attributes include LastModifiedDate (default), Visibility , EntityId , and Name .

      For ListChangeSets , supported attributes include StartTime and EndTime .

    • SortOrder (string) --

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

  • NextToken (string) -- The value of the next token, if it exists. Null if there are no more results.
  • MaxResults (integer) -- Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
Return type

dict

Returns

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.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
list_tags_for_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'ResourceArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • ResourceArn (string) --

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

    • Tags (list) --

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

      • (dict) --

        A list of objects specifying each key name and value.

        • Key (string) --

          The key associated with the tag.

        • Value (string) --

          The value associated with the tag.

Exceptions

  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
start_change_set(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.start_change_set(
    Catalog='string',
    ChangeSet=[
        {
            'ChangeType': 'string',
            'Entity': {
                'Type': 'string',
                'Identifier': 'string'
            },
            'EntityTags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Details': 'string',
            'ChangeName': 'string'
        },
    ],
    ChangeSetName='string',
    ClientRequestToken='string',
    ChangeSetTags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Catalog (string) --

    [REQUIRED]

    The catalog related to the request. Fixed value: AWSMarketplace

  • ChangeSet (list) --

    [REQUIRED]

    Array of change object.

    • (dict) --

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

      • ChangeType (string) -- [REQUIRED]

        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.

      • Entity (dict) -- [REQUIRED]

        The entity to be changed.

        • Type (string) -- [REQUIRED]

          The type of entity.

        • Identifier (string) --

          The identifier for the entity.

      • EntityTags (list) --

        The tags associated with the change.

        • (dict) --

          A list of objects specifying each key name and value.

          • Key (string) -- [REQUIRED]

            The key associated with the tag.

          • Value (string) -- [REQUIRED]

            The value associated with the tag.

      • Details (string) -- [REQUIRED]

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

      • ChangeName (string) --

        Optional name for the change.

  • ChangeSetName (string) -- 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 (string) --

    A unique token to identify the request to ensure idempotency.

    This field is autopopulated if not provided.

  • ChangeSetTags (list) --

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

    • (dict) --

      A list of objects specifying each key name and value.

      • Key (string) -- [REQUIRED]

        The key associated with the tag.

      • Value (string) -- [REQUIRED]

        The value associated with the tag.

Return type

dict

Returns

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.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.ResourceInUseException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
  • MarketplaceCatalog.Client.exceptions.ServiceQuotaExceededException
tag_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

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

  • Tags (list) --

    [REQUIRED]

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

    • (dict) --

      A list of objects specifying each key name and value.

      • Key (string) -- [REQUIRED]

        The key associated with the tag.

      • Value (string) -- [REQUIRED]

        The value associated with the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException
untag_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

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

  • TagKeys (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException

Paginators

The available paginators are: