Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.DescribeUsageLimits

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

This operation returns paginated results.

Synopsis

data DescribeUsageLimits = DescribeUsageLimits' {
- tagValues :: Maybe [Text]
- usageLimitId :: Maybe Text
- tagKeys :: Maybe [Text]
- clusterIdentifier :: Maybe Text
- featureType :: Maybe UsageLimitFeatureType
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeUsageLimits :: DescribeUsageLimits
describeUsageLimits_tagValues :: Lens' DescribeUsageLimits (Maybe [Text])
describeUsageLimits_usageLimitId :: Lens' DescribeUsageLimits (Maybe Text)
describeUsageLimits_tagKeys :: Lens' DescribeUsageLimits (Maybe [Text])
describeUsageLimits_clusterIdentifier :: Lens' DescribeUsageLimits (Maybe Text)
describeUsageLimits_featureType :: Lens' DescribeUsageLimits (Maybe UsageLimitFeatureType)
describeUsageLimits_marker :: Lens' DescribeUsageLimits (Maybe Text)
describeUsageLimits_maxRecords :: Lens' DescribeUsageLimits (Maybe Int)
data DescribeUsageLimitsResponse = DescribeUsageLimitsResponse' {
- usageLimits :: Maybe [UsageLimit]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeUsageLimitsResponse :: Int -> DescribeUsageLimitsResponse
describeUsageLimitsResponse_usageLimits :: Lens' DescribeUsageLimitsResponse (Maybe [UsageLimit])
describeUsageLimitsResponse_marker :: Lens' DescribeUsageLimitsResponse (Maybe Text)
describeUsageLimitsResponse_httpStatus :: Lens' DescribeUsageLimitsResponse Int

Creating a Request

data DescribeUsageLimits Source #

See: newDescribeUsageLimits smart constructor.

Constructors

DescribeUsageLimits'

Fields

tagValues :: Maybe [Text]
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 :: Maybe Text
The identifier of the usage limit to describe.
tagKeys :: Maybe [Text]
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.
clusterIdentifier :: Maybe Text
The identifier of the cluster for which you want to describe usage limits.
featureType :: Maybe UsageLimitFeatureType
The feature type for which you want to describe usage limits.
marker :: Maybe Text
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 :: Maybe Int
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.

Instances

Instances details

