amazonka-backup-2.0: Amazon Backup 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.Backup.ListRecoveryPointsByResource

Description

Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRecoveryPointsByResource Source #

See: newListRecoveryPointsByResource smart constructor.

Constructors

ListRecoveryPointsByResource' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of items to be returned.

    Amazon RDS requires a value of at least 20.

  • 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.

  • resourceArn :: Text

    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Instances

Instances details
ToHeaders ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

ToPath ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

ToQuery ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

AWSPager ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

AWSRequest ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Generic ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Associated Types

type Rep ListRecoveryPointsByResource :: Type -> Type #

Read ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Show ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

NFData ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Eq ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Hashable ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

type AWSResponse ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

type Rep ListRecoveryPointsByResource Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

type Rep ListRecoveryPointsByResource = D1 ('MetaData "ListRecoveryPointsByResource" "Amazonka.Backup.ListRecoveryPointsByResource" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListRecoveryPointsByResource'" '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 "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListRecoveryPointsByResource Source #

Create a value of ListRecoveryPointsByResource 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:ListRecoveryPointsByResource', listRecoveryPointsByResource_maxResults - The maximum number of items to be returned.

Amazon RDS requires a value of at least 20.

ListRecoveryPointsByResource, listRecoveryPointsByResource_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.

ListRecoveryPointsByResource, listRecoveryPointsByResource_resourceArn - An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Request Lenses

listRecoveryPointsByResource_maxResults :: Lens' ListRecoveryPointsByResource (Maybe Natural) Source #

The maximum number of items to be returned.

Amazon RDS requires a value of at least 20.

listRecoveryPointsByResource_nextToken :: Lens' ListRecoveryPointsByResource (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.

listRecoveryPointsByResource_resourceArn :: Lens' ListRecoveryPointsByResource Text Source #

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Destructuring the Response

data ListRecoveryPointsByResourceResponse Source #

Constructors

ListRecoveryPointsByResourceResponse' 

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 [RecoveryPointByResource]

    An array of objects that contain detailed information about recovery points of the specified resource type.

    Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListRecoveryPointsByResourceResponse Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Read ListRecoveryPointsByResourceResponse Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Show ListRecoveryPointsByResourceResponse Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

NFData ListRecoveryPointsByResourceResponse Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

Eq ListRecoveryPointsByResourceResponse Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

type Rep ListRecoveryPointsByResourceResponse Source # 
Instance details

Defined in Amazonka.Backup.ListRecoveryPointsByResource

type Rep ListRecoveryPointsByResourceResponse = D1 ('MetaData "ListRecoveryPointsByResourceResponse" "Amazonka.Backup.ListRecoveryPointsByResource" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListRecoveryPointsByResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "recoveryPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecoveryPointByResource])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRecoveryPointsByResourceResponse Source #

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

ListRecoveryPointsByResource, listRecoveryPointsByResourceResponse_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:ListRecoveryPointsByResourceResponse', listRecoveryPointsByResourceResponse_recoveryPoints - An array of objects that contain detailed information about recovery points of the specified resource type.

Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.

$sel:httpStatus:ListRecoveryPointsByResourceResponse', listRecoveryPointsByResourceResponse_httpStatus - The response's http status code.

Response Lenses

listRecoveryPointsByResourceResponse_nextToken :: Lens' ListRecoveryPointsByResourceResponse (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.

listRecoveryPointsByResourceResponse_recoveryPoints :: Lens' ListRecoveryPointsByResourceResponse (Maybe [RecoveryPointByResource]) Source #

An array of objects that contain detailed information about recovery points of the specified resource type.

Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.