amazonka-discovery-2.0: Amazon Application Discovery Service 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.Discovery.DescribeTags

Description

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.

There are three valid tag filter names:

  • tagKey
  • tagValue
  • configurationId

Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTags Source #

See: newDescribeTags smart constructor.

Constructors

DescribeTags' 

Fields

  • filters :: Maybe [TagFilter]

    You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

  • maxResults :: Maybe Int

    The total number of items to return in a single page of output. The maximum value is 100.

  • nextToken :: Maybe Text

    A token to start the list. Use this token to get the next set of results.

Instances

Instances details
ToJSON DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

toJSON :: DescribeTags -> Value #

toEncoding :: DescribeTags -> Encoding #

toJSONList :: [DescribeTags] -> Value #

toEncodingList :: [DescribeTags] -> Encoding #

ToHeaders DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

toHeaders :: DescribeTags -> [Header] #

ToPath DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

toPath :: DescribeTags -> ByteString #

ToQuery DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

toQuery :: DescribeTags -> QueryString #

AWSPager DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

page :: DescribeTags -> AWSResponse DescribeTags -> Maybe DescribeTags #

AWSRequest DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Associated Types

type AWSResponse DescribeTags #

Methods

request :: (Service -> Service) -> DescribeTags -> Request DescribeTags #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTags))) #

Generic DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Associated Types

type Rep DescribeTags :: Type -> Type #

Methods

from :: DescribeTags -> Rep DescribeTags x #

to :: Rep DescribeTags x -> DescribeTags #

Read DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

readsPrec :: Int -> ReadS DescribeTags #

readList :: ReadS [DescribeTags] #

readPrec :: ReadPrec DescribeTags #

readListPrec :: ReadPrec [DescribeTags] #

Show DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

showsPrec :: Int -> DescribeTags -> ShowS #

show :: DescribeTags -> String #

showList :: [DescribeTags] -> ShowS #

NFData DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

rnf :: DescribeTags -> () #

Eq DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

(==) :: DescribeTags -> DescribeTags -> Bool #

(/=) :: DescribeTags -> DescribeTags -> Bool #

Hashable DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

hashWithSalt :: Int -> DescribeTags -> Int #

hash :: DescribeTags -> Int #

type AWSResponse DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

type AWSResponse DescribeTags = DescribeTagsResponse
type Rep DescribeTags Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

type Rep DescribeTags = D1 ('MetaData "DescribeTags" "Amazonka.Discovery.DescribeTags" "amazonka-discovery-2.0-FHPaShbhCtL10K1sBxZHs" 'False) (C1 ('MetaCons "DescribeTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagFilter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeTags :: DescribeTags Source #

Create a value of DescribeTags 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:filters:DescribeTags', describeTags_filters - You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

$sel:maxResults:DescribeTags', describeTags_maxResults - The total number of items to return in a single page of output. The maximum value is 100.

DescribeTags, describeTags_nextToken - A token to start the list. Use this token to get the next set of results.

Request Lenses

describeTags_filters :: Lens' DescribeTags (Maybe [TagFilter]) Source #

You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

describeTags_maxResults :: Lens' DescribeTags (Maybe Int) Source #

The total number of items to return in a single page of output. The maximum value is 100.

describeTags_nextToken :: Lens' DescribeTags (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

Destructuring the Response

data DescribeTagsResponse Source #

See: newDescribeTagsResponse smart constructor.

Constructors

DescribeTagsResponse' 

Fields

  • nextToken :: Maybe Text

    The call returns a token. Use this token to get the next set of results.

  • tags :: Maybe [ConfigurationTag]

    Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeTagsResponse Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Associated Types

type Rep DescribeTagsResponse :: Type -> Type #

Methods

from :: DescribeTagsResponse -> Rep DescribeTagsResponse x #

to :: Rep DescribeTagsResponse x -> DescribeTagsResponse #

Read DescribeTagsResponse Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

readsPrec :: Int -> ReadS DescribeTagsResponse #

readList :: ReadS [DescribeTagsResponse] #

readPrec :: ReadPrec DescribeTagsResponse #

readListPrec :: ReadPrec [DescribeTagsResponse] #

Show DescribeTagsResponse Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

showsPrec :: Int -> DescribeTagsResponse -> ShowS #

show :: DescribeTagsResponse -> String #

showList :: [DescribeTagsResponse] -> ShowS #

NFData DescribeTagsResponse Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

rnf :: DescribeTagsResponse -> () #

Eq DescribeTagsResponse Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

Methods

(==) :: DescribeTagsResponse -> DescribeTagsResponse -> Bool #

(/=) :: DescribeTagsResponse -> DescribeTagsResponse -> Bool #

type Rep DescribeTagsResponse Source # 
Instance details

Defined in Amazonka.Discovery.DescribeTags

type Rep DescribeTagsResponse = D1 ('MetaData "DescribeTagsResponse" "Amazonka.Discovery.DescribeTags" "amazonka-discovery-2.0-FHPaShbhCtL10K1sBxZHs" 'False) (C1 ('MetaCons "DescribeTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationTag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTagsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeTagsResponse'

-> DescribeTagsResponse 

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

DescribeTags, describeTagsResponse_nextToken - The call returns a token. Use this token to get the next set of results.

$sel:tags:DescribeTagsResponse', describeTagsResponse_tags - Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

$sel:httpStatus:DescribeTagsResponse', describeTagsResponse_httpStatus - The response's http status code.

Response Lenses

describeTagsResponse_nextToken :: Lens' DescribeTagsResponse (Maybe Text) Source #

The call returns a token. Use this token to get the next set of results.

describeTagsResponse_tags :: Lens' DescribeTagsResponse (Maybe [ConfigurationTag]) Source #

Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

describeTagsResponse_httpStatus :: Lens' DescribeTagsResponse Int Source #

The response's http status code.