2021/04/30 - AWS Marketplace Catalog Service - 2 updated api methods
Changes Allows user defined names for Changes in a ChangeSet. Users can use ChangeNames to reference properties in another Change within a ChangeSet. This feature allows users to make changes to an entity when the entity identifier is not yet available while constructing the StartChangeSet request.
{'ChangeSet': {'ChangeName': 'string'}}
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',
'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.
{'ChangeSet': {'ChangeName': 'string'}}
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
client.start_change_set(
Catalog='string',
ChangeSet=[
{
'ChangeType': 'string',
'Entity': {
'Type': 'string',
'Identifier': 'string'
},
'Details': 'string',
'ChangeName': '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.
ChangeName (string) --
Optional name for the 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.