« blib/lib/Paws/DynamoDB/KinesisStreamingDestinationOutput.pm
↑ Summary
blib/lib/Paws/DynamoDB/ListBackupsOutput.pm »
| 1 | |||
| 2 | package Paws::DynamoDB::ListBackups; | ||
| 3 | use Moose; | ||
| 4 | has BackupType => (is => 'ro', isa => 'Str'); | ||
| 5 | has ExclusiveStartBackupArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 7 | has TableName => (is => 'ro', isa => 'Str'); | ||
| 8 | has TimeRangeLowerBound => (is => 'ro', isa => 'Str'); | ||
| 9 | has TimeRangeUpperBound => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListBackups'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::ListBackupsOutput'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::DynamoDB::ListBackups - Arguments for method ListBackups on L<Paws::DynamoDB> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListBackups on the | ||
| 27 | L<Amazon DynamoDB|Paws::DynamoDB> service. Use the attributes of this class | ||
| 28 | as arguments to method ListBackups. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListBackups. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $dynamodb = Paws->service('DynamoDB'); | ||
| 35 | my $ListBackupsOutput = $dynamodb->ListBackups( | ||
| 36 | BackupType => 'USER', # OPTIONAL | ||
| 37 | ExclusiveStartBackupArn => 'MyBackupArn', # OPTIONAL | ||
| 38 | Limit => 1, # OPTIONAL | ||
| 39 | TableName => 'MyTableName', # OPTIONAL | ||
| 40 | TimeRangeLowerBound => '1970-01-01T01:00:00', # OPTIONAL | ||
| 41 | TimeRangeUpperBound => '1970-01-01T01:00:00', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $BackupSummaries = $ListBackupsOutput->BackupSummaries; | ||
| 46 | my $LastEvaluatedBackupArn = $ListBackupsOutput->LastEvaluatedBackupArn; | ||
| 47 | |||
| 48 | # Returns a L<Paws::DynamoDB::ListBackupsOutput> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dynamodb/ListBackups> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 BackupType => Str | ||
| 57 | |||
| 58 | The backups from the table specified by C<BackupType> are listed. | ||
| 59 | |||
| 60 | Where C<BackupType> can be: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<USER> - On-demand backup created by you. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<SYSTEM> - On-demand backup automatically created by DynamoDB. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<ALL> - All types of on-demand backups (USER and SYSTEM). | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | Valid values are: C<"USER">, C<"SYSTEM">, C<"AWS_BACKUP">, C<"ALL"> | ||
| 80 | |||
| 81 | =head2 ExclusiveStartBackupArn => Str | ||
| 82 | |||
| 83 | C<LastEvaluatedBackupArn> is the Amazon Resource Name (ARN) of the | ||
| 84 | backup last evaluated when the current page of results was returned, | ||
| 85 | inclusive of the current page of results. This value may be specified | ||
| 86 | as the C<ExclusiveStartBackupArn> of a new C<ListBackups> operation in | ||
| 87 | order to fetch the next page of results. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 Limit => Int | ||
| 92 | |||
| 93 | Maximum number of backups to return at once. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 TableName => Str | ||
| 98 | |||
| 99 | The backups from the table specified by C<TableName> are listed. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 TimeRangeLowerBound => Str | ||
| 104 | |||
| 105 | Only backups created after this time are listed. C<TimeRangeLowerBound> | ||
| 106 | is inclusive. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 TimeRangeUpperBound => Str | ||
| 111 | |||
| 112 | Only backups created before this time are listed. | ||
| 113 | C<TimeRangeUpperBound> is exclusive. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method ListBackups in L<Paws::DynamoDB> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |