GET

/#Action=DescribeUsageLimits

http://redshift.{region}.amazonaws.com/#Action=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: <ul> <li> 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. </li> <li> If usage limit identifier is provided, then the corresponding usage limit object is returned. </li> <li> If cluster identifier is provided, then all usage limit objects for the specified cluster are returned. </li> <li> If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned. </li> </ul>

Access Token Required: API Key

Query Params

UsageLimitIdstring

The identifier of the usage limit to describe.

ClusterIdentifierstring

The identifier of the cluster for which you want to describe usage limits.

FeatureTypestring

The feature type for which you want to describe usage limits.

Allowed:

MaxRecordsinteger

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100.

Markerstring

An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeUsageLimits</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.

TagKeysarray

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 <code>owner</code> and <code>environment</code>. 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.

TagValuesarray

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 <code>admin</code> and <code>test</code>. 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.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://redshift.{region}.amazonaws.com/#Action=DescribeUsageLimits' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}