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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Sets the attributes for an endpoint 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.

Creating a Request

data SetEndpointAttributes Source #

Input for SetEndpointAttributes action.

See: newSetEndpointAttributes smart constructor.

Constructors

SetEndpointAttributes'

Fields

endpointArn :: Text
EndpointArn used for SetEndpointAttributes action.
attributes :: HashMap Text Text
A map of the endpoint attributes. Attributes in this map 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.

Instances

Instances details

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

newSetEndpointAttributes Source #

Arguments

:: Text	`$sel:endpointArn:SetEndpointAttributes'`
-> SetEndpointAttributes

Create a value of SetEndpointAttributes 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:SetEndpointAttributes', setEndpointAttributes_endpointArn - EndpointArn used for SetEndpointAttributes action.

$sel:attributes:SetEndpointAttributes', setEndpointAttributes_attributes - A map of the endpoint attributes. Attributes in this map 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.

Request Lenses

setEndpointAttributes_endpointArn :: Lens' SetEndpointAttributes Text Source #

EndpointArn used for SetEndpointAttributes action.

setEndpointAttributes_attributes :: Lens' SetEndpointAttributes (HashMap Text Text) Source #

A map of the endpoint attributes. Attributes in this map 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.

Destructuring the Response

data SetEndpointAttributesResponse Source #

See: newSetEndpointAttributesResponse smart constructor.

Constructors

SetEndpointAttributesResponse'

Instances

Instances details

Eq SetEndpointAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetEndpointAttributes Methods (==) :: SetEndpointAttributesResponse -> SetEndpointAttributesResponse -> Bool # (/=) :: SetEndpointAttributesResponse -> SetEndpointAttributesResponse -> Bool #
Read SetEndpointAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetEndpointAttributes Methods readsPrec :: Int -> ReadS SetEndpointAttributesResponse # readList :: ReadS [SetEndpointAttributesResponse] # readPrec :: ReadPrec SetEndpointAttributesResponse # readListPrec :: ReadPrec [SetEndpointAttributesResponse] #
Show SetEndpointAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetEndpointAttributes Methods showsPrec :: Int -> SetEndpointAttributesResponse -> ShowS # show :: SetEndpointAttributesResponse -> String # showList :: [SetEndpointAttributesResponse] -> ShowS #
Generic SetEndpointAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetEndpointAttributes Associated Types type Rep SetEndpointAttributesResponse :: Type -> Type # Methods from :: SetEndpointAttributesResponse -> Rep SetEndpointAttributesResponse x # to :: Rep SetEndpointAttributesResponse x -> SetEndpointAttributesResponse #
NFData SetEndpointAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetEndpointAttributes Methods rnf :: SetEndpointAttributesResponse -> () #
type Rep SetEndpointAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetEndpointAttributes type Rep SetEndpointAttributesResponse = D1 ('MetaData "SetEndpointAttributesResponse" "Amazonka.SNS.SetEndpointAttributes" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "SetEndpointAttributesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetEndpointAttributesResponse :: SetEndpointAttributesResponse Source #

Create a value of SetEndpointAttributesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.