DescribeUsageLimits
Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:
-
If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.
-
If usage limit identifier is provided, then the corresponding usage limit object is returned.
-
If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.
-
If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ClusterIdentifier
-
The identifier of the cluster for which you want to describe usage limits.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- FeatureType
-
The feature type for which you want to describe usage limits.
Type: String
Valid Values:
spectrum | concurrency-scaling | cross-region-datasharingRequired: No
- Marker
-
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in
MaxRecords, AWS returns a value in theMarkerfield of the response. You can retrieve the next set of response records by providing the returned marker value in theMarkerparameter and retrying the request.Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- MaxRecords
-
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified
MaxRecordsvalue, a value is returned in amarkerfield of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
100Constraints: minimum 20, maximum 100.
Type: Integer
Required: No
- TagKeys.TagKey.N
-
A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called
ownerandenvironment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.Type: Array of strings
Length Constraints: Maximum length of 2147483647.
Required: No
- TagValues.TagValue.N
-
A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called
adminandtest. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.Type: Array of strings
Length Constraints: Maximum length of 2147483647.
Required: No
- UsageLimitId
-
The identifier of the usage limit to describe.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
Response Elements
The following elements are returned by the service.
- Marker
-
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the
Markerparameter and retrying the command. If theMarkerfield is empty, all response records have been retrieved for the request.Type: String
Length Constraints: Maximum length of 2147483647.
- UsageLimits.member.N
-
Contains the output from the DescribeUsageLimits action.
Type: Array of UsageLimit objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
