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

Description

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Synopsis

Creating a Request

data GetEndpointAttributes Source #

Input for GetEndpointAttributes action.

See: newGetEndpointAttributes smart constructor.

Constructors

GetEndpointAttributes' 

Fields

Instances

Instances details
Eq GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Read GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Show GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Generic GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Associated Types

type Rep GetEndpointAttributes :: Type -> Type #

NFData GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Methods

rnf :: GetEndpointAttributes -> () #

Hashable GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

AWSRequest GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Associated Types

type AWSResponse GetEndpointAttributes #

ToHeaders GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

ToPath GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

ToQuery GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

type Rep GetEndpointAttributes Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

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

Defined in Amazonka.SNS.GetEndpointAttributes

newGetEndpointAttributes Source #

Create a value of GetEndpointAttributes 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:endpointArn:GetEndpointAttributes', getEndpointAttributes_endpointArn - EndpointArn for GetEndpointAttributes input.

Request Lenses

getEndpointAttributes_endpointArn :: Lens' GetEndpointAttributes Text Source #

EndpointArn for GetEndpointAttributes input.

Destructuring the Response

data GetEndpointAttributesResponse Source #

Response from GetEndpointAttributes of the EndpointArn.

See: newGetEndpointAttributesResponse smart constructor.

Constructors

GetEndpointAttributesResponse' 

Fields

  • attributes :: Maybe (HashMap Text Text)

    Attributes include the following:

    • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
    • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
    • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

      The device token for the iOS platform is returned in lowercase.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetEndpointAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Read GetEndpointAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Show GetEndpointAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Generic GetEndpointAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

Associated Types

type Rep GetEndpointAttributesResponse :: Type -> Type #

NFData GetEndpointAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

type Rep GetEndpointAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.GetEndpointAttributes

type Rep GetEndpointAttributesResponse = D1 ('MetaData "GetEndpointAttributesResponse" "Amazonka.SNS.GetEndpointAttributes" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "GetEndpointAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetEndpointAttributesResponse Source #

Create a value of GetEndpointAttributesResponse 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:attributes:GetEndpointAttributesResponse', getEndpointAttributesResponse_attributes - Attributes include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

    The device token for the iOS platform is returned in lowercase.

$sel:httpStatus:GetEndpointAttributesResponse', getEndpointAttributesResponse_httpStatus - The response's http status code.

Response Lenses

getEndpointAttributesResponse_attributes :: Lens' GetEndpointAttributesResponse (Maybe (HashMap Text Text)) Source #

Attributes include the following:

  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

    The device token for the iOS platform is returned in lowercase.