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.DescribeEventSubscriptions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEventSubscriptions Source #

Represents the input to DescribeEventSubscriptions.

See: newDescribeEventSubscriptions smart constructor.

Constructors

DescribeEventSubscriptions'

Fields

subscriptionName :: Maybe Text
The name of the Amazon DocumentDB event notification subscription that you want to describe.
filters :: Maybe [Filter]
This parameter is not currently supported.
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.

Instances

Instances details

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

newDescribeEventSubscriptions :: DescribeEventSubscriptions Source #

Create a value of DescribeEventSubscriptions 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:subscriptionName:DescribeEventSubscriptions', describeEventSubscriptions_subscriptionName - The name of the Amazon DocumentDB event notification subscription that you want to describe.

$sel:filters:DescribeEventSubscriptions', describeEventSubscriptions_filters - This parameter is not currently supported.

$sel:marker:DescribeEventSubscriptions', describeEventSubscriptions_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:DescribeEventSubscriptions', describeEventSubscriptions_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.

Request Lenses

describeEventSubscriptions_subscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text) Source #

The name of the Amazon DocumentDB event notification subscription that you want to describe.

describeEventSubscriptions_filters :: Lens' DescribeEventSubscriptions (Maybe [Filter]) Source #

This parameter is not currently supported.

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

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

Destructuring the Response

data DescribeEventSubscriptionsResponse Source #

Represents the output of DescribeEventSubscriptions.

See: newDescribeEventSubscriptionsResponse smart constructor.

Constructors

DescribeEventSubscriptionsResponse'
Fields eventSubscriptionsList :: Maybe [EventSubscription] A list of event subscriptions. 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 DescribeEventSubscriptionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEventSubscriptions Methods (==) :: DescribeEventSubscriptionsResponse -> DescribeEventSubscriptionsResponse -> Bool # (/=) :: DescribeEventSubscriptionsResponse -> DescribeEventSubscriptionsResponse -> Bool #
Read DescribeEventSubscriptionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEventSubscriptions Methods readsPrec :: Int -> ReadS DescribeEventSubscriptionsResponse # readList :: ReadS [DescribeEventSubscriptionsResponse] # readPrec :: ReadPrec DescribeEventSubscriptionsResponse # readListPrec :: ReadPrec [DescribeEventSubscriptionsResponse] #
Show DescribeEventSubscriptionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEventSubscriptions Methods showsPrec :: Int -> DescribeEventSubscriptionsResponse -> ShowS # show :: DescribeEventSubscriptionsResponse -> String # showList :: [DescribeEventSubscriptionsResponse] -> ShowS #
Generic DescribeEventSubscriptionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEventSubscriptions Associated Types type Rep DescribeEventSubscriptionsResponse :: Type -> Type # Methods from :: DescribeEventSubscriptionsResponse -> Rep DescribeEventSubscriptionsResponse x # to :: Rep DescribeEventSubscriptionsResponse x -> DescribeEventSubscriptionsResponse #
NFData DescribeEventSubscriptionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEventSubscriptions Methods rnf :: DescribeEventSubscriptionsResponse -> () #
type Rep DescribeEventSubscriptionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEventSubscriptions type Rep DescribeEventSubscriptionsResponse = D1 ('MetaData "DescribeEventSubscriptionsResponse" "Amazonka.DocumentDB.DescribeEventSubscriptions" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeEventSubscriptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscriptionsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventSubscription])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventSubscriptionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEventSubscriptionsResponse'`
-> DescribeEventSubscriptionsResponse

Create a value of DescribeEventSubscriptionsResponse 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:eventSubscriptionsList:DescribeEventSubscriptionsResponse', describeEventSubscriptionsResponse_eventSubscriptionsList - A list of event subscriptions.

$sel:marker:DescribeEventSubscriptions', describeEventSubscriptionsResponse_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:DescribeEventSubscriptionsResponse', describeEventSubscriptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeEventSubscriptionsResponse_eventSubscriptionsList :: Lens' DescribeEventSubscriptionsResponse (Maybe [EventSubscription]) Source #

A list of event subscriptions.

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

describeEventSubscriptionsResponse_httpStatus :: Lens' DescribeEventSubscriptionsResponse Int Source #

The response's http status code.