CloudFormation / Client / describe_stack_refactor

describe_stack_refactor

CloudFormation.Client.describe_stack_refactor(**kwargs)

Describes the stack refactor status.

See also: AWS API Documentation

Request Syntax

response = client.describe_stack_refactor(
    StackRefactorId='string'
)
Parameters:

StackRefactorId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Description': 'string',
    'StackRefactorId': 'string',
    'StackIds': [
        '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'
}

Response Structure

  • (dict) –

    • Description (string) –

      A description to help you identify the refactor.

    • StackRefactorId (string) –

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

    • StackIds (list) –

      The unique ID for each stack.

      • (string) –

    • ExecutionStatus (string) –

      The stack refactor execution 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 operation Status.

Exceptions