CloudFormation / Client / describe_change_set_hooks

describe_change_set_hooks#

CloudFormation.Client.describe_change_set_hooks(**kwargs)#

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

See also: AWS API Documentation

Request Syntax

response = client.describe_change_set_hooks(
    ChangeSetName='string',
    StackName='string',
    NextToken='string',
    LogicalResourceId='string'
)
Parameters:

  • ChangeSetName (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

  • StackName (string) – 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.

  • NextToken (string) – A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of information that you want to retrieve.

  • LogicalResourceId (string) – If specified, lists only the hooks related to the specified LogicalResourceId.

Return type:

dict

Returns:

Response Syntax

{
    'ChangeSetId': 'string',
    'ChangeSetName': 'string',
    'Hooks': [
        {
            'InvocationPoint': 'PRE_PROVISION',
            'FailureMode': 'FAIL'|'WARN',
            'TypeName': 'string',
            'TypeVersionId': 'string',
            'TypeConfigurationVersionId': 'string',
            'TargetDetails': {
                'TargetType': 'RESOURCE',
                'ResourceTargetDetails': {
                    'LogicalResourceId': 'string',
                    'ResourceType': 'string',
                    'ResourceAction': 'Add'|'Modify'|'Remove'|'Import'|'Dynamic'
                }
            }
        },
    ],
    'Status': 'PLANNING'|'PLANNED'|'UNAVAILABLE',
    'NextToken': 'string',
    'StackId': 'string',
    'StackName': 'string'
}

Response Structure

  • (dict) –

    • ChangeSetId (string) –

      The change set identifier (stack ID).

    • ChangeSetName (string) –

      The change set name.

    • Hooks (list) –

      List of hook objects.

      • (dict) –

        Specifies the resource, the hook, and the hook version to be invoked.

        • InvocationPoint (string) –

          Specifies the points in provisioning logic where a hook is invoked.

        • FailureMode (string) –

          Specify the hook failure mode for non-compliant resources in the followings ways.

          • FAIL Stops provisioning resources.

          • WARN Allows provisioning to continue with a warning message.

        • TypeName (string) –

          The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook.

          Note

          The following organization namespaces are reserved and can’t be used in your hook type names:

          • Alexa

          • AMZN

          • Amazon

          • ASK

          • AWS

          • Custom

          • Dev

        • TypeVersionId (string) –

          The version ID of the type specified.

        • TypeConfigurationVersionId (string) –

          The version ID of the type configuration.

        • TargetDetails (dict) –

          Specifies details about the target that the hook will run against.

          • TargetType (string) –

            The name of the type.

          • ResourceTargetDetails (dict) –

            Required if TargetType is RESOURCE.

            • LogicalResourceId (string) –

              The resource’s logical ID, which is defined in the stack’s template.

            • ResourceType (string) –

              The type of CloudFormation resource, such as AWS::S3::Bucket.

            • ResourceAction (string) –

              Specifies the action of the resource.

    • Status (string) –

      Provides the status of the change set hook.

    • NextToken (string) –

      Pagination token, null or empty if no more results.

    • StackId (string) –

      The stack identifier (stack ID).

    • StackName (string) –

      The stack name.

Exceptions