NAME

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

DESCRIPTION

This class represents the parameters used for calling the method DescribeEvents on the Amazon DocumentDB with MongoDB compatibility 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('DocDB');
    my $EventsMessage = $rds->DescribeEvents(
      Duration        => 1,                        # OPTIONAL
      EndTime         => '1970-01-01T01:00:00',    # OPTIONAL
      EventCategories => [ 'MyString', ... ],      # OPTIONAL
      Filters         => [
        {
          Name   => 'MyString',
          Values => [ 'MyString', ... ],
        },
        ...
      ],                                           # OPTIONAL
      Marker           => 'MyString',              # OPTIONAL
      MaxRecords       => 1,                       # OPTIONAL
      SourceIdentifier => 'MyString',              # OPTIONAL
      SourceType       => 'db-instance',           # OPTIONAL
      StartTime        => '1970-01-01T01:00:00',   # OPTIONAL
    );
    # Results:
    my $Events = $EventsMessage->Events;
    my $Marker = $EventsMessage->Marker;
    # Returns a L<Paws::DocDB::EventsMessage> object.

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.

Example: 2009-07-08T18:00Z

EventCategories => ArrayRef[Str|Undef]

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

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

This parameter is not currently supported.

Marker => Str

An optional pagination token provided by a previous 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 (marker) is included in the response so that the remaining results can be retrieved.

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 provided, "SourceType" must also be provided.
If the source type is "DBInstance", a "DBInstanceIdentifier" must be provided.
If the source type is "DBSecurityGroup", a "DBSecurityGroupName" must be provided.
If the source type is "DBParameterGroup", a "DBParameterGroupName" must be provided.
If the source type is "DBSnapshot", a "DBSnapshotIdentifier" must be provided.
Cannot 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.

Example: 2009-07-08T18:00Z

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>