Amazonka.DocumentDB.DescribeEvents

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.

This operation returns paginated results.

Creating a Request

data DescribeEvents

Represents the input to DescribeEvents.

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

• duration :: Maybe Int

  The number of minutes to retrieve events for.

  Default: 60

• endTime :: Maybe ISO8601

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

  Example: 2009-07-08T18:00Z

• eventCategories :: Maybe [Text]

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

• filters :: Maybe [Filter]

  This parameter is not currently supported.

• marker :: Maybe Text

  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 :: Maybe 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 :: Maybe Text

  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 :: Maybe SourceType

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

• startTime :: Maybe ISO8601

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

  Example: 2009-07-08T18:00Z

Instances

ToHeaders DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

toHeaders :: DescribeEvents -> [Header]

ToPath DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

toPath :: DescribeEvents -> ByteString

ToQuery DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

toQuery :: DescribeEvents -> QueryString

AWSPager DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents

AWSRequest DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Associated Types

type AWSResponse DescribeEvents

Methods

request :: (Service -> Service) -> DescribeEvents -> Request DescribeEvents

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEvents)))

Generic DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type

Methods

from :: DescribeEvents -> Rep DescribeEvents x

to :: Rep DescribeEvents x -> DescribeEvents

Read DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

readsPrec :: Int -> ReadS DescribeEvents

readList :: ReadS [DescribeEvents]

readPrec :: ReadPrec DescribeEvents

readListPrec :: ReadPrec [DescribeEvents]

Show DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

showsPrec :: Int -> DescribeEvents -> ShowS

show :: DescribeEvents -> String

showList :: [DescribeEvents] -> ShowS

NFData DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

rnf :: DescribeEvents -> ()

Eq DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

(==) :: DescribeEvents -> DescribeEvents -> Bool

(/=) :: DescribeEvents -> DescribeEvents -> Bool

Hashable DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

hashWithSalt :: Int -> DescribeEvents -> Int

hash :: DescribeEvents -> Int

type AWSResponse DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

type AWSResponse DescribeEvents = DescribeEventsResponse

type Rep DescribeEvents

Defined in Amazonka.DocumentDB.DescribeEvents

type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.DocumentDB.DescribeEvents" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :*: ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))))

newDescribeEvents :: DescribeEvents

Create a value of DescribeEvents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:duration:DescribeEvents', describeEvents_duration - The number of minutes to retrieve events for.

Default: 60

$sel:endTime:DescribeEvents', describeEvents_endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

DescribeEvents, describeEvents_eventCategories - A list of event categories that trigger notifications for an event notification subscription.

$sel:filters:DescribeEvents', describeEvents_filters - This parameter is not currently supported.

DescribeEvents, describeEvents_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.

$sel:maxRecords:DescribeEvents', describeEvents_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.

DescribeEvents, describeEvents_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.

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

$sel:startTime:DescribeEvents', describeEvents_startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Request Lenses

describeEvents_duration :: Lens' DescribeEvents (Maybe Int)

The number of minutes to retrieve events for.

Default: 60

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)

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

Example: 2009-07-08T18:00Z

describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text])

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

describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter])

This parameter is not currently supported.

describeEvents_marker :: Lens' DescribeEvents (Maybe Text)

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.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe 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.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)

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.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)

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

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)

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

Example: 2009-07-08T18:00Z

Destructuring the Response

data DescribeEventsResponse

Represents the output of DescribeEvents.

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'

Fields

• events :: Maybe [Event]

  Detailed information about one or more events.

• marker :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeEventsResponse

Defined in Amazonka.DocumentDB.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type

Methods

from :: DescribeEventsResponse -> Rep DescribeEventsResponse x

to :: Rep DescribeEventsResponse x -> DescribeEventsResponse

Read DescribeEventsResponse

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

readsPrec :: Int -> ReadS DescribeEventsResponse

readList :: ReadS [DescribeEventsResponse]

readPrec :: ReadPrec DescribeEventsResponse

readListPrec :: ReadPrec [DescribeEventsResponse]

Show DescribeEventsResponse

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

showsPrec :: Int -> DescribeEventsResponse -> ShowS

show :: DescribeEventsResponse -> String

showList :: [DescribeEventsResponse] -> ShowS

NFData DescribeEventsResponse

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> ()

Eq DescribeEventsResponse

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

(==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

(/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

type Rep DescribeEventsResponse

Defined in Amazonka.DocumentDB.DescribeEvents

type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.DocumentDB.DescribeEvents" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Event])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse

Arguments

:: Int

$sel:httpStatus:DescribeEventsResponse'

-> DescribeEventsResponse

Create a value of DescribeEventsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:events:DescribeEventsResponse', describeEventsResponse_events - Detailed information about one or more events.

DescribeEvents, describeEventsResponse_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.

$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

Response Lenses

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])

Detailed information about one or more events.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text)

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.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

The response's http status code.