describe_db_subnet_groups `async` ¶

describe_db_subnet_groups(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = 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.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Parameters:

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

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

This parameter isn't 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 called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.
marker (Optional[String], default: None ) –

An optional pagination token provided by a previous DescribeDBSubnetGroups 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 DB subnet group.
UnknownServiceError –

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

Examples:

To describe a DB subnet group The following example retrieves the details of the specified DB subnet group.

>>> await client.describe_db_subnet_groups()

Source code in docs_src/capo_rds/_services/async_rds.py

async def describe_db_subnet_groups(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_subnet_group_name: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.db_subnet_group_message.DBSubnetGroupMessage":
    """<p>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.</p> <p>For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>.</p>

    Args:
        db_subnet_group_name: <p>The name of the DB subnet group to return details for.</p>
        filters: <p>This parameter isn't 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 called a marker is included in the response so that you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
        marker: <p>An optional pagination token provided by a previous DescribeDBSubnetGroups 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_rds.errors.db_subnet_group_not_found_fault.DBSubnetGroupNotFoundFault: <p> <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe a DB subnet group
        The following example retrieves the details of the specified DB subnet group.

        >>> await client.describe_db_subnet_groups()
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.describe_db_subnet_groups_message.DescribeDBSubnetGroupsMessage]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.db_subnet_group_message.DBSubnetGroupMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_db_subnet_groups

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.describe_db_subnet_groups.async_describe_db_subnet_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBSubnetGroups")
    )
    input_: capo_rds.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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_db_subnet_groups async ¶

describe_db_subnet_groups `async` ¶