describe_db_subnet_groups ¶

describe_db_subnet_groups(
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_subnet_group_name: Optional[String] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DBSubnetGroupMessage

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

Parameters:

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

The name of the subnet group to return details for.
filters (Optional[FilterList], default: None ) –

This parameter is not currently supported.
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.
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.

Raises:

DBSubnetGroupNotFoundFault –

DBSubnetGroupName doesn't refer to an existing subnet group.
UnknownServiceError –

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

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

def describe_db_subnet_groups(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_subnet_group_name: Optional["capo_docdb.types.string.String"] = None,
    filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
    max_records: Optional[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_docdb.types.string.String"] = None,
) -> "capo_docdb.types.db_subnet_group_message.DBSubnetGroupMessage":
    """<p>Returns a list of <code>DBSubnetGroup</code> descriptions. If a <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the specified <code>DBSubnetGroup</code>.</p>

    Args:
        db_subnet_group_name: <p>The name of the subnet group to return details for.</p>
        filters: <p>This parameter is not currently supported.</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>
        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>

    Raises:
        capo_docdb.errors.db_subnet_group_not_found_fault.DBSubnetGroupNotFoundFault: <p> <code>DBSubnetGroupName</code> doesn't refer to an existing subnet group. </p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb.types.describe_db_subnet_groups_message.DescribeDBSubnetGroupsMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.db_subnet_group_message.DBSubnetGroupMessage"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.describe_db_subnet_groups

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.describe_db_subnet_groups.describe_db_subnet_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBSubnetGroups")
    )
    input_: capo_docdb.types.describe_db_subnet_groups_message.DescribeDBSubnetGroupsMessage = {}
    if db_subnet_group_name is not None:
        input_["db_subnet_group_name"] = db_subnet_group_name
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output