amazonka-sagemaker-2.0: Amazon SageMaker 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.SageMaker.ListTags

Description

Returns the tags for the specified SageMaker resource.

This operation returns paginated results.

Synopsis

Creating a Request

data ListTags Source #

See: newListTags smart constructor.

Constructors

ListTags' 

Fields

  • maxResults :: Maybe Natural

    Maximum number of tags to return.

  • nextToken :: Maybe Text

    If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

  • resourceArn :: Text

    The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Instances

Instances details
ToJSON ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

ToHeaders ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Methods

toHeaders :: ListTags -> [Header] #

ToPath ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

ToQuery ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

AWSPager ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

AWSRequest ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Associated Types

type AWSResponse ListTags #

Generic ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Associated Types

type Rep ListTags :: Type -> Type #

Methods

from :: ListTags -> Rep ListTags x #

to :: Rep ListTags x -> ListTags #

Read ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Show ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

NFData ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Methods

rnf :: ListTags -> () #

Eq ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Hashable ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Methods

hashWithSalt :: Int -> ListTags -> Int #

hash :: ListTags -> Int #

type AWSResponse ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

type Rep ListTags Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

type Rep ListTags = D1 ('MetaData "ListTags" "Amazonka.SageMaker.ListTags" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListTags'" '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 Text))))

newListTags Source #

Create a value of ListTags 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:ListTags', listTags_maxResults - Maximum number of tags to return.

ListTags, listTags_nextToken - If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

$sel:resourceArn:ListTags', listTags_resourceArn - The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Request Lenses

listTags_maxResults :: Lens' ListTags (Maybe Natural) Source #

Maximum number of tags to return.

listTags_nextToken :: Lens' ListTags (Maybe Text) Source #

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

listTags_resourceArn :: Lens' ListTags Text Source #

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Destructuring the Response

data ListTagsResponse Source #

See: newListTagsResponse smart constructor.

Constructors

ListTagsResponse' 

Fields

  • nextToken :: Maybe Text

    If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

  • tags :: Maybe [Tag]

    An array of Tag objects, each with a tag key and a value.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListTagsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Associated Types

type Rep ListTagsResponse :: Type -> Type #

Read ListTagsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Show ListTagsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

NFData ListTagsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

Methods

rnf :: ListTagsResponse -> () #

Eq ListTagsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

type Rep ListTagsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTags

type Rep ListTagsResponse = D1 ('MetaData "ListTagsResponse" "Amazonka.SageMaker.ListTags" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTagsResponse Source #

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

ListTags, listTagsResponse_nextToken - If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

ListTagsResponse, listTagsResponse_tags - An array of Tag objects, each with a tag key and a value.

$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.

Response Lenses

listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

listTagsResponse_tags :: Lens' ListTagsResponse (Maybe [Tag]) Source #

An array of Tag objects, each with a tag key and a value.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.