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 |
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.
Synopsis
- describeEventSubscriptions :: DescribeEventSubscriptions
- data DescribeEventSubscriptions
- dessSubscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text)
- dessTagValues :: Lens' DescribeEventSubscriptions [Text]
- dessTagKeys :: Lens' DescribeEventSubscriptions [Text]
- dessMarker :: Lens' DescribeEventSubscriptions (Maybe Text)
- dessMaxRecords :: Lens' DescribeEventSubscriptions (Maybe Int)
- describeEventSubscriptionsResponse :: Int -> DescribeEventSubscriptionsResponse
- data DescribeEventSubscriptionsResponse
- desrsEventSubscriptionsList :: Lens' DescribeEventSubscriptionsResponse [EventSubscription]
- desrsMarker :: Lens' DescribeEventSubscriptionsResponse (Maybe Text)
- desrsResponseStatus :: Lens' DescribeEventSubscriptionsResponse Int
Creating a Request
describeEventSubscriptions :: DescribeEventSubscriptions Source #
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 calledadmin
andtest
. 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 calledowner
andenvironment
. 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 inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 specifiedMaxRecords
value, a value is returned in amarker
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 Source #
See: describeEventSubscriptions
smart constructor.
Instances
Request Lenses
dessSubscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text) Source #
The name of the Amazon Redshift event notification subscription to be described.
dessTagValues :: Lens' DescribeEventSubscriptions [Text] Source #
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] Source #
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) Source #
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) 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.
Destructuring the Response
describeEventSubscriptionsResponse Source #
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 theMarker
parameter and retrying the command. If theMarker
field is empty, all response records have been retrieved for the request.desrsResponseStatus
- -- | The response status code.
data DescribeEventSubscriptionsResponse Source #
See: describeEventSubscriptionsResponse
smart constructor.
Instances
Response Lenses
desrsEventSubscriptionsList :: Lens' DescribeEventSubscriptionsResponse [EventSubscription] Source #
A list of event subscriptions.
desrsMarker :: Lens' DescribeEventSubscriptionsResponse (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.
desrsResponseStatus :: Lens' DescribeEventSubscriptionsResponse Int Source #
- - | The response status code.