Skip to content

describe_change_set async

describe_change_set(
    *,
    config_overrides: Optional[AsyncCloudFormationClientConfig] = None,
    change_set_name: Optional[ChangeSetNameOrId] = None,
    stack_name: Optional[StackNameOrId] = None,
    next_token: Optional[NextToken] = None,
    include_property_values: Optional[IncludePropertyValues] = None,
) -> DescribeChangeSetOutput

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.

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 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.)

  • include_property_values (Optional[IncludePropertyValues], default: None ) –

    If true, the returned changes include detailed changes in the property values.

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/async_cloud_formation.py
async def describe_change_set(
    self,
    *,
    config_overrides: Optional[AsyncCloudFormationClientConfig] = 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,
    include_property_values: Optional[
        "capo_cloudformation.types.include_property_values.IncludePropertyValues"
    ] = None,
) -> "capo_cloudformation.types.describe_change_set_output.DescribeChangeSetOutput":
    """<p>Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html">Update CloudFormation stacks using change sets</a> in the <i>CloudFormation User Guide</i>.</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 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>
        include_property_values: <p>If <code>true</code>, the returned changes include detailed changes in the property values.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudformation.types.describe_change_set_input.DescribeChangeSetInput]",
    ) -> AsyncOperationResponse[
        "capo_cloudformation.types.describe_change_set_output.DescribeChangeSetOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_change_set

        (
            output,
            http_response,
        ) = await capo_cloudformation._operations.cloud_formation.describe_change_set.async_describe_change_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeChangeSet")
    )
    input_: capo_cloudformation.types.describe_change_set_input.DescribeChangeSetInput = {}
    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 include_property_values is not None:
        input_["include_property_values"] = include_property_values

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output