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.SNS.ListEndpointsByPlatformApplication

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListEndpointsByPlatformApplication Source #

Input for ListEndpointsByPlatformApplication action.

See: newListEndpointsByPlatformApplication smart constructor.

Constructors

ListEndpointsByPlatformApplication'
Fields nextToken :: Maybe Text NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. platformApplicationArn :: Text PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

Instances

Instances details

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

newListEndpointsByPlatformApplication Source #

Arguments

:: Text	`$sel:platformApplicationArn:ListEndpointsByPlatformApplication'`
-> ListEndpointsByPlatformApplication

Create a value of ListEndpointsByPlatformApplication 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:ListEndpointsByPlatformApplication', listEndpointsByPlatformApplication_nextToken - NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

$sel:platformApplicationArn:ListEndpointsByPlatformApplication', listEndpointsByPlatformApplication_platformApplicationArn - PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

Request Lenses

listEndpointsByPlatformApplication_nextToken :: Lens' ListEndpointsByPlatformApplication (Maybe Text) Source #

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

listEndpointsByPlatformApplication_platformApplicationArn :: Lens' ListEndpointsByPlatformApplication Text Source #

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

Destructuring the Response

data ListEndpointsByPlatformApplicationResponse Source #

Response for ListEndpointsByPlatformApplication action.

See: newListEndpointsByPlatformApplicationResponse smart constructor.

Constructors

ListEndpointsByPlatformApplicationResponse'
Fields nextToken :: Maybe Text NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results. endpoints :: Maybe [Endpoint] Endpoints returned for ListEndpointsByPlatformApplication action. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListEndpointsByPlatformApplicationResponse Source #
Instance details Defined in Amazonka.SNS.ListEndpointsByPlatformApplication Methods (==) :: ListEndpointsByPlatformApplicationResponse -> ListEndpointsByPlatformApplicationResponse -> Bool # (/=) :: ListEndpointsByPlatformApplicationResponse -> ListEndpointsByPlatformApplicationResponse -> Bool #
Read ListEndpointsByPlatformApplicationResponse Source #
Instance details Defined in Amazonka.SNS.ListEndpointsByPlatformApplication Methods readsPrec :: Int -> ReadS ListEndpointsByPlatformApplicationResponse # readList :: ReadS [ListEndpointsByPlatformApplicationResponse] # readPrec :: ReadPrec ListEndpointsByPlatformApplicationResponse # readListPrec :: ReadPrec [ListEndpointsByPlatformApplicationResponse] #
Show ListEndpointsByPlatformApplicationResponse Source #
Instance details Defined in Amazonka.SNS.ListEndpointsByPlatformApplication Methods showsPrec :: Int -> ListEndpointsByPlatformApplicationResponse -> ShowS # show :: ListEndpointsByPlatformApplicationResponse -> String # showList :: [ListEndpointsByPlatformApplicationResponse] -> ShowS #
Generic ListEndpointsByPlatformApplicationResponse Source #
Instance details Defined in Amazonka.SNS.ListEndpointsByPlatformApplication Associated Types type Rep ListEndpointsByPlatformApplicationResponse :: Type -> Type # Methods from :: ListEndpointsByPlatformApplicationResponse -> Rep ListEndpointsByPlatformApplicationResponse x # to :: Rep ListEndpointsByPlatformApplicationResponse x -> ListEndpointsByPlatformApplicationResponse #
NFData ListEndpointsByPlatformApplicationResponse Source #
Instance details Defined in Amazonka.SNS.ListEndpointsByPlatformApplication Methods rnf :: ListEndpointsByPlatformApplicationResponse -> () #
type Rep ListEndpointsByPlatformApplicationResponse Source #
Instance details Defined in Amazonka.SNS.ListEndpointsByPlatformApplication type Rep ListEndpointsByPlatformApplicationResponse = D1 ('MetaData "ListEndpointsByPlatformApplicationResponse" "Amazonka.SNS.ListEndpointsByPlatformApplication" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "ListEndpointsByPlatformApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Endpoint])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEndpointsByPlatformApplicationResponse Source #

Arguments

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

Create a value of ListEndpointsByPlatformApplicationResponse 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:ListEndpointsByPlatformApplication', listEndpointsByPlatformApplicationResponse_nextToken - NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

$sel:endpoints:ListEndpointsByPlatformApplicationResponse', listEndpointsByPlatformApplicationResponse_endpoints - Endpoints returned for ListEndpointsByPlatformApplication action.

$sel:httpStatus:ListEndpointsByPlatformApplicationResponse', listEndpointsByPlatformApplicationResponse_httpStatus - The response's http status code.

Response Lenses

listEndpointsByPlatformApplicationResponse_nextToken :: Lens' ListEndpointsByPlatformApplicationResponse (Maybe Text) Source #

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

listEndpointsByPlatformApplicationResponse_endpoints :: Lens' ListEndpointsByPlatformApplicationResponse (Maybe [Endpoint]) Source #

Endpoints returned for ListEndpointsByPlatformApplication action.

listEndpointsByPlatformApplicationResponse_httpStatus :: Lens' ListEndpointsByPlatformApplicationResponse Int Source #

The response's http status code.