amazonka-redshift-serverless-2.0: Amazon Redshift Serverless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RedshiftServerLess.ListUsageLimits

Description

Lists all usage limits within Amazon Redshift Serverless.

This operation returns paginated results.

Synopsis

Creating a Request

data ListUsageLimits Source #

See: newListUsageLimits smart constructor.

Constructors

ListUsageLimits' 

Fields

  • maxResults :: Maybe Natural

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

  • nextToken :: Maybe Text

    If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.

  • resourceArn :: Maybe Text

    The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

  • usageType :: Maybe UsageLimitUsageType

    The Amazon Redshift Serverless feature whose limits you want to see.

Instances

Instances details
ToJSON ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

ToHeaders ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

ToPath ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

ToQuery ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

AWSPager ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

AWSRequest ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Associated Types

type AWSResponse ListUsageLimits #

Generic ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Associated Types

type Rep ListUsageLimits :: Type -> Type #

Read ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Show ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

NFData ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Methods

rnf :: ListUsageLimits -> () #

Eq ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Hashable ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

type AWSResponse ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

type Rep ListUsageLimits Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

type Rep ListUsageLimits = D1 ('MetaData "ListUsageLimits" "Amazonka.RedshiftServerLess.ListUsageLimits" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "ListUsageLimits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "usageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageLimitUsageType)))))

newListUsageLimits :: ListUsageLimits Source #

Create a value of ListUsageLimits 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:maxResults:ListUsageLimits', listUsageLimits_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

ListUsageLimits, listUsageLimits_nextToken - If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.

ListUsageLimits, listUsageLimits_resourceArn - The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

ListUsageLimits, listUsageLimits_usageType - The Amazon Redshift Serverless feature whose limits you want to see.

Request Lenses

listUsageLimits_maxResults :: Lens' ListUsageLimits (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

listUsageLimits_nextToken :: Lens' ListUsageLimits (Maybe Text) Source #

If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.

listUsageLimits_resourceArn :: Lens' ListUsageLimits (Maybe Text) Source #

The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

listUsageLimits_usageType :: Lens' ListUsageLimits (Maybe UsageLimitUsageType) Source #

The Amazon Redshift Serverless feature whose limits you want to see.

Destructuring the Response

data ListUsageLimitsResponse Source #

See: newListUsageLimitsResponse smart constructor.

Constructors

ListUsageLimitsResponse' 

Fields

  • nextToken :: Maybe Text

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • usageLimits :: Maybe (NonEmpty UsageLimit)

    An array of returned usage limit objects.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListUsageLimitsResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Associated Types

type Rep ListUsageLimitsResponse :: Type -> Type #

Read ListUsageLimitsResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Show ListUsageLimitsResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

NFData ListUsageLimitsResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

Methods

rnf :: ListUsageLimitsResponse -> () #

Eq ListUsageLimitsResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

type Rep ListUsageLimitsResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListUsageLimits

type Rep ListUsageLimitsResponse = D1 ('MetaData "ListUsageLimitsResponse" "Amazonka.RedshiftServerLess.ListUsageLimits" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "ListUsageLimitsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "usageLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty UsageLimit))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUsageLimitsResponse Source #

Create a value of ListUsageLimitsResponse 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:

ListUsageLimits, listUsageLimitsResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:usageLimits:ListUsageLimitsResponse', listUsageLimitsResponse_usageLimits - An array of returned usage limit objects.

$sel:httpStatus:ListUsageLimitsResponse', listUsageLimitsResponse_httpStatus - The response's http status code.

Response Lenses

listUsageLimitsResponse_nextToken :: Lens' ListUsageLimitsResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.