Amazonka.RDS.DescribeEventSubscriptions

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.

Creating a Request

data DescribeEventSubscriptions

See: newDescribeEventSubscriptions smart constructor.

Constructors

DescribeEventSubscriptions'

Fields

• filters :: Maybe [Filter]

  This parameter isn't currently supported.

• marker :: Maybe Text

  An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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 you can retrieve the remaining results.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• subscriptionName :: Maybe Text

  The name of the RDS event notification subscription you want to describe.

Instances

ToHeaders DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

toHeaders :: DescribeEventSubscriptions -> [Header]

ToPath DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

toPath :: DescribeEventSubscriptions -> ByteString

ToQuery DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

toQuery :: DescribeEventSubscriptions -> QueryString

AWSPager DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

page :: DescribeEventSubscriptions -> AWSResponse DescribeEventSubscriptions -> Maybe DescribeEventSubscriptions

AWSRequest DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Associated Types

type AWSResponse DescribeEventSubscriptions

Methods

request :: (Service -> Service) -> DescribeEventSubscriptions -> Request DescribeEventSubscriptions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEventSubscriptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEventSubscriptions)))

Generic DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Associated Types

type Rep DescribeEventSubscriptions :: Type -> Type

Methods

from :: DescribeEventSubscriptions -> Rep DescribeEventSubscriptions x

to :: Rep DescribeEventSubscriptions x -> DescribeEventSubscriptions

Read DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

readsPrec :: Int -> ReadS DescribeEventSubscriptions

readList :: ReadS [DescribeEventSubscriptions]

readPrec :: ReadPrec DescribeEventSubscriptions

readListPrec :: ReadPrec [DescribeEventSubscriptions]

Show DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

showsPrec :: Int -> DescribeEventSubscriptions -> ShowS

show :: DescribeEventSubscriptions -> String

showList :: [DescribeEventSubscriptions] -> ShowS

NFData DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

rnf :: DescribeEventSubscriptions -> ()

Eq DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

(==) :: DescribeEventSubscriptions -> DescribeEventSubscriptions -> Bool

(/=) :: DescribeEventSubscriptions -> DescribeEventSubscriptions -> Bool

Hashable DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

hashWithSalt :: Int -> DescribeEventSubscriptions -> Int

hash :: DescribeEventSubscriptions -> Int

type AWSResponse DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

type AWSResponse DescribeEventSubscriptions = DescribeEventSubscriptionsResponse

type Rep DescribeEventSubscriptions

Defined in Amazonka.RDS.DescribeEventSubscriptions

type Rep DescribeEventSubscriptions = D1 ('MetaData "DescribeEventSubscriptions" "Amazonka.RDS.DescribeEventSubscriptions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeEventSubscriptions'" 'PrefixI 'True) ((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)) :*: S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeEventSubscriptions :: DescribeEventSubscriptions

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:filters:DescribeEventSubscriptions', describeEventSubscriptions_filters - This parameter isn't currently supported.

DescribeEventSubscriptions, describeEventSubscriptions_marker - An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

$sel:subscriptionName:DescribeEventSubscriptions', describeEventSubscriptions_subscriptionName - The name of the RDS event notification subscription you want to describe.

Request Lenses

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

This parameter isn't currently supported.

describeEventSubscriptions_marker :: Lens' DescribeEventSubscriptions (Maybe Text)

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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)

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEventSubscriptions_subscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text)

The name of the RDS event notification subscription you want to describe.

Destructuring the Response

data DescribeEventSubscriptionsResponse

Data returned by the DescribeEventSubscriptions action.

See: newDescribeEventSubscriptionsResponse smart constructor.

Constructors

DescribeEventSubscriptionsResponse'

Fields

• eventSubscriptionsList :: Maybe [EventSubscription]

  A list of EventSubscriptions data types.

• marker :: Maybe Text

  An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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

Generic DescribeEventSubscriptionsResponse

Defined in Amazonka.RDS.DescribeEventSubscriptions

Associated Types

type Rep DescribeEventSubscriptionsResponse :: Type -> Type

Methods

from :: DescribeEventSubscriptionsResponse -> Rep DescribeEventSubscriptionsResponse x

to :: Rep DescribeEventSubscriptionsResponse x -> DescribeEventSubscriptionsResponse

Read DescribeEventSubscriptionsResponse

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

readsPrec :: Int -> ReadS DescribeEventSubscriptionsResponse

readList :: ReadS [DescribeEventSubscriptionsResponse]

readPrec :: ReadPrec DescribeEventSubscriptionsResponse

readListPrec :: ReadPrec [DescribeEventSubscriptionsResponse]

Show DescribeEventSubscriptionsResponse

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

showsPrec :: Int -> DescribeEventSubscriptionsResponse -> ShowS

show :: DescribeEventSubscriptionsResponse -> String

showList :: [DescribeEventSubscriptionsResponse] -> ShowS

NFData DescribeEventSubscriptionsResponse

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

rnf :: DescribeEventSubscriptionsResponse -> ()

Eq DescribeEventSubscriptionsResponse

Defined in Amazonka.RDS.DescribeEventSubscriptions

Methods

(==) :: DescribeEventSubscriptionsResponse -> DescribeEventSubscriptionsResponse -> Bool

(/=) :: DescribeEventSubscriptionsResponse -> DescribeEventSubscriptionsResponse -> Bool

type Rep DescribeEventSubscriptionsResponse

Defined in Amazonka.RDS.DescribeEventSubscriptions

type Rep DescribeEventSubscriptionsResponse = D1 ('MetaData "DescribeEventSubscriptionsResponse" "Amazonka.RDS.DescribeEventSubscriptions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" '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

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 EventSubscriptions data types.

DescribeEventSubscriptions, describeEventSubscriptionsResponse_marker - An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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])

A list of EventSubscriptions data types.

describeEventSubscriptionsResponse_marker :: Lens' DescribeEventSubscriptionsResponse (Maybe Text)

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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

The response's http status code.