amazonka-redshift-1.4.5: Amazon Redshift SDK.

Copyright (c) 2013-2016 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Network.AWS.Redshift.DescribeEvents

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.

# Creating a Request

Creates a value of DescribeEvents with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• deStartTime - 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
• deSourceType - 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.
• deSourceIdentifier - 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 .
• deMarker - 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 , AWS 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.
• deMaxRecords - 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.
• deEndTime - 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
• deDuration - 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

See: describeEvents smart constructor.

Instances

 Source # Methods Source # Methodsgfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEvents -> c DescribeEvents #gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEvents #dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEvents) #dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEvents) #gmapT :: (forall b. Data b => b -> b) -> DescribeEvents -> DescribeEvents #gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #gmapQ :: (forall d. Data d => d -> u) -> DescribeEvents -> [u] #gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEvents -> u #gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents # Source # Methods Source # MethodsshowList :: [DescribeEvents] -> ShowS # Source # Associated Typestype Rep DescribeEvents :: * -> * # Methods Source # Methods Source # Methodsrnf :: DescribeEvents -> () # Source # Methods Source # Associated Typestype Rs DescribeEvents :: * # Methods Source # Methods Source # Methods Source # Methods Source # type Rep DescribeEvents = D1 (MetaData "DescribeEvents" "Network.AWS.Redshift.DescribeEvents" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeEvents'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_deStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) ((:*:) (S1 (MetaSel (Just Symbol "_deSourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourceType))) (S1 (MetaSel (Just Symbol "_deSourceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_deMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_deMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_deEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_deDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))) type Rs DescribeEvents Source #

# Request Lenses

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

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.

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 .

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 , AWS 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.

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.

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

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

# Destructuring the Response

Arguments

 :: Int dersResponseStatus -> DescribeEventsResponse

Creates a value of DescribeEventsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dersEvents - A list of Event instances.
• dersMarker - 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.
• dersResponseStatus - -- | The response status code.

See: describeEventsResponse smart constructor.

Instances

 Source # Methods Source # Methodsgfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEventsResponse -> c DescribeEventsResponse #gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEventsResponse #dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEventsResponse) #dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEventsResponse) #gmapT :: (forall b. Data b => b -> b) -> DescribeEventsResponse -> DescribeEventsResponse #gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #gmapQ :: (forall d. Data d => d -> u) -> DescribeEventsResponse -> [u] #gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEventsResponse -> u #gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse # Source # Source # Methods Source # Associated Typestype Rep DescribeEventsResponse :: * -> * # Methods Source # Methodsrnf :: DescribeEventsResponse -> () # Source # type Rep DescribeEventsResponse = D1 (MetaData "DescribeEventsResponse" "Network.AWS.Redshift.DescribeEvents" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeEventsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Event]))) ((:*:) (S1 (MetaSel (Just Symbol "_dersMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

# Response Lenses

A list of Event instances.

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.

• - | The response status code.