DescribeUsageLimitsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftClient, DescribeUsageLimitsCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, DescribeUsageLimitsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // DescribeUsageLimitsMessage
  UsageLimitId: "STRING_VALUE",
  ClusterIdentifier: "STRING_VALUE",
  FeatureType: "spectrum" || "concurrency-scaling" || "cross-region-datasharing",
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
  TagKeys: [ // TagKeyList
    "STRING_VALUE",
  ],
  TagValues: [ // TagValueList
    "STRING_VALUE",
  ],
};
const command = new DescribeUsageLimitsCommand(input);
const response = await client.send(command);
// { // UsageLimitList
//   UsageLimits: [ // UsageLimits
//     { // UsageLimit
//       UsageLimitId: "STRING_VALUE",
//       ClusterIdentifier: "STRING_VALUE",
//       FeatureType: "spectrum" || "concurrency-scaling" || "cross-region-datasharing",
//       LimitType: "time" || "data-scanned",
//       Amount: Number("long"),
//       Period: "daily" || "weekly" || "monthly",
//       BreachAction: "log" || "emit-metric" || "disable",
//       Tags: [ // TagList
//         { // Tag
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribeUsageLimitsCommand Input

See DescribeUsageLimitsCommandInput for more details

Parameter
Type
Description
ClusterIdentifier
string | undefined

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

FeatureType
UsageLimitFeatureType | undefined

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

Marker
string | undefined

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, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
number | undefined

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys
string[] | undefined

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

TagValues
string[] | undefined

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

UsageLimitId
string | undefined

The identifier of the usage limit to describe.

DescribeUsageLimitsCommand Output

See DescribeUsageLimitsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Marker
string | undefined

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 Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

UsageLimits
UsageLimit[] | undefined

Contains the output from the DescribeUsageLimits action.

Throws

Name
Fault
Details
ClusterNotFoundFault
client

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault
client

The requested operation isn't supported.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.