2019/11/12 - AWS Marketplace Catalog Service - 6 new api methods
Changes This is the first release for the AWS Marketplace Catalog service which allows you to list, describe and manage change requests on your published entities on AWS Marketplace.
Provides the list of entities of a given type.
See also: AWS API Documentation
Request Syntax
client.list_entities(
Catalog='string',
EntityType='string',
FilterList=[
{
'Name': 'string',
'ValueList': [
'string',
]
},
],
Sort={
'SortBy': 'string',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The catalog related to the request. Fixed value: AWSMarketplace
string
[REQUIRED]
The type of entities to retrieve.
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) --
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 .
string
The value of the next token, if it exists. Null if there are no more results.
integer
Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
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 provider.
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 subscribers. 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 subscribers can view it).
NextToken (string) --
The value of the next token if it exists. Null if there is no more result.
This operation allows you to request changes in your entities.
See also: AWS API Documentation
Request Syntax
client.start_change_set(
Catalog='string',
ChangeSet=[
{
'ChangeType': 'string',
'Entity': {
'Type': 'string',
'Identifier': 'string'
},
'Details': 'string'
},
],
ChangeSetName='string',
ClientRequestToken='string'
)
string
[REQUIRED]
The catalog related to the request. Fixed value: AWSMarketplace
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.
Details (string) -- [REQUIRED]
This object contains details specific to the change type of the requested change.
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.
string
A unique token to identify the request to ensure idempotency.
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.
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
client.cancel_change_set(
Catalog='string',
ChangeSetId='string'
)
string
[REQUIRED]
Required. The catalog related to the request. Fixed value: AWSMarketplace .
string
[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.
Provides information about a given change set.
See also: AWS API Documentation
Request Syntax
client.describe_change_set(
Catalog='string',
ChangeSetId='string'
)
string
[REQUIRED]
Required. The catalog related to the request. Fixed value: AWSMarketplace
string
[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',
'FailureDescription': 'string',
'ChangeSet': [
{
'ChangeType': 'string',
'Entity': {
'Type': 'string',
'Identifier': 'string'
},
'ErrorDetailList': [
{
'ErrorCode': 'string',
'ErrorMessage': '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.
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.
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.
Returns the metadata and content of the entity.
See also: AWS API Documentation
Request Syntax
client.describe_entity(
Catalog='string',
EntityId='string'
)
string
[REQUIRED]
Required. The catalog related to the request. Fixed value: AWSMarketplace
string
[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 change set 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.
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
client.list_change_sets(
Catalog='string',
FilterList=[
{
'Name': 'string',
'ValueList': [
'string',
]
},
],
Sort={
'SortBy': 'string',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The catalog related to the request. Fixed value: AWSMarketplace
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) --
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 .
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.
string
The token value retrieved from a previous call to access the next page of results.
dict
Response Syntax
{
'ChangeSetSummaryList': [
{
'ChangeSetId': 'string',
'ChangeSetArn': 'string',
'ChangeSetName': 'string',
'StartTime': 'string',
'EndTime': 'string',
'Status': 'PREPARING'|'APPLYING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
'EntityIdList': [
'string',
]
},
],
'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) --
NextToken (string) --
The value of the next token, if it exists. Null if there are no more results.