libZSservicesZSamazonka-dmsZSamazonka-dms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DMS.DescribeEventSubscriptions

Description

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

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEventSubscriptions Source #

See: newDescribeEventSubscriptions smart constructor.

Constructors

DescribeEventSubscriptions' 

Fields

  • subscriptionName :: Maybe Text

    The name of the DMS event subscription to be described.

  • filters :: Maybe [Filter]

    Filters applied to 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.

  • 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 called a 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.DMS.DescribeEventSubscriptions

Read DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Show DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Generic DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Associated Types

type Rep DescribeEventSubscriptions :: Type -> Type #

NFData DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Hashable DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

ToJSON DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

AWSPager DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

AWSRequest DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

ToHeaders DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

ToPath DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

ToQuery DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

type Rep DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

type Rep DescribeEventSubscriptions = D1 ('MetaData "DescribeEventSubscriptions" "Amazonka.DMS.DescribeEventSubscriptions" "libZSservicesZSamazonka-dmsZSamazonka-dms" '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.DMS.DescribeEventSubscriptions

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 DMS event subscription to be described.

$sel:filters:DescribeEventSubscriptions', describeEventSubscriptions_filters - Filters applied to event subscriptions.

$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 called a 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 DMS event subscription to be described.

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 called a 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 #

Constructors

DescribeEventSubscriptionsResponse' 

Fields

Instances

Instances details
Eq DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Read DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Show DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Generic DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

Associated Types

type Rep DescribeEventSubscriptionsResponse :: Type -> Type #

NFData DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

type Rep DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEventSubscriptions

type Rep DescribeEventSubscriptionsResponse = D1 ('MetaData "DescribeEventSubscriptionsResponse" "Amazonka.DMS.DescribeEventSubscriptions" "libZSservicesZSamazonka-dmsZSamazonka-dms" '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 #

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