change_sets

Creates, updates, deletes, gets or lists a change_sets resource.

Overview

Name	change_sets
Type	Resource
Id	aws.marketplace_catalog.change_sets

Fields

The following fields are returned by SELECT queries:

describe_change_set

Name	Datatype	Description
change_set	array	An array of ChangeSummary objects.
change_set_arn	string	The ARN associated with the unique identifier for the change set referenced in this request. (pattern: <code>^[a-zA-Z0-9:*/-]+$</code>)
change_set_id	string	Required. The unique identifier for the change set referenced in this request. (pattern: <code>^[\w-]+$</code>)
change_set_name	string	The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default. (pattern: <code>^[\w\s+=.:@-]+$</code>)
end_time	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. (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)
failure_code	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. (CLIENT_ERROR, SERVER_FAULT)
failure_description	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. (pattern: <code>^(.)+$</code>)
intent	string	The optional intent provided in the StartChangeSet request. If you do not provide an intent, APPLY is set by default. (VALIDATE, APPLY)
start_time	string	The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started. (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)
status	string	The status of the change request. (PREPARING, APPLYING, SUCCEEDED, CANCELLED, FAILED)

list_change_sets

Name	Datatype	Description
change_set_arn	string	The ARN associated with the unique identifier for the change set referenced in this request. (pattern: <code>^[a-zA-Z0-9:*/-]+$</code>)
change_set_id	string	The unique identifier for a change set. (pattern: <code>^[\w-]+$</code>)
change_set_name	string	The non-unique name for the change set. (pattern: <code>^[\w\s+=.:@-]+$</code>)
end_time	string	The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished. (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)
entity_id_list	array	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.
failure_code	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. (CLIENT_ERROR, SERVER_FAULT)
start_time	string	The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started. (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)
status	string	The current status of the change set. (PREPARING, APPLYING, SUCCEEDED, CANCELLED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_change_set	select	catalog, changeSetId, region		Provides information about a given change set.
list_change_sets	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalog	string	Required. The catalog related to the request. Fixed value: AWSMarketplace
changeSetId	string	Required. The unique identifier for the StartChangeSet request that you want to describe the details for.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_change_set

Provides information about a given change set.

SELECT
change_set,
change_set_arn,
change_set_id,
change_set_name,
end_time,
failure_code,
failure_description,
intent,
start_time,
status
FROM aws.marketplace_catalog.change_sets
WHERE catalog = '{{ catalog }}' -- required
AND changeSetId = '{{ changeSetId }}' -- required
AND region = '{{ region }}' -- required
;

list_change_sets

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.

SELECT
change_set_arn,
change_set_id,
change_set_name,
end_time,
entity_id_list,
failure_code,
start_time,
status
FROM aws.marketplace_catalog.change_sets
WHERE region = '{{ region }}' -- required
;