Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

DescribeEvents

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Duration

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

Type: Integer

Required: No

EndTime

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.

Example: 2009-07-08T18:00Z

Type: Timestamp

Required: No

Marker

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.

Type: String

Required: No

MaxRecords

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.

Type: Integer

Required: No

SourceIdentifier

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.

Type: String

Required: No

SourceType

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.

Type: String

Valid Values: cluster | cluster-parameter-group | cluster-security-group | cluster-snapshot

Required: No

StartTime

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.

Example: 2009-07-08T18:00Z

Type: Timestamp

Required: No

Response Elements

The following elements are returned by the service.

Events.Event.N

A list of Event instances.

Type: Array of Event objects

Marker

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/ ?Action=DescribeEvents &Version=2012-12-01 &x-amz-algorithm=AWS4-HMAC-SHA256 &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request &x-amz-date=20121207T232427Z &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<DescribeEventsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <DescribeEventsResult> <Events> <Event> <Message>Cluster security group securitygroup1 has been updated. Changes need to be applied to all clusters using this cluster security group.</Message> <SourceType>cluster-security-group</SourceType> <Date>2012-12-07T23:05:02.660Z</Date> <SourceIdentifier>securitygroup1</SourceIdentifier> </Event> </Events> </DescribeEventsResult> <ResponseMetadata> <RequestId>3eeb9efe-40c5-11e2-816a-1bba29fad1f5</RequestId> </ResponseMetadata> </DescribeEventsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: