Skip to content

list_pending_maintenance_actions async

list_pending_maintenance_actions(
    *,
    config_overrides: Optional[AsyncDocDBElasticClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[int] = None,
) -> ListPendingMaintenanceActionsOutput

Retrieves a list of all maintenance actions that are pending.

Parameters:

  • next_token (Optional[PaginationToken], default: None ) –

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by maxResults.

  • max_results (Optional[int], default: None ) –

    The maximum number of results to include in the response. If more records exist than the specified maxResults value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Raises:

Source code in docs_src/capo_docdb_elastic/_services/async_doc_db_elastic.py
async def list_pending_maintenance_actions(
    self,
    *,
    config_overrides: Optional[AsyncDocDBElasticClientConfig] = None,
    next_token: Optional[
        "capo_docdb_elastic.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[int] = None,
) -> "capo_docdb_elastic.types.list_pending_maintenance_actions_output.ListPendingMaintenanceActionsOutput":
    """<p>Retrieves a list of all maintenance actions that are pending.</p>

    Args:
        next_token: <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>maxResults</code>.</p>
        max_results: <p>The maximum number of results to include in the response. If more records exist than the specified <code>maxResults</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p>

    Raises:
        capo_docdb_elastic.errors.access_denied_exception.AccessDeniedException: <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
        capo_docdb_elastic.errors.internal_server_exception.InternalServerException: <p>There was an internal server error.</p>
        capo_docdb_elastic.errors.throttling_exception.ThrottlingException: <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
        capo_docdb_elastic.errors.validation_exception.ValidationException: <p>A structure defining a validation exception.</p>
        capo_docdb_elastic.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_docdb_elastic.types.list_pending_maintenance_actions_input.ListPendingMaintenanceActionsInput]",
    ) -> AsyncOperationResponse[
        "capo_docdb_elastic.types.list_pending_maintenance_actions_output.ListPendingMaintenanceActionsOutput"
    ]:
        import capo_docdb_elastic._operations.chimera_db_lionfish_service_lambda.list_pending_maintenance_actions

        (
            output,
            http_response,
        ) = await capo_docdb_elastic._operations.chimera_db_lionfish_service_lambda.list_pending_maintenance_actions.async_list_pending_maintenance_actions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPendingMaintenanceActions")
    )
    input_: capo_docdb_elastic.types.list_pending_maintenance_actions_input.ListPendingMaintenanceActionsInput = {}
    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