libZSservicesZSamazonka-snsZSamazonka-sns
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.SNS.ListSubscriptionsByTopic

Description

Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.

This action is throttled at 30 transactions per second (TPS).

This operation returns paginated results.

Synopsis

Creating a Request

data ListSubscriptionsByTopic Source #

Input for ListSubscriptionsByTopic action.

See: newListSubscriptionsByTopic smart constructor.

Constructors

ListSubscriptionsByTopic' 

Fields

  • nextToken :: Maybe Text

    Token returned by the previous ListSubscriptionsByTopic request.

  • topicArn :: Text

    The ARN of the topic for which you wish to find subscriptions.

Instances

Instances details
Eq ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

(==) :: ListSubscriptionsByTopic -> ListSubscriptionsByTopic -> Bool #

(/=) :: ListSubscriptionsByTopic -> ListSubscriptionsByTopic -> Bool #

Read ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

readsPrec :: Int -> ReadS ListSubscriptionsByTopic #

readList :: ReadS [ListSubscriptionsByTopic] #

readPrec :: ReadPrec ListSubscriptionsByTopic #

readListPrec :: ReadPrec [ListSubscriptionsByTopic] #

Show ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

showsPrec :: Int -> ListSubscriptionsByTopic -> ShowS #

show :: ListSubscriptionsByTopic -> String #

showList :: [ListSubscriptionsByTopic] -> ShowS #

Generic ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Associated Types

type Rep ListSubscriptionsByTopic :: Type -> Type #

Methods

from :: ListSubscriptionsByTopic -> Rep ListSubscriptionsByTopic x #

to :: Rep ListSubscriptionsByTopic x -> ListSubscriptionsByTopic #

NFData ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

rnf :: ListSubscriptionsByTopic -> () #

Hashable ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

hashWithSalt :: Int -> ListSubscriptionsByTopic -> Int #

hash :: ListSubscriptionsByTopic -> Int #

AWSPager ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

page :: ListSubscriptionsByTopic -> AWSResponse ListSubscriptionsByTopic -> Maybe ListSubscriptionsByTopic #

AWSRequest ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Associated Types

type AWSResponse ListSubscriptionsByTopic #

Methods

request :: ListSubscriptionsByTopic -> Request ListSubscriptionsByTopic #

response :: MonadResource m => Logger -> Service -> Proxy ListSubscriptionsByTopic -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSubscriptionsByTopic))) #

ToHeaders ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

toHeaders :: ListSubscriptionsByTopic -> [Header] #

ToPath ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

toPath :: ListSubscriptionsByTopic -> ByteString #

ToQuery ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

toQuery :: ListSubscriptionsByTopic -> QueryString #

type Rep ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

type Rep ListSubscriptionsByTopic = D1 ('MetaData "ListSubscriptionsByTopic" "Amazonka.SNS.ListSubscriptionsByTopic" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "ListSubscriptionsByTopic'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse ListSubscriptionsByTopic Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

type AWSResponse ListSubscriptionsByTopic = ListSubscriptionsByTopicResponse

newListSubscriptionsByTopic Source #

Arguments

:: Text

$sel:topicArn:ListSubscriptionsByTopic'

-> ListSubscriptionsByTopic 

Create a value of ListSubscriptionsByTopic 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:nextToken:ListSubscriptionsByTopic', listSubscriptionsByTopic_nextToken - Token returned by the previous ListSubscriptionsByTopic request.

$sel:topicArn:ListSubscriptionsByTopic', listSubscriptionsByTopic_topicArn - The ARN of the topic for which you wish to find subscriptions.

Request Lenses

listSubscriptionsByTopic_nextToken :: Lens' ListSubscriptionsByTopic (Maybe Text) Source #

Token returned by the previous ListSubscriptionsByTopic request.

listSubscriptionsByTopic_topicArn :: Lens' ListSubscriptionsByTopic Text Source #

The ARN of the topic for which you wish to find subscriptions.

Destructuring the Response

data ListSubscriptionsByTopicResponse Source #

Response for ListSubscriptionsByTopic action.

See: newListSubscriptionsByTopicResponse smart constructor.

Constructors

ListSubscriptionsByTopicResponse' 

Fields

Instances

Instances details
Eq ListSubscriptionsByTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

(==) :: ListSubscriptionsByTopicResponse -> ListSubscriptionsByTopicResponse -> Bool #

(/=) :: ListSubscriptionsByTopicResponse -> ListSubscriptionsByTopicResponse -> Bool #

Read ListSubscriptionsByTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

readsPrec :: Int -> ReadS ListSubscriptionsByTopicResponse #

readList :: ReadS [ListSubscriptionsByTopicResponse] #

readPrec :: ReadPrec ListSubscriptionsByTopicResponse #

readListPrec :: ReadPrec [ListSubscriptionsByTopicResponse] #

Show ListSubscriptionsByTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

showsPrec :: Int -> ListSubscriptionsByTopicResponse -> ShowS #

show :: ListSubscriptionsByTopicResponse -> String #

showList :: [ListSubscriptionsByTopicResponse] -> ShowS #

Generic ListSubscriptionsByTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Associated Types

type Rep ListSubscriptionsByTopicResponse :: Type -> Type #

Methods

from :: ListSubscriptionsByTopicResponse -> Rep ListSubscriptionsByTopicResponse x #

to :: Rep ListSubscriptionsByTopicResponse x -> ListSubscriptionsByTopicResponse #

NFData ListSubscriptionsByTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

Methods

rnf :: ListSubscriptionsByTopicResponse -> () #

type Rep ListSubscriptionsByTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.ListSubscriptionsByTopic

type Rep ListSubscriptionsByTopicResponse = D1 ('MetaData "ListSubscriptionsByTopicResponse" "Amazonka.SNS.ListSubscriptionsByTopic" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "ListSubscriptionsByTopicResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "subscriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Subscription])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSubscriptionsByTopicResponse Source #

Arguments

:: Int

$sel:httpStatus:ListSubscriptionsByTopicResponse'

-> ListSubscriptionsByTopicResponse 

Create a value of ListSubscriptionsByTopicResponse 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:nextToken:ListSubscriptionsByTopic', listSubscriptionsByTopicResponse_nextToken - Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

$sel:subscriptions:ListSubscriptionsByTopicResponse', listSubscriptionsByTopicResponse_subscriptions - A list of subscriptions.

$sel:httpStatus:ListSubscriptionsByTopicResponse', listSubscriptionsByTopicResponse_httpStatus - The response's http status code.

Response Lenses

listSubscriptionsByTopicResponse_nextToken :: Lens' ListSubscriptionsByTopicResponse (Maybe Text) Source #

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

listSubscriptionsByTopicResponse_subscriptions :: Lens' ListSubscriptionsByTopicResponse (Maybe [Subscription]) Source #

A list of subscriptions.

listSubscriptionsByTopicResponse_httpStatus :: Lens' ListSubscriptionsByTopicResponse Int Source #

The response's http status code.