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