Skip to content

describe_stack_refactor

Operation

describe_stack_refactor

describe_stack_refactor(request: DescribeStackRefactorInput | DescribeStackRefactorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStackRefactorInputDict]) -> DescribeStackRefactorOutput

Describes the stack refactor status.

Parameters:

Name Type Description Default
request DescribeStackRefactorInput | DescribeStackRefactorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeStackRefactorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeStackRefactorOutput

An instance of DescribeStackRefactorOutput.

describe_stack_refactor async

describe_stack_refactor(request: DescribeStackRefactorInput | DescribeStackRefactorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStackRefactorInputDict]) -> DescribeStackRefactorOutput

Describes the stack refactor status.

Parameters:

Name Type Description Default
request DescribeStackRefactorInput | DescribeStackRefactorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeStackRefactorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeStackRefactorOutput

An instance of DescribeStackRefactorOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeStackRefactorInputDict

Bases: TypedDict

Dictionary form of DescribeStackRefactorInput.

Attributes

stack_refactor_id instance-attribute
stack_refactor_id: Required[str]

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

DescribeStackRefactorInput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackRefactorInput structure.

Attributes

stack_refactor_id class-attribute instance-attribute
stack_refactor_id: str | None = ...

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

Output

DescribeStackRefactorOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackRefactorOutput structure.

Attributes

description class-attribute instance-attribute
description: str | None = ...

A description to help you identify the refactor.

execution_status class-attribute instance-attribute
execution_status: str | None = ...

The stack refactor execution operation status that's provided after calling the ExecuteStackRefactor action.

execution_status_reason class-attribute instance-attribute
execution_status_reason: str | None = ...

A detailed explanation for the stack refactor ExecutionStatus.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

stack_ids class-attribute instance-attribute
stack_ids: list[str] | None = ...

The unique ID for each stack.

stack_refactor_id class-attribute instance-attribute
stack_refactor_id: str | None = ...

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

status class-attribute instance-attribute
status: str | None = ...

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

status_reason class-attribute instance-attribute
status_reason: str | None = ...

A detailed explanation for the stack refactor operation Status.