Skip to content

Describe Usage Limits

redshift_describe_usage_limits R Documentation

Shows usage limits on a cluster

Description

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.

Usage

redshift_describe_usage_limits(UsageLimitId, ClusterIdentifier,
  FeatureType, MaxRecords, Marker, TagKeys, TagValues)

Arguments

UsageLimitId

The identifier of the usage limit to describe.

ClusterIdentifier

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

FeatureType

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

MaxRecords

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.

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_usage_limits 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.

TagKeys

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

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.

Value

A list with the following syntax: 

list(
  UsageLimits = list(
    list(
      UsageLimitId = "string",
      ClusterIdentifier = "string",
      FeatureType = "spectrum"|"concurrency-scaling"|"cross-region-datasharing",
      LimitType = "time"|"data-scanned",
      Amount = 123,
      Period = "daily"|"weekly"|"monthly",
      BreachAction = "log"|"emit-metric"|"disable",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_usage_limits(
  UsageLimitId = "string",
  ClusterIdentifier = "string",
  FeatureType = "spectrum"|"concurrency-scaling"|"cross-region-datasharing",
  MaxRecords = 123,
  Marker = "string",
  TagKeys = list(
    "string"
  ),
  TagValues = list(
    "string"
  )
)