describe_pending_maintenance_actions `async` ¶

describe_pending_maintenance_actions(
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    resource_identifier: Optional[String] = None,
    filters: Optional[FilterList] = None,
    marker: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
) -> PendingMaintenanceActionsMessage

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

Parameters:

resource_identifier (Optional[String], default: None ) –

The ARN of a resource to return pending maintenance actions for.
filters (Optional[FilterList], default: None ) –
A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:
- db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
- db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.
marker (Optional[String], 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 MaxRecords.
max_records (Optional[IntegerOptional], default: None ) –

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

Default: 100

Constraints: Minimum 20, maximum 100.

Raises:

ResourceNotFoundFault –

The specified resource ID was not found.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_docdb/_services/async_doc_db.py

async def describe_pending_maintenance_actions(
    self,
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    resource_identifier: Optional["capo_docdb.types.string.String"] = None,
    filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
    marker: Optional["capo_docdb.types.string.String"] = None,
    max_records: Optional[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ] = None,
) -> "capo_docdb.types.pending_maintenance_actions_message.PendingMaintenanceActionsMessage":
    """<p>Returns a list of resources (for example, instances) that have at least one pending maintenance action.</p>

    Args:
        resource_identifier: <p>The ARN of a resource to return pending maintenance actions for.</p>
        filters: <p>A filter that specifies one or more resources to return pending maintenance actions for.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>
        marker: <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>MaxRecords</code>.</p>
        max_records: <p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>

    Raises:
        capo_docdb.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The specified resource ID was not found.</p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_docdb.types.describe_pending_maintenance_actions_message.DescribePendingMaintenanceActionsMessage]",
    ) -> AsyncOperationResponse[
        "capo_docdb.types.pending_maintenance_actions_message.PendingMaintenanceActionsMessage"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.describe_pending_maintenance_actions

        (
            output,
            http_response,
        ) = await capo_docdb._operations.amazon_rd_sv19.describe_pending_maintenance_actions.async_describe_pending_maintenance_actions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePendingMaintenanceActions")
    )
    input_: capo_docdb.types.describe_pending_maintenance_actions_message.DescribePendingMaintenanceActionsMessage = {}
    if resource_identifier is not None:
        input_["resource_identifier"] = resource_identifier
    if filters is not None:
        input_["filters"] = filters
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_pending_maintenance_actions async ¶

describe_pending_maintenance_actions `async` ¶