DescribeDBShardGroups
Describes existing Aurora Limitless Database DB shard groups.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBShardGroupIdentifier
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*
Required: No
-
- Filters.Filter.N
-
A filter that specifies one or more DB shard groups to describe.
Type: Array of Filter objects
Required: No
- Marker
-
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 byMaxRecords
.Type: String
Required: No
- MaxRecords
-
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
Type: Integer
Valid Range: Minimum value of 20. Maximum value of 100.
Required: No
Response Elements
The following elements are returned by the service.
- DBShardGroups.DBShardGroup.N
-
Contains a list of DB shard groups for the user.
Type: Array of DBShardGroup objects
- Marker
-
A pagination token that can be used in a later
DescribeDBClusters
request.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterNotFoundFault
-
DBClusterIdentifier
doesn't refer to an existing DB cluster.HTTP Status Code: 404
- DBShardGroupNotFound
-
The specified DB shard group name wasn't found.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: