« blib/lib/Paws/Backup/ListProtectedResourcesOutput.pm
↑ Summary
blib/lib/Paws/Backup/ListRecoveryPointsByBackupVaultOutput.pm »
| 1 | |||
| 2 | package Paws::Backup::ListRecoveryPointsByBackupVault; | ||
| 3 | use Moose; | ||
| 4 | has BackupVaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'backupVaultName', required => 1); | ||
| 5 | has ByBackupPlanId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'backupPlanId'); | ||
| 6 | has ByCreatedAfter => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdAfter'); | ||
| 7 | has ByCreatedBefore => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdBefore'); | ||
| 8 | has ByResourceArn => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'resourceArn'); | ||
| 9 | has ByResourceType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'resourceType'); | ||
| 10 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 11 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListRecoveryPointsByBackupVault'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backup-vaults/{backupVaultName}/recovery-points/'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::ListRecoveryPointsByBackupVaultOutput'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Backup::ListRecoveryPointsByBackupVault - Arguments for method ListRecoveryPointsByBackupVault on L<Paws::Backup> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ListRecoveryPointsByBackupVault on the | ||
| 30 | L<AWS Backup|Paws::Backup> service. Use the attributes of this class | ||
| 31 | as arguments to method ListRecoveryPointsByBackupVault. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListRecoveryPointsByBackupVault. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $backup = Paws->service('Backup'); | ||
| 38 | my $ListRecoveryPointsByBackupVaultOutput = | ||
| 39 | $backup->ListRecoveryPointsByBackupVault( | ||
| 40 | BackupVaultName => 'MyBackupVaultName', | ||
| 41 | ByBackupPlanId => 'Mystring', # OPTIONAL | ||
| 42 | ByCreatedAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | ByCreatedBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 44 | ByResourceArn => 'MyARN', # OPTIONAL | ||
| 45 | ByResourceType => 'MyResourceType', # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'Mystring', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $NextToken = $ListRecoveryPointsByBackupVaultOutput->NextToken; | ||
| 52 | my $RecoveryPoints = $ListRecoveryPointsByBackupVaultOutput->RecoveryPoints; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Backup::ListRecoveryPointsByBackupVaultOutput> object. | ||
| 55 | |||
| 56 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/ListRecoveryPointsByBackupVault> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> BackupVaultName => Str | ||
| 63 | |||
| 64 | The name of a logical container where backups are stored. Backup vaults | ||
| 65 | are identified by names that are unique to the account used to create | ||
| 66 | them and the AWS Region where they are created. They consist of | ||
| 67 | lowercase letters, numbers, and hyphens. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 ByBackupPlanId => Str | ||
| 72 | |||
| 73 | Returns only recovery points that match the specified backup plan ID. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 ByCreatedAfter => Str | ||
| 78 | |||
| 79 | Returns only recovery points that were created after the specified | ||
| 80 | timestamp. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 ByCreatedBefore => Str | ||
| 85 | |||
| 86 | Returns only recovery points that were created before the specified | ||
| 87 | timestamp. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 ByResourceArn => Str | ||
| 92 | |||
| 93 | Returns only recovery points that match the specified resource Amazon | ||
| 94 | Resource Name (ARN). | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 ByResourceType => Str | ||
| 99 | |||
| 100 | Returns only recovery points that match the specified resource type. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 MaxResults => Int | ||
| 105 | |||
| 106 | The maximum number of items to be returned. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 NextToken => Str | ||
| 111 | |||
| 112 | The next item following a partial list of returned items. For example, | ||
| 113 | if a request is made to return C<maxResults> number of items, | ||
| 114 | C<NextToken> allows you to return more items in your list starting at | ||
| 115 | the location pointed to by the next token. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, documenting arguments for method ListRecoveryPointsByBackupVault in L<Paws::Backup> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |