Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Redshift.DescribeEventSubscriptions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.

This operation returns paginated results.

Creating a Request

describeEventSubscriptions :: DescribeEventSubscriptions #

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

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

dessSubscriptionName - The name of the Amazon Redshift event notification subscription to be described.
dessTagValues - A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.
dessTagKeys - A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.
dessMarker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions 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.
dessMaxRecords - 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.

data DescribeEventSubscriptions #

See: describeEventSubscriptions smart constructor.

Instances

Eq DescribeEventSubscriptions #
Methods (==) :: DescribeEventSubscriptions -> DescribeEventSubscriptions -> Bool # (/=) :: DescribeEventSubscriptions -> DescribeEventSubscriptions -> Bool #
Data DescribeEventSubscriptions #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEventSubscriptions -> c DescribeEventSubscriptions # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEventSubscriptions # toConstr :: DescribeEventSubscriptions -> Constr # dataTypeOf :: DescribeEventSubscriptions -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEventSubscriptions) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEventSubscriptions) # gmapT :: (forall b. Data b => b -> b) -> DescribeEventSubscriptions -> DescribeEventSubscriptions # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventSubscriptions -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventSubscriptions -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeEventSubscriptions -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEventSubscriptions -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEventSubscriptions -> m DescribeEventSubscriptions # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventSubscriptions -> m DescribeEventSubscriptions # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventSubscriptions -> m DescribeEventSubscriptions #
Read DescribeEventSubscriptions #
Methods readsPrec :: Int -> ReadS DescribeEventSubscriptions # readList :: ReadS [DescribeEventSubscriptions] # readPrec :: ReadPrec DescribeEventSubscriptions # readListPrec :: ReadPrec [DescribeEventSubscriptions] #
Show DescribeEventSubscriptions #
Methods showsPrec :: Int -> DescribeEventSubscriptions -> ShowS # show :: DescribeEventSubscriptions -> String # showList :: [DescribeEventSubscriptions] -> ShowS #
Generic DescribeEventSubscriptions #
Associated Types type Rep DescribeEventSubscriptions :: * -> * # Methods from :: DescribeEventSubscriptions -> Rep DescribeEventSubscriptions x # to :: Rep DescribeEventSubscriptions x -> DescribeEventSubscriptions #
Hashable DescribeEventSubscriptions #
Methods hashWithSalt :: Int -> DescribeEventSubscriptions -> Int # hash :: DescribeEventSubscriptions -> Int #
NFData DescribeEventSubscriptions #
Methods rnf :: DescribeEventSubscriptions -> () #
AWSPager DescribeEventSubscriptions #
Methods page :: DescribeEventSubscriptions -> Rs DescribeEventSubscriptions -> Maybe DescribeEventSubscriptions #
AWSRequest DescribeEventSubscriptions #
Associated Types type Rs DescribeEventSubscriptions :: * # Methods request :: DescribeEventSubscriptions -> Request DescribeEventSubscriptions # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeEventSubscriptions -> ClientResponse -> m (Response DescribeEventSubscriptions) #
ToHeaders DescribeEventSubscriptions #
Methods toHeaders :: DescribeEventSubscriptions -> [Header] #
ToPath DescribeEventSubscriptions #
Methods toPath :: DescribeEventSubscriptions -> ByteString #
ToQuery DescribeEventSubscriptions #
Methods toQuery :: DescribeEventSubscriptions -> QueryString #
type Rep DescribeEventSubscriptions #
type Rep DescribeEventSubscriptions = D1 * (MetaData "DescribeEventSubscriptions" "Network.AWS.Redshift.DescribeEventSubscriptions" "amazonka-redshift-1.6.0-LZqm5saD9VdK7dzUu4YYAo" False) (C1 * (MetaCons "DescribeEventSubscriptions'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_dessSubscriptionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dessTagValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((::) (S1 * (MetaSel (Just Symbol "_dessTagKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((::) (S1 * (MetaSel (Just Symbol "_dessMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dessMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))
type Rs DescribeEventSubscriptions #
type Rs DescribeEventSubscriptions = DescribeEventSubscriptionsResponse

Request Lenses

dessSubscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text) #

The name of the Amazon Redshift event notification subscription to be described.

dessTagValues :: Lens' DescribeEventSubscriptions [Text] #

A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.

dessTagKeys :: Lens' DescribeEventSubscriptions [Text] #

A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.

dessMarker :: Lens' DescribeEventSubscriptions (Maybe Text) #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions 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.

dessMaxRecords :: Lens' DescribeEventSubscriptions (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.

Destructuring the Response

describeEventSubscriptionsResponse #

Arguments

:: Int	`desrsResponseStatus`
-> DescribeEventSubscriptionsResponse

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

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

desrsEventSubscriptionsList - A list of event subscriptions.
desrsMarker - 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.
desrsResponseStatus - -- | The response status code.

data DescribeEventSubscriptionsResponse #

See: describeEventSubscriptionsResponse smart constructor.

Instances

Eq DescribeEventSubscriptionsResponse #
Methods (==) :: DescribeEventSubscriptionsResponse -> DescribeEventSubscriptionsResponse -> Bool # (/=) :: DescribeEventSubscriptionsResponse -> DescribeEventSubscriptionsResponse -> Bool #
Data DescribeEventSubscriptionsResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEventSubscriptionsResponse -> c DescribeEventSubscriptionsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEventSubscriptionsResponse # toConstr :: DescribeEventSubscriptionsResponse -> Constr # dataTypeOf :: DescribeEventSubscriptionsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEventSubscriptionsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEventSubscriptionsResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeEventSubscriptionsResponse -> DescribeEventSubscriptionsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventSubscriptionsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventSubscriptionsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeEventSubscriptionsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEventSubscriptionsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEventSubscriptionsResponse -> m DescribeEventSubscriptionsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventSubscriptionsResponse -> m DescribeEventSubscriptionsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventSubscriptionsResponse -> m DescribeEventSubscriptionsResponse #
Read DescribeEventSubscriptionsResponse #
Methods readsPrec :: Int -> ReadS DescribeEventSubscriptionsResponse # readList :: ReadS [DescribeEventSubscriptionsResponse] # readPrec :: ReadPrec DescribeEventSubscriptionsResponse # readListPrec :: ReadPrec [DescribeEventSubscriptionsResponse] #
Show DescribeEventSubscriptionsResponse #
Methods showsPrec :: Int -> DescribeEventSubscriptionsResponse -> ShowS # show :: DescribeEventSubscriptionsResponse -> String # showList :: [DescribeEventSubscriptionsResponse] -> ShowS #
Generic DescribeEventSubscriptionsResponse #
Associated Types type Rep DescribeEventSubscriptionsResponse :: * -> * # Methods from :: DescribeEventSubscriptionsResponse -> Rep DescribeEventSubscriptionsResponse x # to :: Rep DescribeEventSubscriptionsResponse x -> DescribeEventSubscriptionsResponse #
NFData DescribeEventSubscriptionsResponse #
Methods rnf :: DescribeEventSubscriptionsResponse -> () #
type Rep DescribeEventSubscriptionsResponse #
type Rep DescribeEventSubscriptionsResponse = D1 * (MetaData "DescribeEventSubscriptionsResponse" "Network.AWS.Redshift.DescribeEventSubscriptions" "amazonka-redshift-1.6.0-LZqm5saD9VdK7dzUu4YYAo" False) (C1 * (MetaCons "DescribeEventSubscriptionsResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_desrsEventSubscriptionsList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [EventSubscription]))) ((::) (S1 * (MetaSel (Just Symbol "_desrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_desrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

desrsEventSubscriptionsList :: Lens' DescribeEventSubscriptionsResponse [EventSubscription] #

A list of event subscriptions.

desrsMarker :: Lens' DescribeEventSubscriptionsResponse (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.

desrsResponseStatus :: Lens' DescribeEventSubscriptionsResponse Int #

- | The response status code.