docdb_describe_events: Returns events related to instances, security groups,...

Description Usage Arguments Value Request syntax

View source: R/docdb_operations.R

Description

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

Usage

1
2
docdb_describe_events(SourceIdentifier, SourceType, StartTime, EndTime,
  Duration, EventCategories, Filters, MaxRecords, Marker)

Arguments

SourceIdentifier

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

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

StartTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

EndTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Duration

The number of minutes to retrieve events for.

Default: 60

EventCategories

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

Filters

This parameter is not currently supported.

MaxRecords

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.

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
list(
  Marker = "string",
  Events = list(
    list(
      SourceIdentifier = "string",
      SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot",
      Message = "string",
      EventCategories = list(
        "string"
      ),
      Date = as.POSIXct(
        "2015-01-01"
      ),
      SourceArn = "string"
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
svc$describe_events(
  SourceIdentifier = "string",
  SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Duration = 123,
  EventCategories = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

paws.database documentation built on March 9, 2021, 5:11 p.m.