Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.
Resource operation requests expire after 7 days.
Parameters:
-
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.
The default is 20.
-
next_token
(Optional[NextToken], default:
None
)
–
If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
-
resource_request_status_filter
(Optional[ResourceRequestStatusFilter], default:
None
)
–
The filter criteria to apply to the requests returned.
Raises:
Source code in docs_src/capo_cloudcontrol/_services/cloud_control.py
| def list_resource_requests(
self,
*,
config_overrides: Optional[CloudControlClientConfig] = None,
max_results: Optional["capo_cloudcontrol.types.max_results.MaxResults"] = None,
next_token: Optional["capo_cloudcontrol.types.next_token.NextToken"] = None,
resource_request_status_filter: Optional[
"capo_cloudcontrol.types.resource_request_status_filter.ResourceRequestStatusFilter"
] = None,
) -> "capo_cloudcontrol.types.list_resource_requests_output.ListResourceRequestsOutput":
"""<p>Returns existing resource operation requests. This includes requests of all status types. For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list">Listing active resource operation requests</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <note> <p>Resource operation requests expire after 7 days.</p> </note>
Args:
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> <p>The default is <code>20</code>.</p>
next_token: <p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
resource_request_status_filter: <p>The filter criteria to apply to the requests returned.</p>
Raises:
capo_cloudcontrol.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cloudcontrol.types.list_resource_requests_input.ListResourceRequestsInput]",
) -> OperationResponse[
"capo_cloudcontrol.types.list_resource_requests_output.ListResourceRequestsOutput"
]:
import capo_cloudcontrol._operations.cloud_api_service.list_resource_requests
output, http_response = (
capo_cloudcontrol._operations.cloud_api_service.list_resource_requests.list_resource_requests(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_cloudcontrol.types.list_resource_requests_output.ListResourceRequestsOutput",
) -> dict[str, Any]:
import capo_cloudcontrol.types.list_resource_requests_output
return (
capo_cloudcontrol.types.list_resource_requests_output.redact_sensitive(
output
)
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("ListResourceRequests", redact_output=_redact_output),
)
input_: capo_cloudcontrol.types.list_resource_requests_input.ListResourceRequestsInput = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if resource_request_status_filter is not None:
input_["resource_request_status_filter"] = resource_request_status_filter
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|