amazonka-budgets-2.0: Amazon Budgets 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.Budgets.DescribeBudgets

Description

Lists the budgets that are associated with an account.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeBudgets Source #

Request of DescribeBudgets

See: newDescribeBudgets smart constructor.

Constructors

DescribeBudgets' 

Fields

  • maxResults :: Maybe Natural

    An optional integer that represents how many entries a paginated response contains. The maximum is 100.

  • nextToken :: Maybe Text

    The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

  • accountId :: Text

    The accountId that is associated with the budgets that you want descriptions of.

Instances

Instances details
ToJSON DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

ToHeaders DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

ToPath DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

ToQuery DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

AWSPager DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

AWSRequest DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Associated Types

type AWSResponse DescribeBudgets #

Generic DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Associated Types

type Rep DescribeBudgets :: Type -> Type #

Read DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Show DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

NFData DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Methods

rnf :: DescribeBudgets -> () #

Eq DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Hashable DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

type AWSResponse DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

type Rep DescribeBudgets Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

type Rep DescribeBudgets = D1 ('MetaData "DescribeBudgets" "Amazonka.Budgets.DescribeBudgets" "amazonka-budgets-2.0-7U1RWOWP6pxJESvTUhAD5Y" 'False) (C1 ('MetaCons "DescribeBudgets'" '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 "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeBudgets Source #

Create a value of DescribeBudgets 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:DescribeBudgets', describeBudgets_maxResults - An optional integer that represents how many entries a paginated response contains. The maximum is 100.

DescribeBudgets, describeBudgets_nextToken - The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

$sel:accountId:DescribeBudgets', describeBudgets_accountId - The accountId that is associated with the budgets that you want descriptions of.

Request Lenses

describeBudgets_maxResults :: Lens' DescribeBudgets (Maybe Natural) Source #

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

describeBudgets_nextToken :: Lens' DescribeBudgets (Maybe Text) Source #

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

describeBudgets_accountId :: Lens' DescribeBudgets Text Source #

The accountId that is associated with the budgets that you want descriptions of.

Destructuring the Response

data DescribeBudgetsResponse Source #

Response of DescribeBudgets

See: newDescribeBudgetsResponse smart constructor.

Constructors

DescribeBudgetsResponse' 

Fields

Instances

Instances details
Generic DescribeBudgetsResponse Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Associated Types

type Rep DescribeBudgetsResponse :: Type -> Type #

Read DescribeBudgetsResponse Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Show DescribeBudgetsResponse Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

NFData DescribeBudgetsResponse Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

Methods

rnf :: DescribeBudgetsResponse -> () #

Eq DescribeBudgetsResponse Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

type Rep DescribeBudgetsResponse Source # 
Instance details

Defined in Amazonka.Budgets.DescribeBudgets

type Rep DescribeBudgetsResponse = D1 ('MetaData "DescribeBudgetsResponse" "Amazonka.Budgets.DescribeBudgets" "amazonka-budgets-2.0-7U1RWOWP6pxJESvTUhAD5Y" 'False) (C1 ('MetaCons "DescribeBudgetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "budgets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Budget])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBudgetsResponse Source #

Create a value of DescribeBudgetsResponse 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:budgets:DescribeBudgetsResponse', describeBudgetsResponse_budgets - A list of budgets.

DescribeBudgets, describeBudgetsResponse_nextToken - The pagination token in the service response that indicates the next set of results that you can retrieve.

$sel:httpStatus:DescribeBudgetsResponse', describeBudgetsResponse_httpStatus - The response's http status code.

Response Lenses

describeBudgetsResponse_nextToken :: Lens' DescribeBudgetsResponse (Maybe Text) Source #

The pagination token in the service response that indicates the next set of results that you can retrieve.