Returns summary information about operations performed on a StackSet.
This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.
Parameters:
-
stack_set_name
(Optional[StackSetName], default:
None
)
–
The name or unique ID of the StackSet that you want to get operation summaries for.
-
next_token
(Optional[NextToken], default:
None
)
–
The token for the next set of items to return. (You received this token from a previous call.)
-
max_results
(Optional[MaxResults], default:
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.
-
call_as
(Optional[CallAs], default:
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.
Raises:
Source code in docs_src/capo_cloudformation/_services/async_cloud_formation.py
| async def list_stack_set_operations(
self,
*,
config_overrides: Optional[AsyncCloudFormationClientConfig] = None,
stack_set_name: Optional[
"capo_cloudformation.types.stack_set_name.StackSetName"
] = None,
next_token: Optional["capo_cloudformation.types.next_token.NextToken"] = None,
max_results: Optional[
"capo_cloudformation.types.max_results.MaxResults"
] = None,
call_as: Optional["capo_cloudformation.types.call_as.CallAs"] = None,
) -> "capo_cloudformation.types.list_stack_set_operations_output.ListStackSetOperationsOutput":
"""<p>Returns summary information about operations performed on a StackSet.</p> <note> <p>This API provides <i>eventually consistent</i> reads meaning it may take some time but will eventually return the most up-to-date data.</p> </note>
Args:
stack_set_name: <p>The name or unique ID of the StackSet that you want to get operation summaries for.</p>
next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
max_results: <p>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 <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>
call_as: <p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>
Raises:
capo_cloudformation.errors.stack_set_not_found_exception.StackSetNotFoundException: <p>The specified StackSet doesn't exist.</p>
capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_cloudformation.types.list_stack_set_operations_input.ListStackSetOperationsInput]",
) -> AsyncOperationResponse[
"capo_cloudformation.types.list_stack_set_operations_output.ListStackSetOperationsOutput"
]:
import capo_cloudformation._operations.cloud_formation.list_stack_set_operations
(
output,
http_response,
) = await capo_cloudformation._operations.cloud_formation.list_stack_set_operations.async_list_stack_set_operations(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListStackSetOperations")
)
input_: capo_cloudformation.types.list_stack_set_operations_input.ListStackSetOperationsInput = {}
if stack_set_name is not None:
input_["stack_set_name"] = stack_set_name
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if call_as is not None:
input_["call_as"] = call_as
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|