DescribeChangeSetHooks
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ChangeSetName
-
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*Required: Yes
- LogicalResourceId
-
If specified, lists only the hooks related to the specified
LogicalResourceId.Type: String
Required: No
- NextToken
-
A string, provided by the
DescribeChangeSetHooksresponse output, that identifies the next page of information that you want to retrieve.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- StackName
-
If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)Required: No
Response Elements
The following elements are returned by the service.
- ChangeSetId
-
The change set identifier (stack ID).
Type: String
Length Constraints: Minimum length of 1.
Pattern:
arn:[-a-zA-Z0-9:/]* - ChangeSetName
-
The change set name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z][-a-zA-Z0-9]* - Hooks.member.N
-
List of hook objects.
Type: Array of ChangeSetHook objects
- NextToken
-
Pagination token,
nullor empty if no more results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- StackId
-
The stack identifier (stack ID).
Type: String
- StackName
-
The stack name.
Type: String
- Status
-
Provides the status of the change set hook.
Type: String
Valid Values:
PLANNING | PLANNED | UNAVAILABLE
Errors
For information about the errors that are common to all actions, see Common Errors.
- ChangeSetNotFound
-
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSetsoperation.HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
