Returns a list of operations events.
Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.
Parameters:
-
operation_id
(OperationId)
–
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If you do not specify a value for MaxResults, the request returns 50 items per page by default.
-
next_token
(Optional[NextToken], default:
None
)
–
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
-
filters
(Optional[FilterList], default:
None
)
–
Optionally specify filters to narrow the returned operation event items.
Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals.
Raises:
Source code in docs_src/capo_ssm_sap/_services/ssm_sap.py
| def list_operation_events(
self,
operation_id: "capo_ssm_sap.types.operation_id.OperationId",
*,
config_overrides: Optional[SsmSapClientConfig] = None,
max_results: Optional["capo_ssm_sap.types.max_results.MaxResults"] = None,
next_token: Optional["capo_ssm_sap.types.next_token.NextToken"] = None,
filters: Optional["capo_ssm_sap.types.filter_list.FilterList"] = None,
) -> "capo_ssm_sap.types.list_operation_events_output.ListOperationEventsOutput":
"""<p>Returns a list of operations events.</p> <p>Available parameters include <code>OperationID</code>, as well as optional parameters <code>MaxResults</code>, <code>NextToken</code>, and <code>Filters</code>.</p>
Args:
operation_id: <p>The ID of the operation.</p>
max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.</p> <p>If you do not specify a value for <code>MaxResults</code>, the request returns 50 items per page by default.</p>
next_token: <p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>
filters: <p>Optionally specify filters to narrow the returned operation event items.</p> <p>Valid filter names include <code>status</code>, <code>resourceID</code>, and <code>resourceType</code>. The valid operator for all three filters is <code>Equals</code>.</p>
Raises:
capo_ssm_sap.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
capo_ssm_sap.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service. </p>
capo_ssm_sap.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ssm_sap.types.list_operation_events_input.ListOperationEventsInput]",
) -> OperationResponse[
"capo_ssm_sap.types.list_operation_events_output.ListOperationEventsOutput"
]:
import capo_ssm_sap._operations.ssm_sap.list_operation_events
output, http_response = (
capo_ssm_sap._operations.ssm_sap.list_operation_events.list_operation_events(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListOperationEvents")
)
input_: capo_ssm_sap.types.list_operation_events_input.ListOperationEventsInput = {
"operation_id": operation_id
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if filters is not None:
input_["filters"] = filters
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|