list_stack_set_operation_results¶
Operation¶
list_stack_set_operation_results
¶
list_stack_set_operation_results(request: ListStackSetOperationResultsInput | ListStackSetOperationResultsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStackSetOperationResultsInputDict]) -> ListStackSetOperationResultsOutput
Returns summary information about the results of a StackSet operation.
Note
This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListStackSetOperationResultsInput | ListStackSetOperationResultsInputDict | 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[ListStackSetOperationResultsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListStackSetOperationResultsOutput
|
An instance of |
list_stack_set_operation_results
async
¶
list_stack_set_operation_results(request: ListStackSetOperationResultsInput | ListStackSetOperationResultsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStackSetOperationResultsInputDict]) -> ListStackSetOperationResultsOutput
Returns summary information about the results of a StackSet operation.
Note
This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListStackSetOperationResultsInput | ListStackSetOperationResultsInputDict | 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[ListStackSetOperationResultsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListStackSetOperationResultsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListStackSetOperationResultsInputDict
¶
Bases: TypedDict
Dictionary form of ListStackSetOperationResultsInput.
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.
filters
instance-attribute
¶
filters: Sequence[OperationResultFilter | OperationResultFilterDict] | None
The filter to apply to operation results.
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.
ListStackSetOperationResultsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListStackSetOperationResultsInput 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.
filters
class-attribute
instance-attribute
¶
filters: list[OperationResultFilter] | None = ...
The filter to apply to operation results.
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.)
Output¶
ListStackSetOperationResultsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListStackSetOperationResultsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the request doesn't return all results, NextToken is set to a
token. To retrieve the next set of results, call ListOperationResults
again and assign that token to the request object's NextToken
parameter. If there are no remaining results, NextToken is set to
null.
response_metadata
class-attribute
instance-attribute
¶
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[StackSetOperationResultSummary] | None = ...
A list of StackSetOperationResultSummary structures that contain
information about the specified operation results, for accounts and
Amazon Web Services Regions that are included in the operation.