Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.DescribeEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

This operation returns paginated results.

Synopsis

data DescribeEvents = DescribeEvents' {
- startTime :: Maybe ISO8601
- sourceType :: Maybe SourceType
- filters :: Maybe [Filter]
- sourceIdentifier :: Maybe Text
- eventCategories :: Maybe [Text]
- marker :: Maybe Text
- maxRecords :: Maybe Int
- endTime :: Maybe ISO8601
- duration :: Maybe Int
}
newDescribeEvents :: DescribeEvents
describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)
describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter])
describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)
describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text])
describeEvents_marker :: Lens' DescribeEvents (Maybe Text)
describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int)
describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_duration :: Lens' DescribeEvents (Maybe Int)
data DescribeEventsResponse = DescribeEventsResponse' {
- events :: Maybe [Event]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeEventsResponse :: Int -> DescribeEventsResponse
describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])
describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text)
describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

Creating a Request

data DescribeEvents Source #

Represents the input to DescribeEvents.

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

startTime :: Maybe ISO8601
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
sourceType :: Maybe SourceType
The event source to retrieve events for. If no value is specified, all events are returned.
filters :: Maybe [Filter]
This parameter is not currently supported.
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.
eventCategories :: Maybe [Text]
A list of event categories that trigger notifications for an event notification subscription.
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.
endTime :: Maybe ISO8601
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
duration :: Maybe Int
The number of minutes to retrieve events for.
Default: 60

Instances

Instances details

Eq DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods (==) :: DescribeEvents -> DescribeEvents -> Bool # (/=) :: DescribeEvents -> DescribeEvents -> Bool #
Read DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEvents # readList :: ReadS [DescribeEvents] # readPrec :: ReadPrec DescribeEvents # readListPrec :: ReadPrec [DescribeEvents] #
Show DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods showsPrec :: Int -> DescribeEvents -> ShowS # show :: DescribeEvents -> String # showList :: [DescribeEvents] -> ShowS #
Generic DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Associated Types type Rep DescribeEvents :: Type -> Type # Methods from :: DescribeEvents -> Rep DescribeEvents x # to :: Rep DescribeEvents x -> DescribeEvents #
NFData DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods rnf :: DescribeEvents -> () #
Hashable DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods hashWithSalt :: Int -> DescribeEvents -> Int # hash :: DescribeEvents -> Int #
AWSPager DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents #
AWSRequest DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Associated Types type AWSResponse DescribeEvents # Methods request :: DescribeEvents -> Request DescribeEvents # response :: MonadResource m => Logger -> Service -> Proxy DescribeEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEvents))) #
ToHeaders DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods toHeaders :: DescribeEvents -> [Header] #
ToPath DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods toPath :: DescribeEvents -> ByteString #
ToQuery DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods toQuery :: DescribeEvents -> QueryString #
type Rep DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.DocumentDB.DescribeEvents" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))
type AWSResponse DescribeEvents Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents type AWSResponse DescribeEvents = DescribeEventsResponse

newDescribeEvents :: DescribeEvents Source #

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:startTime:DescribeEvents', describeEvents_startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

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

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

$sel:sourceIdentifier: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.

$sel:eventCategories:DescribeEvents', describeEvents_eventCategories - A list of event categories that trigger notifications for an event notification subscription.

$sel:marker: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.

$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

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

Default: 60

Request Lenses

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

Example: 2009-07-08T18:00Z

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

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

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

This parameter is not currently supported.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

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_eventCategories :: Lens' DescribeEvents (Maybe [Text]) Source #

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

describeEvents_marker :: Lens' DescribeEvents (Maybe Text) Source #

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) Source #

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_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

Example: 2009-07-08T18:00Z

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

The number of minutes to retrieve events for.

Default: 60

Destructuring the Response

data DescribeEventsResponse Source #

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

Instances details

Eq DescribeEventsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods (==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool # (/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool #
Read DescribeEventsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEventsResponse # readList :: ReadS [DescribeEventsResponse] # readPrec :: ReadPrec DescribeEventsResponse # readListPrec :: ReadPrec [DescribeEventsResponse] #
Show DescribeEventsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods showsPrec :: Int -> DescribeEventsResponse -> ShowS # show :: DescribeEventsResponse -> String # showList :: [DescribeEventsResponse] -> ShowS #
Generic DescribeEventsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Associated Types type Rep DescribeEventsResponse :: Type -> Type # Methods from :: DescribeEventsResponse -> Rep DescribeEventsResponse x # to :: Rep DescribeEventsResponse x -> DescribeEventsResponse #
NFData DescribeEventsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents Methods rnf :: DescribeEventsResponse -> () #
type Rep DescribeEventsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEvents type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.DocumentDB.DescribeEvents" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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 Source #

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.

$sel:marker: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]) Source #

Detailed information about one or more events.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text) Source #

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 Source #

The response's http status code.