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

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method DescribeEvents on the Amazon Redshift 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 $redshift = Paws->service('RedShift');
my $EventsMessage = $redshift->DescribeEvents(
  Duration         => 1,                        # OPTIONAL
  EndTime          => '1970-01-01T01:00:00',    # OPTIONAL
  Marker           => 'MyString',               # OPTIONAL
  MaxRecords       => 1,                        # OPTIONAL
  SourceIdentifier => 'MyString',               # OPTIONAL
  SourceType       => 'cluster',                # OPTIONAL
  StartTime        => '1970-01-01T01:00:00',    # OPTIONAL
);

# Results:
my $Events = $EventsMessage->Events;
my $Marker = $EventsMessage->Marker;

# Returns a L<Paws::RedShift::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/redshift/DescribeEvents

ATTRIBUTES

Duration => Int

The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

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

Marker => Str

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords => Int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

SourceIdentifier => Str

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

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

  • Specify a cluster identifier when SourceType is cluster.

  • Specify a cluster security group name when SourceType is cluster-security-group.

  • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

  • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

SourceType => Str

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

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

  • Specify cluster when SourceIdentifier is a cluster identifier.

  • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

  • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

  • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

Valid values are: "cluster", "cluster-parameter-group", "cluster-security-group", "cluster-snapshot", "scheduled-action"

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::RedShift

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