amazonka-resourcegroupstagging-2.0: Amazon Resource Groups Tagging API 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.ResourceGroupsTagging.GetTagValues

Description

Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

This operation returns paginated results.

Synopsis

Creating a Request

data GetTagValues Source #

See: newGetTagValues smart constructor.

Constructors

GetTagValues' 

Fields

  • paginationToken :: Maybe Text

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

  • key :: Text

    Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.

Instances

Instances details
ToJSON GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

ToHeaders GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

ToPath GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

ToQuery GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

AWSPager GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

AWSRequest GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Associated Types

type AWSResponse GetTagValues #

Generic GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Associated Types

type Rep GetTagValues :: Type -> Type #

Read GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Show GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

NFData GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Methods

rnf :: GetTagValues -> () #

Eq GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Hashable GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

type AWSResponse GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

type Rep GetTagValues Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

type Rep GetTagValues = D1 ('MetaData "GetTagValues" "Amazonka.ResourceGroupsTagging.GetTagValues" "amazonka-resourcegroupstagging-2.0-BMdZcHlIh2ABktMFQEVTUn" 'False) (C1 ('MetaCons "GetTagValues'" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetTagValues Source #

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

GetTagValues, getTagValues_paginationToken - Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

GetTagValues, getTagValues_key - Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.

Request Lenses

getTagValues_paginationToken :: Lens' GetTagValues (Maybe Text) Source #

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

getTagValues_key :: Lens' GetTagValues Text Source #

Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.

Destructuring the Response

data GetTagValuesResponse Source #

See: newGetTagValuesResponse smart constructor.

Constructors

GetTagValuesResponse' 

Fields

  • paginationToken :: Maybe Text

    A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

  • tagValues :: Maybe [Text]

    A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetTagValuesResponse Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Associated Types

type Rep GetTagValuesResponse :: Type -> Type #

Read GetTagValuesResponse Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Show GetTagValuesResponse Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

NFData GetTagValuesResponse Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

Methods

rnf :: GetTagValuesResponse -> () #

Eq GetTagValuesResponse Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

type Rep GetTagValuesResponse Source # 
Instance details

Defined in Amazonka.ResourceGroupsTagging.GetTagValues

type Rep GetTagValuesResponse = D1 ('MetaData "GetTagValuesResponse" "Amazonka.ResourceGroupsTagging.GetTagValues" "amazonka-resourcegroupstagging-2.0-BMdZcHlIh2ABktMFQEVTUn" 'False) (C1 ('MetaCons "GetTagValuesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetTagValuesResponse Source #

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

GetTagValues, getTagValuesResponse_paginationToken - A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

$sel:tagValues:GetTagValuesResponse', getTagValuesResponse_tagValues - A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.

$sel:httpStatus:GetTagValuesResponse', getTagValuesResponse_httpStatus - The response's http status code.

Response Lenses

getTagValuesResponse_paginationToken :: Lens' GetTagValuesResponse (Maybe Text) Source #

A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

getTagValuesResponse_tagValues :: Lens' GetTagValuesResponse (Maybe [Text]) Source #

A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.