amazonka-ds-1.4.5: Amazon Directory Service SDK.

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

Network.AWS.DirectoryService.DescribeSnapshots

Contents

Description

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Synopsis

Creating a Request

describeSnapshots :: DescribeSnapshots #

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

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

  • dsDirectoryId - The identifier of the directory for which to retrieve snapshot information.
  • dsNextToken - The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots . Pass null if this is the first call.
  • dsSnapshotIds - A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
  • dsLimit - The maximum number of objects to return.

data DescribeSnapshots #

Contains the inputs for the DescribeSnapshots operation.

See: describeSnapshots smart constructor.

Instances

Eq DescribeSnapshots # 
Data DescribeSnapshots # 

Methods

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

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

toConstr :: DescribeSnapshots -> Constr #

dataTypeOf :: DescribeSnapshots -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeSnapshots # 
Show DescribeSnapshots # 
Generic DescribeSnapshots # 
Hashable DescribeSnapshots # 
ToJSON DescribeSnapshots # 
NFData DescribeSnapshots # 

Methods

rnf :: DescribeSnapshots -> () #

AWSRequest DescribeSnapshots # 
ToQuery DescribeSnapshots # 
ToPath DescribeSnapshots # 
ToHeaders DescribeSnapshots # 
type Rep DescribeSnapshots # 
type Rep DescribeSnapshots = D1 (MetaData "DescribeSnapshots" "Network.AWS.DirectoryService.DescribeSnapshots" "amazonka-ds-1.4.5-HS0i104tV5hDEVolmTtioL" False) (C1 (MetaCons "DescribeSnapshots'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dsDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dsSnapshotIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))
type Rs DescribeSnapshots # 

Request Lenses

dsDirectoryId :: Lens' DescribeSnapshots (Maybe Text) #

The identifier of the directory for which to retrieve snapshot information.

dsNextToken :: Lens' DescribeSnapshots (Maybe Text) #

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots . Pass null if this is the first call.

dsSnapshotIds :: Lens' DescribeSnapshots [Text] #

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

dsLimit :: Lens' DescribeSnapshots (Maybe Natural) #

The maximum number of objects to return.

Destructuring the Response

describeSnapshotsResponse #

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

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

  • dssrsNextToken - If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots .
  • dssrsSnapshots - The list of Snapshot objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
  • dssrsResponseStatus - -- | The response status code.

data DescribeSnapshotsResponse #

Contains the results of the DescribeSnapshots operation.

See: describeSnapshotsResponse smart constructor.

Instances

Eq DescribeSnapshotsResponse # 
Data DescribeSnapshotsResponse # 

Methods

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

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

toConstr :: DescribeSnapshotsResponse -> Constr #

dataTypeOf :: DescribeSnapshotsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeSnapshotsResponse # 
Show DescribeSnapshotsResponse # 
Generic DescribeSnapshotsResponse # 
NFData DescribeSnapshotsResponse # 
type Rep DescribeSnapshotsResponse # 
type Rep DescribeSnapshotsResponse = D1 (MetaData "DescribeSnapshotsResponse" "Network.AWS.DirectoryService.DescribeSnapshots" "amazonka-ds-1.4.5-HS0i104tV5hDEVolmTtioL" False) (C1 (MetaCons "DescribeSnapshotsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dssrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dssrsSnapshots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Snapshot]))) (S1 (MetaSel (Just Symbol "_dssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dssrsNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) #

If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots .

dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot] #

The list of Snapshot objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

dssrsResponseStatus :: Lens' DescribeSnapshotsResponse Int #

  • - | The response status code.