CloudFormation / Client / list_stack_refactors

list_stack_refactors

CloudFormation.Client.list_stack_refactors(**kwargs)

Lists all account stack refactor operations and their statuses.

See also: AWS API Documentation

Request Syntax

response = client.list_stack_refactors(
    ExecutionStatusFilter=[
        'UNAVAILABLE'|'AVAILABLE'|'OBSOLETE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ExecutionStatusFilter (list) –

    Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes.

    • (string) –

  • NextToken (string) – If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

  • MaxResults (integer) – The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'StackRefactorSummaries': [
        {
            'StackRefactorId': 'string',
            'Description': 'string',
            'ExecutionStatus': 'UNAVAILABLE'|'AVAILABLE'|'OBSOLETE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
            'ExecutionStatusReason': 'string',
            'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED',
            'StatusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • StackRefactorSummaries (list) –

      Provides a summary of a stack refactor, including the following:

      • StackRefactorId

      • Status

      • StatusReason

      • ExecutionStatus

      • ExecutionStatusReason

      • Description

      • (dict) –

        The summary of a stack refactor operation.

        • StackRefactorId (string) –

          The ID associated with the stack refactor created from the CreateStackRefactor action.

        • Description (string) –

          A description to help you identify the refactor.

        • ExecutionStatus (string) –

          The operation status that’s provided after calling the ExecuteStackRefactor action.

        • ExecutionStatusReason (string) –

          A detailed explanation for the stack refactor ExecutionStatus.

        • Status (string) –

          The stack refactor operation status that’s provided after calling the CreateStackRefactor action.

        • StatusReason (string) –

          A detailed explanation for the stack refactor Status.

    • NextToken (string) –

      If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.