Skip to content

list_stack_set_auto_deployment_targets

Operation

list_stack_set_auto_deployment_targets

list_stack_set_auto_deployment_targets(request: ListStackSetAutoDeploymentTargetsInput | ListStackSetAutoDeploymentTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStackSetAutoDeploymentTargetsInputDict]) -> ListStackSetAutoDeploymentTargetsOutput

Returns summary information about deployment targets for a StackSet.

Parameters:

Name Type Description Default
request ListStackSetAutoDeploymentTargetsInput | ListStackSetAutoDeploymentTargetsInputDict | 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[ListStackSetAutoDeploymentTargetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListStackSetAutoDeploymentTargetsOutput

An instance of ListStackSetAutoDeploymentTargetsOutput.

list_stack_set_auto_deployment_targets async

list_stack_set_auto_deployment_targets(request: ListStackSetAutoDeploymentTargetsInput | ListStackSetAutoDeploymentTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStackSetAutoDeploymentTargetsInputDict]) -> ListStackSetAutoDeploymentTargetsOutput

Returns summary information about deployment targets for a StackSet.

Parameters:

Name Type Description Default
request ListStackSetAutoDeploymentTargetsInput | ListStackSetAutoDeploymentTargetsInputDict | 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[ListStackSetAutoDeploymentTargetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListStackSetAutoDeploymentTargetsOutput

An instance of ListStackSetAutoDeploymentTargetsOutput.

Input

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

ListStackSetAutoDeploymentTargetsInputDict

Bases: TypedDict

Dictionary form of ListStackSetAutoDeploymentTargetsInput.

Attributes

call_as instance-attribute
call_as: str | None

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.

max_results instance-attribute
max_results: int | None

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.

next_token instance-attribute
next_token: str | None

The token for the next set of items to return. (You received this token from a previous call.)

stack_set_name instance-attribute
stack_set_name: Required[str]

The name or unique ID of the StackSet that you want to get automatic deployment targets for.

ListStackSetAutoDeploymentTargetsInput dataclass

Bases: _SerdeShape

Dataclass for ListStackSetAutoDeploymentTargetsInput structure.

Attributes

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

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

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

The token for the next set of items to return. (You received this token from a previous call.)

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

The name or unique ID of the StackSet that you want to get automatic deployment targets for.

Output

ListStackSetAutoDeploymentTargetsOutput dataclass

Bases: _SerdeShape

Dataclass for ListStackSetAutoDeploymentTargetsOutput structure.

Attributes

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

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.

summaries class-attribute instance-attribute
summaries: list[StackSetAutoDeploymentTargetSummary] | None = ...

An array of summaries of the deployment targets for the StackSet.