« blib/lib/Paws/Neptune/DescribeEventSubscriptions.pm
↑ Summary
blib/lib/Paws/Neptune/DescribeOrderableDBInstanceOptions.pm »
| 1 | |||
| 2 | package Paws::Neptune::DescribeEvents; | ||
| 3 | use Moose; | ||
| 4 | has Duration => (is => 'ro', isa => 'Int'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has EventCategories => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Filter]'); | ||
| 8 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 9 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 10 | has SourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 11 | has SourceType => (is => 'ro', isa => 'Str'); | ||
| 12 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEvents'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::EventsMessage'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEventsResult'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Neptune::DescribeEvents - Arguments for method DescribeEvents on L<Paws::Neptune> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeEvents on the | ||
| 30 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeEvents. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEvents. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $rds = Paws->service('Neptune'); | ||
| 38 | my $EventsMessage = $rds->DescribeEvents( | ||
| 39 | Duration => 1, # OPTIONAL | ||
| 40 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 41 | EventCategories => [ 'MyString', ... ], # OPTIONAL | ||
| 42 | Filters => [ | ||
| 43 | { | ||
| 44 | Name => 'MyString', | ||
| 45 | Values => [ 'MyString', ... ], | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | Marker => 'MyString', # OPTIONAL | ||
| 51 | MaxRecords => 1, # OPTIONAL | ||
| 52 | SourceIdentifier => 'MyString', # OPTIONAL | ||
| 53 | SourceType => 'db-instance', # OPTIONAL | ||
| 54 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $Events = $EventsMessage->Events; | ||
| 59 | my $Marker = $EventsMessage->Marker; | ||
| 60 | |||
| 61 | # Returns a L<Paws::Neptune::EventsMessage> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeEvents> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Duration => Int | ||
| 70 | |||
| 71 | The number of minutes to retrieve events for. | ||
| 72 | |||
| 73 | Default: 60 | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 EndTime => Str | ||
| 78 | |||
| 79 | The end of the time interval for which to retrieve events, specified in | ||
| 80 | ISO 8601 format. For more information about ISO 8601, go to the ISO8601 | ||
| 81 | Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) | ||
| 82 | |||
| 83 | Example: 2009-07-08T18:00Z | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 EventCategories => ArrayRef[Str|Undef] | ||
| 88 | |||
| 89 | A list of event categories that trigger notifications for a event | ||
| 90 | notification subscription. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 Filters => ArrayRef[L<Paws::Neptune::Filter>] | ||
| 95 | |||
| 96 | This parameter is not currently supported. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 Marker => Str | ||
| 101 | |||
| 102 | An optional pagination token provided by a previous DescribeEvents | ||
| 103 | request. If this parameter is specified, the response includes only | ||
| 104 | records beyond the marker, up to the value specified by C<MaxRecords>. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 MaxRecords => Int | ||
| 109 | |||
| 110 | The maximum number of records to include in the response. If more | ||
| 111 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 112 | token called a marker is included in the response so that the remaining | ||
| 113 | results can be retrieved. | ||
| 114 | |||
| 115 | Default: 100 | ||
| 116 | |||
| 117 | Constraints: Minimum 20, maximum 100. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 SourceIdentifier => Str | ||
| 122 | |||
| 123 | The identifier of the event source for which events are returned. If | ||
| 124 | not specified, then all sources are included in the response. | ||
| 125 | |||
| 126 | Constraints: | ||
| 127 | |||
| 128 | =over | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | If SourceIdentifier is supplied, SourceType must also be provided. | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | If the source type is C<DBInstance>, then a C<DBInstanceIdentifier> | ||
| 137 | must be supplied. | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | If the source type is C<DBSecurityGroup>, a C<DBSecurityGroupName> must | ||
| 142 | be supplied. | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | If the source type is C<DBParameterGroup>, a C<DBParameterGroupName> | ||
| 147 | must be supplied. | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | If the source type is C<DBSnapshot>, a C<DBSnapshotIdentifier> must be | ||
| 152 | supplied. | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 157 | |||
| 158 | =back | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 SourceType => Str | ||
| 164 | |||
| 165 | The event source to retrieve events for. If no value is specified, all | ||
| 166 | events are returned. | ||
| 167 | |||
| 168 | Valid values are: C<"db-instance">, C<"db-parameter-group">, C<"db-security-group">, C<"db-snapshot">, C<"db-cluster">, C<"db-cluster-snapshot"> | ||
| 169 | |||
| 170 | =head2 StartTime => Str | ||
| 171 | |||
| 172 | The beginning of the time interval to retrieve events for, specified in | ||
| 173 | ISO 8601 format. For more information about ISO 8601, go to the ISO8601 | ||
| 174 | Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) | ||
| 175 | |||
| 176 | Example: 2009-07-08T18:00Z | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head1 SEE ALSO | ||
| 182 | |||
| 183 | This class forms part of L<Paws>, documenting arguments for method DescribeEvents in L<Paws::Neptune> | ||
| 184 | |||
| 185 | =head1 BUGS and CONTRIBUTIONS | ||
| 186 | |||
| 187 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 188 | |||
| 189 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 190 | |||
| 191 | =cut | ||
| 192 |