« blib/lib/Paws/RedShift/DescribeSnapshotCopyGrants.pm
↑ Summary
blib/lib/Paws/RedShift/DescribeSnapshotSchedulesOutputMessage.pm »
| 1 | |||
| 2 | package Paws::RedShift::DescribeSnapshotSchedules; | ||
| 3 | use Moose; | ||
| 4 | has ClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 5 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 7 | has ScheduleIdentifier => (is => 'ro', isa => 'Str'); | ||
| 8 | has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSnapshotSchedules'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::DescribeSnapshotSchedulesOutputMessage'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeSnapshotSchedulesResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RedShift::DescribeSnapshotSchedules - Arguments for method DescribeSnapshotSchedules on L<Paws::RedShift> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeSnapshotSchedules on the | ||
| 27 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeSnapshotSchedules. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSnapshotSchedules. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $redshift = Paws->service('RedShift'); | ||
| 35 | my $DescribeSnapshotSchedulesOutputMessage = | ||
| 36 | $redshift->DescribeSnapshotSchedules( | ||
| 37 | ClusterIdentifier => 'MyString', # OPTIONAL | ||
| 38 | Marker => 'MyString', # OPTIONAL | ||
| 39 | MaxRecords => 1, # OPTIONAL | ||
| 40 | ScheduleIdentifier => 'MyString', # OPTIONAL | ||
| 41 | TagKeys => [ | ||
| 42 | 'MyString', ... # max: 2147483647 | ||
| 43 | ], # OPTIONAL | ||
| 44 | TagValues => [ | ||
| 45 | 'MyString', ... # max: 2147483647 | ||
| 46 | ], # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $Marker = $DescribeSnapshotSchedulesOutputMessage->Marker; | ||
| 51 | my $SnapshotSchedules = | ||
| 52 | $DescribeSnapshotSchedulesOutputMessage->SnapshotSchedules; | ||
| 53 | |||
| 54 | # Returns a L<Paws::RedShift::DescribeSnapshotSchedulesOutputMessage> 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/redshift/DescribeSnapshotSchedules> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ClusterIdentifier => Str | ||
| 63 | |||
| 64 | The unique identifier for the cluster whose snapshot schedules you want | ||
| 65 | to view. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Marker => Str | ||
| 70 | |||
| 71 | A value that indicates the starting point for the next set of response | ||
| 72 | records in a subsequent request. If a value is returned in a response, | ||
| 73 | you can retrieve the next set of records by providing this returned | ||
| 74 | marker value in the C<marker> parameter and retrying the command. If | ||
| 75 | the C<marker> field is empty, all response records have been retrieved | ||
| 76 | for the request. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 MaxRecords => Int | ||
| 81 | |||
| 82 | The maximum number or response records to return in each call. If the | ||
| 83 | number of remaining response records exceeds the specified | ||
| 84 | C<MaxRecords> value, a value is returned in a C<marker> field of the | ||
| 85 | response. You can retrieve the next set of records by retrying the | ||
| 86 | command with the returned C<marker> value. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 ScheduleIdentifier => Str | ||
| 91 | |||
| 92 | A unique identifier for a snapshot schedule. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 TagKeys => ArrayRef[Str|Undef] | ||
| 97 | |||
| 98 | The key value for a snapshot schedule tag. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 TagValues => ArrayRef[Str|Undef] | ||
| 103 | |||
| 104 | The value corresponding to the key of the snapshot schedule tag. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, documenting arguments for method DescribeSnapshotSchedules in L<Paws::RedShift> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |