/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RDS::DescribeEvents

NAME

Paws::RDS::DescribeEvents - Arguments for method DescribeEvents on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method DescribeEvents on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method DescribeEvents.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEvents.

SYNOPSIS

my $rds = Paws->service('RDS');
# To list information about events
# This example lists information for all backup-related events for the specified
# DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080
# minutes).
my $EventsMessage = $rds->DescribeEvents(
  'Duration'         => 10080,
  'EventCategories'  => ['backup'],
  'SourceIdentifier' => 'mymysqlinstance',
  'SourceType'       => 'db-instance'
);

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeEvents

ATTRIBUTES

Duration => Int

The number of minutes to retrieve events for.

Default: 60

EndTime => Str

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)

Example: 2009-07-08T18:00Z

EventCategories => ArrayRef[Str|Undef]

A list of event categories that trigger notifications for a event notification subscription.

Filters => ArrayRef[Paws::RDS::Filter]

This parameter isn't currently supported.

Marker => Str

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords => Int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

SourceIdentifier => Str

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

  • Can't end with a hyphen or contain two consecutive hyphens.

SourceType => Str

The event source to retrieve events for. If no value is specified, all events are returned.

Valid values are: "db-instance", "db-parameter-group", "db-security-group", "db-snapshot", "db-cluster", "db-cluster-snapshot"

StartTime => Str

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)

Example: 2009-07-08T18:00Z

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeEvents in Paws::RDS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues