amazonka-efs-2.0: Amazon Elastic File System 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.EFS.ListTagsForResource

Description

Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

Synopsis

Creating a Request

data ListTagsForResource Source #

See: newListTagsForResource smart constructor.

Constructors

ListTagsForResource' 

Fields

  • maxResults :: Maybe Natural

    (Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.

  • nextToken :: Maybe Text

    (Optional) You can use NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.

  • resourceId :: Text

    Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.

Instances

Instances details
ToHeaders ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

ToPath ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

ToQuery ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

AWSRequest ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Associated Types

type AWSResponse ListTagsForResource #

Generic ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Associated Types

type Rep ListTagsForResource :: Type -> Type #

Read ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Show ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

NFData ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Methods

rnf :: ListTagsForResource -> () #

Eq ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Hashable ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

type AWSResponse ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

type Rep ListTagsForResource Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.EFS.ListTagsForResource" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "ListTagsForResource'" '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 "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

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:maxResults:ListTagsForResource', listTagsForResource_maxResults - (Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.

ListTagsForResource, listTagsForResource_nextToken - (Optional) You can use NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.

$sel:resourceId:ListTagsForResource', listTagsForResource_resourceId - Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.

Request Lenses

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

(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.

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

(Optional) You can use NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.

listTagsForResource_resourceId :: Lens' ListTagsForResource Text Source #

Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.

Destructuring the Response

data ListTagsForResourceResponse Source #

See: newListTagsForResourceResponse smart constructor.

Constructors

ListTagsForResourceResponse' 

Fields

  • nextToken :: Maybe Text

    NextToken is present if the response payload is paginated. You can use NextToken in a subsequent request to fetch the next page of access point descriptions.

  • tags :: Maybe [Tag]

    An array of the tags for the specified EFS resource.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Associated Types

type Rep ListTagsForResourceResponse :: Type -> Type #

Read ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Show ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

NFData ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

Eq ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

type Rep ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.EFS.ListTagsForResource

type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.EFS.ListTagsForResource" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" '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))))

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:

ListTagsForResource, listTagsForResourceResponse_nextToken - NextToken is present if the response payload is paginated. You can use NextToken in a subsequent request to fetch the next page of access point descriptions.

ListTagsForResourceResponse, listTagsForResourceResponse_tags - An array of the tags for the specified EFS resource.

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

Response Lenses

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

NextToken is present if the response payload is paginated. You can use NextToken in a subsequent request to fetch the next page of access point descriptions.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

An array of the tags for the specified EFS resource.