Skip to content

describe_stack_set_operation

Operation

describe_stack_set_operation

describe_stack_set_operation(request: DescribeStackSetOperationInput | DescribeStackSetOperationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStackSetOperationInputDict]) -> DescribeStackSetOperationOutput

Returns the description of the specified StackSet operation.

Note

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

Parameters:

Name Type Description Default
request DescribeStackSetOperationInput | DescribeStackSetOperationInputDict | 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[DescribeStackSetOperationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeStackSetOperationOutput

An instance of DescribeStackSetOperationOutput.

describe_stack_set_operation async

describe_stack_set_operation(request: DescribeStackSetOperationInput | DescribeStackSetOperationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStackSetOperationInputDict]) -> DescribeStackSetOperationOutput

Returns the description of the specified StackSet operation.

Note

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

Parameters:

Name Type Description Default
request DescribeStackSetOperationInput | DescribeStackSetOperationInputDict | 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[DescribeStackSetOperationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeStackSetOperationOutput

An instance of DescribeStackSetOperationOutput.

Input

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

DescribeStackSetOperationInputDict

Bases: TypedDict

Dictionary form of DescribeStackSetOperationInput.

Attributes

call_as instance-attribute
call_as: str | None

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

operation_id instance-attribute
operation_id: Required[str]

The unique ID of the StackSet operation.

stack_set_name instance-attribute
stack_set_name: Required[str]

The name or the unique stack ID of the StackSet for the stack operation.

DescribeStackSetOperationInput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackSetOperationInput structure.

Attributes

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

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

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

The unique ID of the StackSet operation.

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

The name or the unique stack ID of the StackSet for the stack operation.

Output

DescribeStackSetOperationOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackSetOperationOutput structure.

Attributes

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_set_operation class-attribute instance-attribute
stack_set_operation: StackSetOperation | None = ...

The specified StackSet operation.