amazonka-sns-1.4.5: Amazon Simple Notification Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SNS.Types

Contents

Description

 

Synopsis

Service Configuration

sns :: Service #

API version 2010-03-31 of the Amazon Simple Notification Service SDK configuration.

Errors

_EndpointDisabledException :: AsError a => Getting (First ServiceError) a ServiceError #

Exception error indicating endpoint disabled.

_AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that the user has been denied access to the requested resource.

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that a request parameter does not comply with the associated constraints.

_SubscriptionLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that the customer already owns the maximum allowed number of subscriptions.

_PlatformApplicationDisabledException :: AsError a => Getting (First ServiceError) a ServiceError #

Exception error indicating platform application disabled.

_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates an internal service error.

_ThrottledException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that a request parameter does not comply with the associated constraints.

_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that the requested resource does not exist.

_TopicLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that the customer already owns the maximum allowed number of topics.

Endpoint

data Endpoint #

Endpoint for mobile app and device.

See: endpoint smart constructor.

Instances

Eq Endpoint # 
Data Endpoint # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Endpoint -> c Endpoint #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Endpoint #

toConstr :: Endpoint -> Constr #

dataTypeOf :: Endpoint -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Endpoint) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Endpoint) #

gmapT :: (forall b. Data b => b -> b) -> Endpoint -> Endpoint #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Endpoint -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Endpoint -> r #

gmapQ :: (forall d. Data d => d -> u) -> Endpoint -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Endpoint -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Endpoint -> m Endpoint #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Endpoint -> m Endpoint #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Endpoint -> m Endpoint #

Read Endpoint # 
Show Endpoint # 
Generic Endpoint # 

Associated Types

type Rep Endpoint :: * -> * #

Methods

from :: Endpoint -> Rep Endpoint x #

to :: Rep Endpoint x -> Endpoint #

Hashable Endpoint # 

Methods

hashWithSalt :: Int -> Endpoint -> Int #

hash :: Endpoint -> Int #

NFData Endpoint # 

Methods

rnf :: Endpoint -> () #

FromXML Endpoint # 
type Rep Endpoint # 
type Rep Endpoint = D1 (MetaData "Endpoint" "Network.AWS.SNS.Types.Product" "amazonka-sns-1.4.5-5x1MjGFUMvV6p7MfMkg43e" False) (C1 (MetaCons "Endpoint'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_eAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_eEndpointARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

endpoint :: Endpoint #

Creates a value of Endpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eAttributes :: Lens' Endpoint (HashMap Text Text) #

Attributes for endpoint.

eEndpointARN :: Lens' Endpoint (Maybe Text) #

EndpointArn for mobile app and device.

MessageAttributeValue

data MessageAttributeValue #

The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish .

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes .

See: messageAttributeValue smart constructor.

Instances

Eq MessageAttributeValue # 
Data MessageAttributeValue # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MessageAttributeValue -> c MessageAttributeValue #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MessageAttributeValue #

toConstr :: MessageAttributeValue -> Constr #

dataTypeOf :: MessageAttributeValue -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MessageAttributeValue) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MessageAttributeValue) #

gmapT :: (forall b. Data b => b -> b) -> MessageAttributeValue -> MessageAttributeValue #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MessageAttributeValue -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MessageAttributeValue -> r #

gmapQ :: (forall d. Data d => d -> u) -> MessageAttributeValue -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MessageAttributeValue -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MessageAttributeValue -> m MessageAttributeValue #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageAttributeValue -> m MessageAttributeValue #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageAttributeValue -> m MessageAttributeValue #

Read MessageAttributeValue # 
Show MessageAttributeValue # 
Generic MessageAttributeValue # 
Hashable MessageAttributeValue # 
NFData MessageAttributeValue # 

Methods

rnf :: MessageAttributeValue -> () #

ToQuery MessageAttributeValue # 
type Rep MessageAttributeValue # 
type Rep MessageAttributeValue = D1 (MetaData "MessageAttributeValue" "Network.AWS.SNS.Types.Product" "amazonka-sns-1.4.5-5x1MjGFUMvV6p7MfMkg43e" False) (C1 (MetaCons "MessageAttributeValue'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_mavBinaryValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Base64))) ((:*:) (S1 (MetaSel (Just Symbol "_mavStringValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mavDataType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

messageAttributeValue #

Creates a value of MessageAttributeValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • mavBinaryValue - Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • mavStringValue - Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters .
  • mavDataType - Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types .

mavBinaryValue :: Lens' MessageAttributeValue (Maybe ByteString) #

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

mavStringValue :: Lens' MessageAttributeValue (Maybe Text) #

Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters .

mavDataType :: Lens' MessageAttributeValue Text #

Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types .

PlatformApplication

data PlatformApplication #

Platform application object.

See: platformApplication smart constructor.

Instances

Eq PlatformApplication # 
Data PlatformApplication # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PlatformApplication -> c PlatformApplication #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PlatformApplication #

toConstr :: PlatformApplication -> Constr #

dataTypeOf :: PlatformApplication -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PlatformApplication) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PlatformApplication) #

