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

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

Read ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

Show ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

Generic ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

Associated Types

type Rep ListEndpointsByPlatformApplication :: Type -> Type #

NFData ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

Hashable ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

AWSPager ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

AWSRequest ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

ToHeaders ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

ToPath ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

ToQuery ListEndpointsByPlatformApplication Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

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

newListEndpointsByPlatformApplication Source #

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

Read ListEndpointsByPlatformApplicationResponse Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

Show ListEndpointsByPlatformApplicationResponse Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

Generic ListEndpointsByPlatformApplicationResponse Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

NFData ListEndpointsByPlatformApplicationResponse Source # 
Instance details

Defined in Amazonka.SNS.ListEndpointsByPlatformApplication

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 #

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.