Menu
AWS Database Migration Service
API Reference (API Version 2016-01-01)

DescribeEvents

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications .

Request Syntax

{ "Duration": number, "EndTime": number, "EventCategories": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "Marker": "string", "MaxRecords": number, "SourceIdentifier": "string", "SourceType": "string", "StartTime": number }

Request Parameters

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

The request accepts the following data in JSON format.

Duration

The duration of the events to be listed.

Type: Integer

Required: No

EndTime

The end time for the events to be listed.

Type: Timestamp

Required: No

EventCategories

A list of event categories for a source type that you want to subscribe to.

Type: Array of strings

Required: No

Filters

Filters applied to the action.

Type: Array of Filter objects

Required: No

Marker

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.

Type: String

Required: No

MaxRecords

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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

SourceIdentifier

The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.

Type: String

Required: No

SourceType

The type of AWS DMS resource that generates events.

Valid values: replication-instance | migration-task

Type: String

Valid Values: replication-instance

Required: No

StartTime

The start time for the events to be listed.

Type: Timestamp

Required: No

Response Syntax

{ "Events": [ { "Date": number, "EventCategories": [ "string" ], "Message": "string", "SourceIdentifier": "string", "SourceType": "string" } ], "Marker": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Events

The events described.

Type: Array of Event objects

Marker

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.

Type: String

Errors

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

See Also

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