Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeChangeSet

Provides information about a given change set.

Request Syntax


GET /DescribeChangeSet?catalog=Catalog&changeSetId=ChangeSetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Catalog

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z]+$

Required: Yes

ChangeSetId

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w\-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ChangeSet": [ 
      { 
         "ChangeName": "string",
         "ChangeType": "string",
         "Details": "string",
         "DetailsDocument": JSON value,
         "Entity": { 
            "Identifier": "string",
            "Type": "string"
         },
         "ErrorDetailList": [ 
            { 
               "ErrorCode": "string",
               "ErrorMessage": "string"
            }
         ]
      }
   ],
   "ChangeSetArn": "string",
   "ChangeSetId": "string",
   "ChangeSetName": "string",
   "EndTime": "string",
   "FailureCode": "string",
   "FailureDescription": "string",
   "Intent": "string",
   "StartTime": "string",
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeSet

An array of ChangeSummary objects.

Type: Array of ChangeSummary objects

ChangeSetArn

The ARN associated with the unique identifier for the change set referenced in this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9:*/-]+$

ChangeSetId

Required. The unique identifier for the change set referenced in this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w\-]+$

ChangeSetName

The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[\w\s+=.:@-]+$

EndTime

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.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^([\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$

FailureCode

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.

Type: String

Valid Values: CLIENT_ERROR | SERVER_FAULT

FailureDescription

Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(.)+$

Intent

The optional intent provided in the StartChangeSet request. If you do not provide an intent, APPLY is set by default.

Type: String

Valid Values: VALIDATE | APPLY

StartTime

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^([\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$

Status

The status of the change request.

Type: String

Valid Values: PREPARING | APPLYING | SUCCEEDED | CANCELLED | FAILED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP status code: 403

HTTP Status Code: 403

InternalServiceException

There was an internal service exception.

HTTP status code: 500

HTTP Status Code: 500

ResourceNotFoundException

The specified resource wasn't found.

HTTP status code: 404

HTTP Status Code: 404

ThrottlingException

Too many requests.

HTTP status code: 429

HTTP Status Code: 429

ValidationException

An error occurred during validation.

HTTP status code: 422

HTTP Status Code: 422