Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- ListPhoneNumbersOptedOut
- DeleteEndpoint
- RemovePermission
- DeleteTopic
- SetSMSAttributes
- ListTopics (Paginated)
- CreatePlatformEndpoint
- SetPlatformApplicationAttributes
- ListSubscriptionsByTopic (Paginated)
- GetTopicAttributes
- OptInPhoneNumber
- CreatePlatformApplication
- GetPlatformApplicationAttributes
- ListEndpointsByPlatformApplication (Paginated)
- SetTopicAttributes
- DeletePlatformApplication
- GetSMSAttributes
- ListPlatformApplications (Paginated)
- AddPermission
- GetEndpointAttributes
- ListSubscriptions (Paginated)
- GetSubscriptionAttributes
- CreateTopic
- CheckIfPhoneNumberIsOptedOut
- Subscribe
- Unsubscribe
- SetEndpointAttributes
- SetSubscriptionAttributes
- ConfirmSubscription
- Publish
- Types
Amazon Simple Notification Service
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns . For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide .
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services .
Synopsis
- sns :: Service
- _EndpointDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _SubscriptionLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _PlatformApplicationDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottledException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TopicLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.SNS.ListPhoneNumbersOptedOut
- module Network.AWS.SNS.DeleteEndpoint
- module Network.AWS.SNS.RemovePermission
- module Network.AWS.SNS.DeleteTopic
- module Network.AWS.SNS.SetSMSAttributes
- module Network.AWS.SNS.ListTopics
- module Network.AWS.SNS.CreatePlatformEndpoint
- module Network.AWS.SNS.SetPlatformApplicationAttributes
- module Network.AWS.SNS.ListSubscriptionsByTopic
- module Network.AWS.SNS.GetTopicAttributes
- module Network.AWS.SNS.OptInPhoneNumber
- module Network.AWS.SNS.CreatePlatformApplication
- module Network.AWS.SNS.GetPlatformApplicationAttributes
- module Network.AWS.SNS.ListEndpointsByPlatformApplication
- module Network.AWS.SNS.SetTopicAttributes
- module Network.AWS.SNS.DeletePlatformApplication
- module Network.AWS.SNS.GetSMSAttributes
- module Network.AWS.SNS.ListPlatformApplications
- module Network.AWS.SNS.AddPermission
- module Network.AWS.SNS.GetEndpointAttributes
- module Network.AWS.SNS.ListSubscriptions
- module Network.AWS.SNS.GetSubscriptionAttributes
- module Network.AWS.SNS.CreateTopic
- module Network.AWS.SNS.CheckIfPhoneNumberIsOptedOut
- module Network.AWS.SNS.Subscribe
- module Network.AWS.SNS.Unsubscribe
- module Network.AWS.SNS.SetEndpointAttributes
- module Network.AWS.SNS.SetSubscriptionAttributes
- module Network.AWS.SNS.ConfirmSubscription
- module Network.AWS.SNS.Publish
- data Endpoint
- endpoint :: Endpoint
- eAttributes :: Lens' Endpoint (HashMap Text Text)
- eEndpointARN :: Lens' Endpoint (Maybe Text)
- data MessageAttributeValue
- messageAttributeValue :: Text -> MessageAttributeValue
- mavBinaryValue :: Lens' MessageAttributeValue (Maybe ByteString)
- mavStringValue :: Lens' MessageAttributeValue (Maybe Text)
- mavDataType :: Lens' MessageAttributeValue Text
- data PlatformApplication
- platformApplication :: PlatformApplication
- paPlatformApplicationARN :: Lens' PlatformApplication (Maybe Text)
- paAttributes :: Lens' PlatformApplication (HashMap Text Text)
- data Subscription
- subscription :: Subscription
- sProtocol :: Lens' Subscription (Maybe Text)
- sOwner :: Lens' Subscription (Maybe Text)
- sTopicARN :: Lens' Subscription (Maybe Text)
- sEndpoint :: Lens' Subscription (Maybe Text)
- sSubscriptionARN :: Lens' Subscription (Maybe Text)
- data Topic
- topic :: Topic
- tTopicARN :: Lens' Topic (Maybe Text)
Service Configuration
API version 2010-03-31
of the Amazon Simple Notification Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SNS
.
EndpointDisabledException
_EndpointDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception error indicating endpoint disabled.
AuthorizationErrorException
_AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the user has been denied access to the requested resource.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a request parameter does not comply with the associated constraints.
SubscriptionLimitExceededException
_SubscriptionLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the customer already owns the maximum allowed number of subscriptions.
PlatformApplicationDisabledException
_PlatformApplicationDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception error indicating platform application disabled.
InternalErrorException
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates an internal service error.
ThrottledException
_ThrottledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a request parameter does not comply with the associated constraints.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the requested resource does not exist.
TopicLimitExceededException
_TopicLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the customer already owns the maximum allowed number of topics.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListPhoneNumbersOptedOut
DeleteEndpoint
RemovePermission
DeleteTopic
module Network.AWS.SNS.DeleteTopic
SetSMSAttributes
ListTopics (Paginated)
module Network.AWS.SNS.ListTopics
CreatePlatformEndpoint
SetPlatformApplicationAttributes
ListSubscriptionsByTopic (Paginated)
GetTopicAttributes
OptInPhoneNumber
CreatePlatformApplication
GetPlatformApplicationAttributes
ListEndpointsByPlatformApplication (Paginated)
SetTopicAttributes
DeletePlatformApplication
GetSMSAttributes
ListPlatformApplications (Paginated)
AddPermission
GetEndpointAttributes
ListSubscriptions (Paginated)
GetSubscriptionAttributes
CreateTopic
module Network.AWS.SNS.CreateTopic
CheckIfPhoneNumberIsOptedOut
Subscribe
module Network.AWS.SNS.Subscribe
Unsubscribe
module Network.AWS.SNS.Unsubscribe
SetEndpointAttributes
SetSubscriptionAttributes
ConfirmSubscription
Publish
module Network.AWS.SNS.Publish
Types
Endpoint
Endpoint for mobile app and device.
See: endpoint
smart constructor.
Instances
Eq Endpoint Source # | |
Data Endpoint Source # | |
Defined in Network.AWS.SNS.Types.Product 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 Source # | |
Show Endpoint Source # | |
Generic Endpoint Source # | |
Hashable Endpoint Source # | |
Defined in Network.AWS.SNS.Types.Product | |
FromXML Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Network.AWS.SNS.Types.Product | |
type Rep Endpoint Source # | |
Defined in Network.AWS.SNS.Types.Product type Rep Endpoint = D1 (MetaData "Endpoint" "Network.AWS.SNS.Types.Product" "amazonka-sns-1.6.1-7GBYpIO1P7AJWNWtL33amk" False) (C1 (MetaCons "Endpoint'" PrefixI True) (S1 (MetaSel (Just "_eAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_eEndpointARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
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
- Attributes for endpoint.eEndpointARN
- EndpointArn for mobile app and device.
MessageAttributeValue
data MessageAttributeValue Source #
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
messageAttributeValue Source #
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: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
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) Source #
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) Source #
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 Source #
Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types .
PlatformApplication
data PlatformApplication Source #
Platform application object.
See: platformApplication
smart constructor.
Instances
platformApplication :: PlatformApplication Source #
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
- PlatformApplicationArn for platform application object.paAttributes
- Attributes for platform application object.
paPlatformApplicationARN :: Lens' PlatformApplication (Maybe Text) Source #
PlatformApplicationArn for platform application object.
paAttributes :: Lens' PlatformApplication (HashMap Text Text) Source #
Attributes for platform application object.
Subscription
data Subscription Source #
A wrapper type for the attributes of an Amazon SNS subscription.
See: subscription
smart constructor.
Instances
subscription :: Subscription Source #
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
- The subscription's protocol.sOwner
- The subscription's owner.sTopicARN
- The ARN of the subscription's topic.sEndpoint
- The subscription's endpoint (format depends on the protocol).sSubscriptionARN
- The subscription's ARN.
sEndpoint :: Lens' Subscription (Maybe Text) Source #
The subscription's endpoint (format depends on the protocol).
sSubscriptionARN :: Lens' Subscription (Maybe Text) Source #
The subscription's ARN.
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 Source # | |
Data Topic Source # | |
Defined in Network.AWS.SNS.Types.Product 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 # 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 Source # | |
Show Topic Source # | |
Generic Topic Source # | |
Hashable Topic Source # | |
Defined in Network.AWS.SNS.Types.Product | |
FromXML Topic Source # | |
NFData Topic Source # | |
Defined in Network.AWS.SNS.Types.Product | |
type Rep Topic Source # | |
Defined in Network.AWS.SNS.Types.Product |