Network.AWS.CloudHSMv2.DescribeBackups

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

This operation returns paginated results.

Creating a Request

describeBackups :: DescribeBackups

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

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

• dbFilters - One or more filters to limit the items returned in the response. Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID). Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID). Use the states filter to return only backups that match the specified state.
• dbNextToken - The NextToken value that you received in the previous response. Use this value to get more backups.
• dbMaxResults - The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

data DescribeBackups

See: describeBackups smart constructor.

Instances

Eq DescribeBackups

Methods

(==) :: DescribeBackups -> DescribeBackups -> Bool

(/=) :: DescribeBackups -> DescribeBackups -> Bool

Data DescribeBackups

Methods

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

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

toConstr :: DescribeBackups -> Constr

dataTypeOf :: DescribeBackups -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeBackups -> DescribeBackups

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

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

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

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

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

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

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

Read DescribeBackups

Methods

readsPrec :: Int -> ReadS DescribeBackups

readList :: ReadS [DescribeBackups]

readPrec :: ReadPrec DescribeBackups

readListPrec :: ReadPrec [DescribeBackups]

Show DescribeBackups

Methods

showsPrec :: Int -> DescribeBackups -> ShowS

show :: DescribeBackups -> String

showList :: [DescribeBackups] -> ShowS

Generic DescribeBackups

Associated Types

type Rep DescribeBackups :: * -> *

Methods

from :: DescribeBackups -> Rep DescribeBackups x

to :: Rep DescribeBackups x -> DescribeBackups

Hashable DescribeBackups

Methods

hashWithSalt :: Int -> DescribeBackups -> Int

hash :: DescribeBackups -> Int

ToJSON DescribeBackups

Methods

toJSON :: DescribeBackups -> Value

toEncoding :: DescribeBackups -> Encoding

toJSONList :: [DescribeBackups] -> Value

toEncodingList :: [DescribeBackups] -> Encoding

NFData DescribeBackups

Methods

rnf :: DescribeBackups -> ()

AWSPager DescribeBackups

Methods

page :: DescribeBackups -> Rs DescribeBackups -> Maybe DescribeBackups

AWSRequest DescribeBackups

Associated Types

type Rs DescribeBackups :: *

Methods

request :: DescribeBackups -> Request DescribeBackups

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeBackups -> ClientResponse -> m (Response DescribeBackups)

ToHeaders DescribeBackups

Methods

toHeaders :: DescribeBackups -> [Header]

ToPath DescribeBackups

Methods

toPath :: DescribeBackups -> ByteString

ToQuery DescribeBackups

Methods

toQuery :: DescribeBackups -> QueryString

type Rep DescribeBackups

type Rep DescribeBackups = D1 * (MetaData "DescribeBackups" "Network.AWS.CloudHSMv2.DescribeBackups" "amazonka-cloudhsmv2-1.6.0-9vsD5g1UuU59SmJh0gvUWW" False) (C1 * (MetaCons "DescribeBackups'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dbMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs DescribeBackups

type Rs DescribeBackups = DescribeBackupsResponse

Request Lenses

dbFilters :: Lens' DescribeBackups (HashMap Text [Text])

One or more filters to limit the items returned in the response. Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID). Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID). Use the states filter to return only backups that match the specified state.

dbNextToken :: Lens' DescribeBackups (Maybe Text)

The NextToken value that you received in the previous response. Use this value to get more backups.

dbMaxResults :: Lens' DescribeBackups (Maybe Natural)

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Destructuring the Response

describeBackupsResponse

Arguments

:: Int

dbrsResponseStatus

-> DescribeBackupsResponse

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

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

• dbrsBackups - A list of backups.
• dbrsNextToken - An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.
• dbrsResponseStatus - -- | The response status code.

data DescribeBackupsResponse

See: describeBackupsResponse smart constructor.

Instances

Eq DescribeBackupsResponse

Methods

(==) :: DescribeBackupsResponse -> DescribeBackupsResponse -> Bool

(/=) :: DescribeBackupsResponse -> DescribeBackupsResponse -> Bool

Data DescribeBackupsResponse

Methods

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

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

toConstr :: DescribeBackupsResponse -> Constr

dataTypeOf :: DescribeBackupsResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeBackupsResponse -> DescribeBackupsResponse

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

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

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

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

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

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

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

Read DescribeBackupsResponse

Methods

readsPrec :: Int -> ReadS DescribeBackupsResponse

readList :: ReadS [DescribeBackupsResponse]

readPrec :: ReadPrec DescribeBackupsResponse

readListPrec :: ReadPrec [DescribeBackupsResponse]

Show DescribeBackupsResponse

Methods

showsPrec :: Int -> DescribeBackupsResponse -> ShowS

show :: DescribeBackupsResponse -> String

showList :: [DescribeBackupsResponse] -> ShowS

Generic DescribeBackupsResponse

Associated Types

type Rep DescribeBackupsResponse :: * -> *

Methods

from :: DescribeBackupsResponse -> Rep DescribeBackupsResponse x

to :: Rep DescribeBackupsResponse x -> DescribeBackupsResponse

NFData DescribeBackupsResponse

Methods

rnf :: DescribeBackupsResponse -> ()

type Rep DescribeBackupsResponse

type Rep DescribeBackupsResponse = D1 * (MetaData "DescribeBackupsResponse" "Network.AWS.CloudHSMv2.DescribeBackups" "amazonka-cloudhsmv2-1.6.0-9vsD5g1UuU59SmJh0gvUWW" False) (C1 * (MetaCons "DescribeBackupsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsBackups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Backup]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dbrsBackups :: Lens' DescribeBackupsResponse [Backup]

A list of backups.

dbrsNextToken :: Lens' DescribeBackupsResponse (Maybe Text)

An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.

dbrsResponseStatus :: Lens' DescribeBackupsResponse Int

• - | The response status code.