Skip to content

describe_change_set_hooks

describe_change_set_hooks(
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    change_set_name: Optional[ChangeSetNameOrId] = None,
    stack_name: Optional[StackNameOrId] = None,
    next_token: Optional[NextToken] = None,
    logical_resource_id: Optional[LogicalResourceId] = None,
) -> DescribeChangeSetHooksOutput

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

Parameters:

  • change_set_name (Optional[ChangeSetNameOrId], default: None ) –

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

  • stack_name (Optional[StackNameOrId], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of items to return. (You received this token from a previous call.)

  • logical_resource_id (Optional[LogicalResourceId], default: None ) –

    If specified, lists only the Hooks related to the specified LogicalResourceId.

Raises:

  • ChangeSetNotFoundException –

    The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets operation.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
def describe_change_set_hooks(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    change_set_name: Optional[
        "capo_cloudformation.types.change_set_name_or_id.ChangeSetNameOrId"
    ] = None,
    stack_name: Optional[
        "capo_cloudformation.types.stack_name_or_id.StackNameOrId"
    ] = None,
    next_token: Optional["capo_cloudformation.types.next_token.NextToken"] = None,
    logical_resource_id: Optional[
        "capo_cloudformation.types.logical_resource_id.LogicalResourceId"
    ] = None,
) -> "capo_cloudformation.types.describe_change_set_hooks_output.DescribeChangeSetHooksOutput":
    """<p>Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.</p>

    Args:
        change_set_name: <p>The name or Amazon Resource Name (ARN) of the change set that you want to describe.</p>
        stack_name: <p>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.</p>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
        logical_resource_id: <p>If specified, lists only the Hooks related to the specified <code>LogicalResourceId</code>.</p>

    Raises:
        capo_cloudformation.errors.change_set_not_found_exception.ChangeSetNotFoundException: <p>The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the <code>ListChangeSets</code> operation.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.describe_change_set_hooks_input.DescribeChangeSetHooksInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.describe_change_set_hooks_output.DescribeChangeSetHooksOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_change_set_hooks

        output, http_response = (
            capo_cloudformation._operations.cloud_formation.describe_change_set_hooks.describe_change_set_hooks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeChangeSetHooks")
    )
    input_: capo_cloudformation.types.describe_change_set_hooks_input.DescribeChangeSetHooksInput = {}
    if change_set_name is not None:
        input_["change_set_name"] = change_set_name
    if stack_name is not None:
        input_["stack_name"] = stack_name
    if next_token is not None:
        input_["next_token"] = next_token
    if logical_resource_id is not None:
        input_["logical_resource_id"] = logical_resource_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output