RDS / Client / describe_db_shard_groups

describe_db_shard_groups

RDS.Client.describe_db_shard_groups(**kwargs)

Describes existing Aurora Limitless Database DB shard groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_db_shard_groups(
    DBShardGroupIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)

Parameters:

• DBShardGroupIdentifier (string) –

  The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn’t case-sensitive.

  Constraints:

  • If supplied, must match an existing DB shard group identifier.

• Filters (list) –

  A filter that specifies one or more DB shard groups to describe.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribeDBRecommendations

    • DescribeDBShardGroups

    • DescribePendingMaintenanceActions

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

      • (string) –

• Marker (string) – An optional pagination token provided by a previous DescribeDBShardGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

• MaxRecords (integer) –

  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 you can retrieve the remaining results.

  Default: 100

  Constraints: Minimum 20, maximum 100

Return type:

dict

Returns:

Response Syntax

{
    'DBShardGroups': [
        {
            'DBShardGroupResourceId': 'string',
            'DBShardGroupIdentifier': 'string',
            'DBClusterIdentifier': 'string',
            'MaxACU': 123.0,
            'ComputeRedundancy': 123,
            'Status': 'string',
            'PubliclyAccessible': True|False,
            'Endpoint': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  • DBShardGroups (list) –

    Contains a list of DB shard groups for the user.

    • (dict) –

      • DBShardGroupResourceId (string) –

        The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

      • DBShardGroupIdentifier (string) –

        The name of the DB shard group.

      • DBClusterIdentifier (string) –

        The name of the primary DB cluster for the DB shard group.

      • MaxACU (float) –

        The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

      • ComputeRedundancy (integer) –

        Specifies whether to create standby instances for the DB shard group. Valid values are the following:

        • 0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.

        • 1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.

        • 2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.

      • Status (string) –

        The status of the DB shard group.

      • PubliclyAccessible (boolean) –

        Indicates whether the DB shard group is publicly accessible.

        When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group’s VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB shard group doesn’t permit it.

        When the DB shard group isn’t publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

        For more information, see CreateDBShardGroup.

        This setting is only for Aurora Limitless Database.

      • Endpoint (string) –

        The connection endpoint for the DB shard group.

  • Marker (string) –

    A pagination token that can be used in a later DescribeDBClusters request.

Exceptions

• RDS.Client.exceptions.DBShardGroupNotFoundFault

• RDS.Client.exceptions.DBClusterNotFoundFault