amazonka-efs-1.5.0: Amazon Elastic File System SDK.

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

Network.AWS.EFS.DescribeTags

Contents

Description

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multi-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

This operation returns paginated results.

Synopsis

Creating a Request

describeTags Source #

Creates a value of DescribeTags with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dtMarker - (Optional) Opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.
  • dtMaxItems - (Optional) Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.
  • dtFileSystemId - ID of the file system whose tag set you want to retrieve.

data DescribeTags Source #

See: describeTags smart constructor.

Instances

Eq DescribeTags Source # 
Data DescribeTags Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTags -> c DescribeTags #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTags #

toConstr :: DescribeTags -> Constr #

dataTypeOf :: DescribeTags -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTags) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTags) #

gmapT :: (forall b. Data b => b -> b) -> DescribeTags -> DescribeTags #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTags -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTags -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeTags -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTags -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTags -> m DescribeTags #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTags -> m DescribeTags #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTags -> m DescribeTags #

Read DescribeTags Source # 
Show DescribeTags Source # 
Generic DescribeTags Source # 

Associated Types

type Rep DescribeTags :: * -> * #

Hashable DescribeTags Source # 
NFData DescribeTags Source # 

Methods

rnf :: DescribeTags -> () #

AWSPager DescribeTags Source # 
AWSRequest DescribeTags Source # 
ToQuery DescribeTags Source # 
ToPath DescribeTags Source # 
ToHeaders DescribeTags Source # 
type Rep DescribeTags Source # 
type Rep DescribeTags = D1 (MetaData "DescribeTags" "Network.AWS.EFS.DescribeTags" "amazonka-efs-1.5.0-AGdA5NiO2mlIVVmSCQcc4J" False) (C1 (MetaCons "DescribeTags'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dtMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dtMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dtFileSystemId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeTags Source # 

Request Lenses

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

(Optional) Opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.

dtMaxItems :: Lens' DescribeTags (Maybe Natural) Source #

(Optional) Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.

dtFileSystemId :: Lens' DescribeTags Text Source #

ID of the file system whose tag set you want to retrieve.

Destructuring the Response

describeTagsResponse Source #

Creates a value of DescribeTagsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dtrsMarker - If the request included a Marker , the response returns that value in this field.
  • dtrsNextMarker - If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags.
  • dtrsResponseStatus - -- | The response status code.
  • dtrsTags - Returns tags associated with the file system as an array of Tag objects.

data DescribeTagsResponse Source #

See: describeTagsResponse smart constructor.

Instances

Eq DescribeTagsResponse Source # 
Data DescribeTagsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTagsResponse -> c DescribeTagsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTagsResponse #

toConstr :: DescribeTagsResponse -> Constr #

dataTypeOf :: DescribeTagsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTagsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTagsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeTagsResponse -> DescribeTagsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTagsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTagsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeTagsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTagsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTagsResponse -> m DescribeTagsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTagsResponse -> m DescribeTagsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTagsResponse -> m DescribeTagsResponse #

Read DescribeTagsResponse Source # 
Show DescribeTagsResponse Source # 
Generic DescribeTagsResponse Source # 
NFData DescribeTagsResponse Source # 

Methods

rnf :: DescribeTagsResponse -> () #

type Rep DescribeTagsResponse Source # 
type Rep DescribeTagsResponse = D1 (MetaData "DescribeTagsResponse" "Network.AWS.EFS.DescribeTags" "amazonka-efs-1.5.0-AGdA5NiO2mlIVVmSCQcc4J" False) (C1 (MetaCons "DescribeTagsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dtrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dtrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_dtrsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Tag])))))

Response Lenses

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

If the request included a Marker , the response returns that value in this field.

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

If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags.

dtrsResponseStatus :: Lens' DescribeTagsResponse Int Source #

  • - | The response status code.

dtrsTags :: Lens' DescribeTagsResponse [Tag] Source #

Returns tags associated with the file system as an array of Tag objects.