describe_db_shard_groups ¶

def describe_db_shard_groups(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_shard_group_identifier: Optional[
        "capo_rds.types.db_shard_group_identifier.DBShardGroupIdentifier"
    ] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
    max_records: Optional["capo_rds.types.max_records.MaxRecords"] = None,
) -> (
    "capo_rds.types.describe_db_shard_groups_response.DescribeDBShardGroupsResponse"
):
    """<p>Describes existing Aurora Limitless Database DB shard groups.</p>

    Args:
        db_shard_group_identifier: <p>The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an existing DB shard group identifier.</p> </li> </ul>
        filters: <p>A filter that specifies one or more DB shard groups to describe.</p>
        marker: <p>An optional pagination token provided by a previous <code>DescribeDBShardGroups</code> 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 called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100</p>

    Raises:
        capo_rds.errors.db_cluster_not_found_fault.DBClusterNotFoundFault: <p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
        capo_rds.errors.db_shard_group_not_found_fault.DBShardGroupNotFoundFault: <p>The specified DB shard group name wasn't found.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_db_shard_groups_message.DescribeDBShardGroupsMessage]",
    ) -> OperationResponse[
        "capo_rds.types.describe_db_shard_groups_response.DescribeDBShardGroupsResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_db_shard_groups

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_db_shard_groups.describe_db_shard_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBShardGroups")
    )
    input_: capo_rds.types.describe_db_shard_groups_message.DescribeDBShardGroupsMessage = {}
    if db_shard_group_identifier is not None:
        input_["db_shard_group_identifier"] = db_shard_group_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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output