Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
Parameters:
-
work_ids
(Optional[ReplacePermissionAssociationsWorkIdList], default:
None
)
–
A list of IDs. These values come from the idfield of the replacePermissionAssociationsWorkstructure returned by the ReplacePermissionAssociations operation.
-
status
(Optional[ReplacePermissionAssociationsWorkStatus], default:
None
)
–
Specifies that you want to see only the details about requests with a status that matches this value.
-
next_token
(Optional[String], default:
None
)
–
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
Raises:
-
InvalidNextTokenException
–
The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.
-
InvalidParameterException
–
The operation failed because a parameter you specified isn't valid.
-
ServerInternalException
–
The operation failed because the service could not respond to the request due to an internal problem. Try again later.
-
ServiceUnavailableException
–
The operation failed because the service isn't available. Try again later.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_ram/_services/async_ram.py
| async def list_replace_permission_associations_work(
self,
*,
config_overrides: Optional[AsyncRAMClientConfig] = None,
work_ids: Optional[
"capo_ram.types.replace_permission_associations_work_id_list.ReplacePermissionAssociationsWorkIdList"
] = None,
status: Optional[
"capo_ram.types.replace_permission_associations_work_status.ReplacePermissionAssociationsWorkStatus"
] = None,
next_token: Optional["capo_ram.types.string.String"] = None,
max_results: Optional["capo_ram.types.max_results.MaxResults"] = None,
) -> "capo_ram.types.list_replace_permission_associations_work_response.ListReplacePermissionAssociationsWorkResponse":
"""<p>Retrieves the current status of the asynchronous tasks performed by RAM when you perform the <a>ReplacePermissionAssociationsWork</a> operation.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note>
Args:
work_ids: <p>A list of IDs. These values come from the <code>id</code>field of the <code>replacePermissionAssociationsWork</code>structure returned by the <a>ReplacePermissionAssociations</a> operation. </p>
status: <p>Specifies that you want to see only the details about requests with a status that matches this value.</p>
next_token: <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
max_results: <p>Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p>
Raises:
capo_ram.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The operation failed because the specified value for <code>NextToken</code> isn't valid. You must specify a value you received in the <code>NextToken</code> response of a previous call to this operation.</p>
capo_ram.errors.invalid_parameter_exception.InvalidParameterException: <p>The operation failed because a parameter you specified isn't valid.</p>
capo_ram.errors.server_internal_exception.ServerInternalException: <p>The operation failed because the service could not respond to the request due to an internal problem. Try again later.</p>
capo_ram.errors.service_unavailable_exception.ServiceUnavailableException: <p>The operation failed because the service isn't available. Try again later.</p>
capo_ram.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_ram.types.list_replace_permission_associations_work_request.ListReplacePermissionAssociationsWorkRequest]",
) -> AsyncOperationResponse[
"capo_ram.types.list_replace_permission_associations_work_response.ListReplacePermissionAssociationsWorkResponse"
]:
import capo_ram._operations.amazon_resource_sharing.list_replace_permission_associations_work
(
output,
http_response,
) = await capo_ram._operations.amazon_resource_sharing.list_replace_permission_associations_work.async_list_replace_permission_associations_work(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListReplacePermissionAssociationsWork")
)
input_: capo_ram.types.list_replace_permission_associations_work_request.ListReplacePermissionAssociationsWorkRequest = {}
if work_ids is not None:
input_["work_ids"] = work_ids
if status is not None:
input_["status"] = status
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|