gmapT :: (forall b. Data b => b -> b) -> PlatformApplication -> PlatformApplication #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PlatformApplication -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PlatformApplication -> r #

gmapQ :: (forall d. Data d => d -> u) -> PlatformApplication -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PlatformApplication -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PlatformApplication -> m PlatformApplication #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PlatformApplication -> m PlatformApplication #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PlatformApplication -> m PlatformApplication #

Read PlatformApplication # 
Show PlatformApplication # 
Generic PlatformApplication # 
Hashable PlatformApplication # 
NFData PlatformApplication # 

Methods

rnf :: PlatformApplication -> () #

FromXML PlatformApplication # 
type Rep PlatformApplication # 
type Rep PlatformApplication = D1 (MetaData "PlatformApplication" "Network.AWS.SNS.Types.Product" "amazonka-sns-1.4.5-5x1MjGFUMvV6p7MfMkg43e" False) (C1 (MetaCons "PlatformApplication'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_paPlatformApplicationARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_paAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))))

platformApplication :: PlatformApplication #

Creates a value of PlatformApplication with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

paPlatformApplicationARN :: Lens' PlatformApplication (Maybe Text) #

PlatformApplicationArn for platform application object.

paAttributes :: Lens' PlatformApplication (HashMap Text Text) #

Attributes for platform application object.

Subscription

data Subscription #

A wrapper type for the attributes of an Amazon SNS subscription.

See: subscription smart constructor.

Instances

Eq Subscription # 
Data Subscription # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Subscription -> c Subscription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Subscription #

toConstr :: Subscription -> Constr #

dataTypeOf :: Subscription -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Subscription) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Subscription) #

gmapT :: (forall b. Data b => b -> b) -> Subscription -> Subscription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Subscription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Subscription -> r #

gmapQ :: (forall d. Data d => d -> u) -> Subscription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Subscription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Subscription -> m Subscription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Subscription -> m Subscription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Subscription -> m Subscription #

Read Subscription # 
Show Subscription # 
Generic Subscription # 

Associated Types

type Rep Subscription :: * -> * #

Hashable Subscription # 
NFData Subscription # 

Methods

rnf :: Subscription -> () #

FromXML Subscription # 
type Rep Subscription # 
type Rep Subscription = D1 (MetaData "Subscription" "Network.AWS.SNS.Types.Product" "amazonka-sns-1.4.5-5x1MjGFUMvV6p7MfMkg43e" False) (C1 (MetaCons "Subscription'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sEndpoint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sSubscriptionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

subscription :: Subscription #

Creates a value of Subscription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sProtocol :: Lens' Subscription (Maybe Text) #

The subscription's protocol.

sOwner :: Lens' Subscription (Maybe Text) #

The subscription's owner.

sTopicARN :: Lens' Subscription (Maybe Text) #

The ARN of the subscription's topic.

sEndpoint :: Lens' Subscription (Maybe Text) #

The subscription's endpoint (format depends on the protocol).

sSubscriptionARN :: Lens' Subscription (Maybe Text) #

The subscription's ARN.

Topic

data Topic #

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes .

See: topic smart constructor.

Instances

Eq Topic # 

Methods

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

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

Data Topic # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Topic -> c Topic #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Topic #

toConstr :: Topic -> Constr #

dataTypeOf :: Topic -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Topic) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Topic) #

gmapT :: (forall b. Data b => b -> b) -> Topic -> Topic #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Topic -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Topic -> r #

gmapQ :: (forall d. Data d => d -> u) -> Topic -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Topic -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Topic -> m Topic #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Topic -> m Topic #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Topic -> m Topic #

Read Topic # 
Show Topic # 

Methods

showsPrec :: Int -> Topic -> ShowS #

show :: Topic -> String #

showList :: [Topic] -> ShowS #

Generic Topic # 

Associated Types

type Rep Topic :: * -> * #

Methods

from :: Topic -> Rep Topic x #

to :: Rep Topic x -> Topic #

Hashable Topic # 

Methods

hashWithSalt :: Int -> Topic -> Int #

hash :: Topic -> Int #

NFData Topic # 

Methods

rnf :: Topic -> () #

FromXML Topic # 

Methods

parseXML :: [Node] -> Either String Topic #

type Rep Topic # 
type Rep Topic = D1 (MetaData "Topic" "Network.AWS.SNS.Types.Product" "amazonka-sns-1.4.5-5x1MjGFUMvV6p7MfMkg43e" True) (C1 (MetaCons "Topic'" PrefixI True) (S1 (MetaSel (Just Symbol "_tTopicARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))

topic :: Topic #

Creates a value of Topic with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tTopicARN :: Lens' Topic (Maybe Text) #

The topic's ARN.