Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.DescribeEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data DescribeEvents = DescribeEvents' {
- duration :: Maybe Int
- endTime :: Maybe ISO8601
- marker :: Maybe Text
- maxRecords :: Maybe Int
- sourceIdentifier :: Maybe Text
- sourceType :: Maybe SourceType
- startTime :: Maybe ISO8601
}
newDescribeEvents :: DescribeEvents
describeEvents_duration :: Lens' DescribeEvents (Maybe Int)
describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_marker :: Lens' DescribeEvents (Maybe Text)
describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int)
describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)
describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)
describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)
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 #

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

duration :: Maybe Int
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
endTime :: Maybe ISO8601
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
marker :: Maybe Text
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, Amazon Web Services 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.
maxRecords :: Maybe Int
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.
sourceIdentifier :: Maybe Text
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.
sourceType :: Maybe 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.
startTime :: Maybe ISO8601
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

Instances

Instances details

ToHeaders DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods toHeaders :: DescribeEvents -> [Header] #
ToPath DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods toPath :: DescribeEvents -> ByteString #
ToQuery DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods toQuery :: DescribeEvents -> QueryString #
AWSPager DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents #
AWSRequest DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.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 Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Associated Types type Rep DescribeEvents :: Type -> Type # Methods from :: DescribeEvents -> Rep DescribeEvents x # to :: Rep DescribeEvents x -> DescribeEvents #
Read DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEvents # readList :: ReadS [DescribeEvents] # readPrec :: ReadPrec DescribeEvents # readListPrec :: ReadPrec [DescribeEvents] #
Show DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods showsPrec :: Int -> DescribeEvents -> ShowS # show :: DescribeEvents -> String # showList :: [DescribeEvents] -> ShowS #
NFData DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods rnf :: DescribeEvents -> () #
Eq DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods (==) :: DescribeEvents -> DescribeEvents -> Bool # (/=) :: DescribeEvents -> DescribeEvents -> Bool #
Hashable DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents Methods hashWithSalt :: Int -> DescribeEvents -> Int # hash :: DescribeEvents -> Int #
type AWSResponse DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents type AWSResponse DescribeEvents = DescribeEventsResponse
type Rep DescribeEvents Source #
Instance details Defined in Amazonka.Redshift.DescribeEvents type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.Redshift.DescribeEvents" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" '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 "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 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:

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

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

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

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

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

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

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

Request Lenses

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

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

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

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

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

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, Amazon Web Services 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.

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

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.

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

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.

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

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.

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

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

Destructuring the Response

data DescribeEventsResponse Source #

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'

Fields

events :: Maybe [Event]
A list of Event instances.
marker :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

DescribeEventsResponse, describeEventsResponse_events - A list of Event instances.

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

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

Response Lenses

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

A list of Event instances.

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

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.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.