libZSservicesZSamazonka-transferZSamazonka-transfer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Transfer.ListTagsForResource

Description

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

Synopsis

Creating a Request

data ListTagsForResource Source #

See: newListTagsForResource smart constructor.

Constructors

ListTagsForResource' 

Fields

  • nextToken :: Maybe Text

    When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

  • maxResults :: Maybe Natural

    Specifies the number of tags to return as a response to the ListTagsForResource request.

  • arn :: Text

    Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

Instances

Instances details
Eq ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Read ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Show ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Generic ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Associated Types

type Rep ListTagsForResource :: Type -> Type #

NFData ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Methods

rnf :: ListTagsForResource -> () #

Hashable ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

ToJSON ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

AWSRequest ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Associated Types

type AWSResponse ListTagsForResource #

ToHeaders ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

ToPath ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

ToQuery ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.Transfer.ListTagsForResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListTagsForResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

newListTagsForResource Source #

Create a value of ListTagsForResource 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:nextToken:ListTagsForResource', listTagsForResource_nextToken - When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

$sel:maxResults:ListTagsForResource', listTagsForResource_maxResults - Specifies the number of tags to return as a response to the ListTagsForResource request.

$sel:arn:ListTagsForResource', listTagsForResource_arn - Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

Request Lenses

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #

Specifies the number of tags to return as a response to the ListTagsForResource request.

listTagsForResource_arn :: Lens' ListTagsForResource Text Source #

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

Destructuring the Response

data ListTagsForResourceResponse Source #

See: newListTagsForResourceResponse smart constructor.

Constructors

ListTagsForResourceResponse' 

Fields

  • arn :: Maybe Text

    The ARN you specified to list the tags of.

  • nextToken :: Maybe Text

    When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

  • tags :: Maybe (NonEmpty Tag)

    Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Read ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Show ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Generic ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Associated Types

type Rep ListTagsForResourceResponse :: Type -> Type #

NFData ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.Transfer.ListTagsForResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTagsForResourceResponse Source #

Create a value of ListTagsForResourceResponse 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:arn:ListTagsForResource', listTagsForResourceResponse_arn - The ARN you specified to list the tags of.

$sel:nextToken:ListTagsForResource', listTagsForResourceResponse_nextToken - When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.

Response Lenses

listTagsForResourceResponse_arn :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

The ARN you specified to list the tags of.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.