Eq DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods (==) :: DescribeUsageLimits -> DescribeUsageLimits -> Bool # (/=) :: DescribeUsageLimits -> DescribeUsageLimits -> Bool #
Read DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods readsPrec :: Int -> ReadS DescribeUsageLimits # readList :: ReadS [DescribeUsageLimits] # readPrec :: ReadPrec DescribeUsageLimits # readListPrec :: ReadPrec [DescribeUsageLimits] #
Show DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods showsPrec :: Int -> DescribeUsageLimits -> ShowS # show :: DescribeUsageLimits -> String # showList :: [DescribeUsageLimits] -> ShowS #
Generic DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Associated Types type Rep DescribeUsageLimits :: Type -> Type # Methods from :: DescribeUsageLimits -> Rep DescribeUsageLimits x # to :: Rep DescribeUsageLimits x -> DescribeUsageLimits #
NFData DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods rnf :: DescribeUsageLimits -> () #
Hashable DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods hashWithSalt :: Int -> DescribeUsageLimits -> Int # hash :: DescribeUsageLimits -> Int #
AWSPager DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods page :: DescribeUsageLimits -> AWSResponse DescribeUsageLimits -> Maybe DescribeUsageLimits #
AWSRequest DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Associated Types type AWSResponse DescribeUsageLimits # Methods request :: DescribeUsageLimits -> Request DescribeUsageLimits # response :: MonadResource m => Logger -> Service -> Proxy DescribeUsageLimits -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUsageLimits))) #
ToHeaders DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods toHeaders :: DescribeUsageLimits -> [Header] #
ToPath DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods toPath :: DescribeUsageLimits -> ByteString #
ToQuery DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods toQuery :: DescribeUsageLimits -> QueryString #
type Rep DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits type Rep DescribeUsageLimits = D1 ('MetaData "DescribeUsageLimits" "Amazonka.Redshift.DescribeUsageLimits" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeUsageLimits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "usageLimitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "featureType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitFeatureType))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse DescribeUsageLimits Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits type AWSResponse DescribeUsageLimits = DescribeUsageLimitsResponse

newDescribeUsageLimits :: DescribeUsageLimits Source #

Create a value of DescribeUsageLimits with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tagValues:DescribeUsageLimits', describeUsageLimits_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.

$sel:usageLimitId:DescribeUsageLimits', describeUsageLimits_usageLimitId - The identifier of the usage limit to describe.

$sel:tagKeys:DescribeUsageLimits', describeUsageLimits_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.

$sel:clusterIdentifier:DescribeUsageLimits', describeUsageLimits_clusterIdentifier - The identifier of the cluster for which you want to describe usage limits.

$sel:featureType:DescribeUsageLimits', describeUsageLimits_featureType - The feature type for which you want to describe usage limits.

$sel:marker:DescribeUsageLimits', describeUsageLimits_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, 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.

$sel:maxRecords:DescribeUsageLimits', describeUsageLimits_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.

Request Lenses

describeUsageLimits_tagValues :: Lens' DescribeUsageLimits (Maybe [Text]) Source #

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.

describeUsageLimits_usageLimitId :: Lens' DescribeUsageLimits (Maybe Text) Source #

The identifier of the usage limit to describe.

describeUsageLimits_tagKeys :: Lens' DescribeUsageLimits (Maybe [Text]) Source #

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.

describeUsageLimits_clusterIdentifier :: Lens' DescribeUsageLimits (Maybe Text) Source #

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

describeUsageLimits_featureType :: Lens' DescribeUsageLimits (Maybe UsageLimitFeatureType) Source #

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

describeUsageLimits_marker :: Lens' DescribeUsageLimits (Maybe Text) Source #

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.

describeUsageLimits_maxRecords :: Lens' DescribeUsageLimits (Maybe Int) Source #

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.

Destructuring the Response

data DescribeUsageLimitsResponse Source #

See: newDescribeUsageLimitsResponse smart constructor.

Constructors

DescribeUsageLimitsResponse'

Fields

usageLimits :: Maybe [UsageLimit]
Contains the output from the DescribeUsageLimits action.
marker :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeUsageLimitsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods (==) :: DescribeUsageLimitsResponse -> DescribeUsageLimitsResponse -> Bool # (/=) :: DescribeUsageLimitsResponse -> DescribeUsageLimitsResponse -> Bool #
Read DescribeUsageLimitsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods readsPrec :: Int -> ReadS DescribeUsageLimitsResponse # readList :: ReadS [DescribeUsageLimitsResponse] # readPrec :: ReadPrec DescribeUsageLimitsResponse # readListPrec :: ReadPrec [DescribeUsageLimitsResponse] #
Show DescribeUsageLimitsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods showsPrec :: Int -> DescribeUsageLimitsResponse -> ShowS # show :: DescribeUsageLimitsResponse -> String # showList :: [DescribeUsageLimitsResponse] -> ShowS #
Generic DescribeUsageLimitsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Associated Types type Rep DescribeUsageLimitsResponse :: Type -> Type # Methods from :: DescribeUsageLimitsResponse -> Rep DescribeUsageLimitsResponse x # to :: Rep DescribeUsageLimitsResponse x -> DescribeUsageLimitsResponse #
NFData DescribeUsageLimitsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits Methods rnf :: DescribeUsageLimitsResponse -> () #
type Rep DescribeUsageLimitsResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeUsageLimits type Rep DescribeUsageLimitsResponse = D1 ('MetaData "DescribeUsageLimitsResponse" "Amazonka.Redshift.DescribeUsageLimits" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DescribeUsageLimitsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usageLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsageLimit])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUsageLimitsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUsageLimitsResponse'`
-> DescribeUsageLimitsResponse

Create a value of DescribeUsageLimitsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:usageLimits:DescribeUsageLimitsResponse', describeUsageLimitsResponse_usageLimits - Contains the output from the DescribeUsageLimits action.

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

$sel:httpStatus:DescribeUsageLimitsResponse', describeUsageLimitsResponse_httpStatus - The response's http status code.

Response Lenses

describeUsageLimitsResponse_usageLimits :: Lens' DescribeUsageLimitsResponse (Maybe [UsageLimit]) Source #

Contains the output from the DescribeUsageLimits action.

describeUsageLimitsResponse_marker :: Lens' DescribeUsageLimitsResponse (Maybe Text) Source #

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.

describeUsageLimitsResponse_httpStatus :: Lens' DescribeUsageLimitsResponse Int Source #

The response's http status code.