Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Backup.ListRecoveryPointsByBackupVault

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns detailed information about the recovery points stored in a backup vault.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRecoveryPointsByBackupVault Source #

See: newListRecoveryPointsByBackupVault smart constructor.

Constructors

ListRecoveryPointsByBackupVault'

Fields

byBackupPlanId :: Maybe Text
Returns only recovery points that match the specified backup plan ID.
byCreatedAfter :: Maybe POSIX
Returns only recovery points that were created after the specified timestamp.
byCreatedBefore :: Maybe POSIX
Returns only recovery points that were created before the specified timestamp.
byParentRecoveryPointArn :: Maybe Text
This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
byResourceArn :: Maybe Text
Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
byResourceType :: Maybe Text
Returns only recovery points that match the specified resource type.
maxResults :: Maybe Natural
The maximum number of items to be returned.
nextToken :: Maybe Text
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
backupVaultName :: Text
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Backup vault name might not be available when a supported service creates the backup.

Instances

Instances details

ToHeaders ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods toHeaders :: ListRecoveryPointsByBackupVault -> [Header] #
ToPath ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods toPath :: ListRecoveryPointsByBackupVault -> ByteString #
ToQuery ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods toQuery :: ListRecoveryPointsByBackupVault -> QueryString #
AWSPager ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods page :: ListRecoveryPointsByBackupVault -> AWSResponse ListRecoveryPointsByBackupVault -> Maybe ListRecoveryPointsByBackupVault #
AWSRequest ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Associated Types type AWSResponse ListRecoveryPointsByBackupVault # Methods request :: (Service -> Service) -> ListRecoveryPointsByBackupVault -> Request ListRecoveryPointsByBackupVault # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRecoveryPointsByBackupVault -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRecoveryPointsByBackupVault))) #
Generic ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Associated Types type Rep ListRecoveryPointsByBackupVault :: Type -> Type # Methods from :: ListRecoveryPointsByBackupVault -> Rep ListRecoveryPointsByBackupVault x # to :: Rep ListRecoveryPointsByBackupVault x -> ListRecoveryPointsByBackupVault #
Read ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods readsPrec :: Int -> ReadS ListRecoveryPointsByBackupVault # readList :: ReadS [ListRecoveryPointsByBackupVault] # readPrec :: ReadPrec ListRecoveryPointsByBackupVault # readListPrec :: ReadPrec [ListRecoveryPointsByBackupVault] #
Show ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods showsPrec :: Int -> ListRecoveryPointsByBackupVault -> ShowS # show :: ListRecoveryPointsByBackupVault -> String # showList :: [ListRecoveryPointsByBackupVault] -> ShowS #
NFData ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods rnf :: ListRecoveryPointsByBackupVault -> () #
Eq ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods (==) :: ListRecoveryPointsByBackupVault -> ListRecoveryPointsByBackupVault -> Bool # (/=) :: ListRecoveryPointsByBackupVault -> ListRecoveryPointsByBackupVault -> Bool #
Hashable ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods hashWithSalt :: Int -> ListRecoveryPointsByBackupVault -> Int # hash :: ListRecoveryPointsByBackupVault -> Int #
type AWSResponse ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault type AWSResponse ListRecoveryPointsByBackupVault = ListRecoveryPointsByBackupVaultResponse
type Rep ListRecoveryPointsByBackupVault Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault type Rep ListRecoveryPointsByBackupVault = D1 ('MetaData "ListRecoveryPointsByBackupVault" "Amazonka.Backup.ListRecoveryPointsByBackupVault" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListRecoveryPointsByBackupVault'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "byBackupPlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "byCreatedAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "byCreatedBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "byParentRecoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "byResourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "byResourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newListRecoveryPointsByBackupVault Source #

Arguments

:: Text	`ListRecoveryPointsByBackupVault`
-> ListRecoveryPointsByBackupVault

Create a value of ListRecoveryPointsByBackupVault 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:byBackupPlanId:ListRecoveryPointsByBackupVault', listRecoveryPointsByBackupVault_byBackupPlanId - Returns only recovery points that match the specified backup plan ID.

$sel:byCreatedAfter:ListRecoveryPointsByBackupVault', listRecoveryPointsByBackupVault_byCreatedAfter - Returns only recovery points that were created after the specified timestamp.

$sel:byCreatedBefore:ListRecoveryPointsByBackupVault', listRecoveryPointsByBackupVault_byCreatedBefore - Returns only recovery points that were created before the specified timestamp.

$sel:byParentRecoveryPointArn:ListRecoveryPointsByBackupVault', listRecoveryPointsByBackupVault_byParentRecoveryPointArn - This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

$sel:byResourceArn:ListRecoveryPointsByBackupVault', listRecoveryPointsByBackupVault_byResourceArn - Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

$sel:byResourceType:ListRecoveryPointsByBackupVault', listRecoveryPointsByBackupVault_byResourceType - Returns only recovery points that match the specified resource type.

$sel:maxResults:ListRecoveryPointsByBackupVault', listRecoveryPointsByBackupVault_maxResults - The maximum number of items to be returned.

ListRecoveryPointsByBackupVault, listRecoveryPointsByBackupVault_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListRecoveryPointsByBackupVault, listRecoveryPointsByBackupVault_backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Backup vault name might not be available when a supported service creates the backup.

Request Lenses

listRecoveryPointsByBackupVault_byBackupPlanId :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

Returns only recovery points that match the specified backup plan ID.

listRecoveryPointsByBackupVault_byCreatedAfter :: Lens' ListRecoveryPointsByBackupVault (Maybe UTCTime) Source #

Returns only recovery points that were created after the specified timestamp.

listRecoveryPointsByBackupVault_byCreatedBefore :: Lens' ListRecoveryPointsByBackupVault (Maybe UTCTime) Source #

Returns only recovery points that were created before the specified timestamp.

listRecoveryPointsByBackupVault_byParentRecoveryPointArn :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

listRecoveryPointsByBackupVault_byResourceArn :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

listRecoveryPointsByBackupVault_byResourceType :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

Returns only recovery points that match the specified resource type.

listRecoveryPointsByBackupVault_maxResults :: Lens' ListRecoveryPointsByBackupVault (Maybe Natural) Source #

The maximum number of items to be returned.

listRecoveryPointsByBackupVault_nextToken :: Lens' ListRecoveryPointsByBackupVault (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRecoveryPointsByBackupVault_backupVaultName :: Lens' ListRecoveryPointsByBackupVault Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Backup vault name might not be available when a supported service creates the backup.

Destructuring the Response

data ListRecoveryPointsByBackupVaultResponse Source #

See: newListRecoveryPointsByBackupVaultResponse smart constructor.

Constructors

ListRecoveryPointsByBackupVaultResponse'

Fields

nextToken :: Maybe Text
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
recoveryPoints :: Maybe [RecoveryPointByBackupVault]
An array of objects that contain detailed information about recovery points saved in a backup vault.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListRecoveryPointsByBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Associated Types type Rep ListRecoveryPointsByBackupVaultResponse :: Type -> Type # Methods from :: ListRecoveryPointsByBackupVaultResponse -> Rep ListRecoveryPointsByBackupVaultResponse x # to :: Rep ListRecoveryPointsByBackupVaultResponse x -> ListRecoveryPointsByBackupVaultResponse #
Read ListRecoveryPointsByBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods readsPrec :: Int -> ReadS ListRecoveryPointsByBackupVaultResponse # readList :: ReadS [ListRecoveryPointsByBackupVaultResponse] # readPrec :: ReadPrec ListRecoveryPointsByBackupVaultResponse # readListPrec :: ReadPrec [ListRecoveryPointsByBackupVaultResponse] #
Show ListRecoveryPointsByBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods showsPrec :: Int -> ListRecoveryPointsByBackupVaultResponse -> ShowS # show :: ListRecoveryPointsByBackupVaultResponse -> String # showList :: [ListRecoveryPointsByBackupVaultResponse] -> ShowS #
NFData ListRecoveryPointsByBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods rnf :: ListRecoveryPointsByBackupVaultResponse -> () #
Eq ListRecoveryPointsByBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault Methods (==) :: ListRecoveryPointsByBackupVaultResponse -> ListRecoveryPointsByBackupVaultResponse -> Bool # (/=) :: ListRecoveryPointsByBackupVaultResponse -> ListRecoveryPointsByBackupVaultResponse -> Bool #
type Rep ListRecoveryPointsByBackupVaultResponse Source #
Instance details Defined in Amazonka.Backup.ListRecoveryPointsByBackupVault type Rep ListRecoveryPointsByBackupVaultResponse = D1 ('MetaData "ListRecoveryPointsByBackupVaultResponse" "Amazonka.Backup.ListRecoveryPointsByBackupVault" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListRecoveryPointsByBackupVaultResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recoveryPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecoveryPointByBackupVault])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRecoveryPointsByBackupVaultResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListRecoveryPointsByBackupVaultResponse'`
-> ListRecoveryPointsByBackupVaultResponse

Create a value of ListRecoveryPointsByBackupVaultResponse 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:

ListRecoveryPointsByBackupVault, listRecoveryPointsByBackupVaultResponse_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

$sel:recoveryPoints:ListRecoveryPointsByBackupVaultResponse', listRecoveryPointsByBackupVaultResponse_recoveryPoints - An array of objects that contain detailed information about recovery points saved in a backup vault.

$sel:httpStatus:ListRecoveryPointsByBackupVaultResponse', listRecoveryPointsByBackupVaultResponse_httpStatus - The response's http status code.

Response Lenses

listRecoveryPointsByBackupVaultResponse_nextToken :: Lens' ListRecoveryPointsByBackupVaultResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRecoveryPointsByBackupVaultResponse_recoveryPoints :: Lens' ListRecoveryPointsByBackupVaultResponse (Maybe [RecoveryPointByBackupVault]) Source #

An array of objects that contain detailed information about recovery points saved in a backup vault.

listRecoveryPointsByBackupVaultResponse_httpStatus :: Lens' ListRecoveryPointsByBackupVaultResponse Int Source #

The response's http status code.