| 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
Contents
- Service Configuration
- Errors
- KMSInvalidStateException
- EndpointDisabledException
- ValidationException
- AuthorizationErrorException
- KMSThrottlingException
- InvalidParameterException
- SubscriptionLimitExceededException
- PlatformApplicationDisabledException
- KMSOptInRequired
- InternalErrorException
- ThrottledException
- KMSNotFoundException
- InvalidParameterValueException
- NotFoundException
- StaleTagException
- KMSDisabledException
- TagPolicyException
- InvalidSecurityException
- TopicLimitExceededException
- ConcurrentAccessException
- OptedOutException
- TagLimitExceededException
- UserErrorException
- VerificationException
- ResourceNotFoundException
- FilterPolicyLimitExceededException
- KMSAccessDeniedException
- Waiters
- Operations
- ListPhoneNumbersOptedOut (Paginated)
- DeleteEndpoint
- ListTagsForResource
- RemovePermission
- DeleteTopic
- SetSMSAttributes
- ListTopics (Paginated)
- VerifySMSSandboxPhoneNumber
- CreatePlatformEndpoint
- SetPlatformApplicationAttributes
- ListSubscriptionsByTopic (Paginated)
- GetTopicAttributes
- CreateSMSSandboxPhoneNumber
- OptInPhoneNumber
- DeleteSMSSandboxPhoneNumber
- ListSMSSandboxPhoneNumbers (Paginated)
- CreatePlatformApplication
- GetPlatformApplicationAttributes
- ListEndpointsByPlatformApplication (Paginated)
- SetTopicAttributes
- DeletePlatformApplication
- GetSMSAttributes
- ListPlatformApplications (Paginated)
- AddPermission
- GetEndpointAttributes
- ListSubscriptions (Paginated)
- GetSubscriptionAttributes
- CreateTopic
- CheckIfPhoneNumberIsOptedOut
- TagResource
- Subscribe
- ListOriginationNumbers (Paginated)
- UntagResource
- Unsubscribe
- GetSMSSandboxAccountStatus
- SetEndpointAttributes
- SetSubscriptionAttributes
- ConfirmSubscription
- Publish
- Types
Description
Derived from API version 2010-03-31 of the AWS service descriptions, licensed under Apache 2.0.
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 the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in 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
- defaultService :: Service
- _KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _EndpointDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSThrottlingException :: 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
- _KMSOptInRequired :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottledException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _StaleTagException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSecurityException :: AsError a => Getting (First ServiceError) a ServiceError
- _TopicLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentAccessException :: AsError a => Getting (First ServiceError) a ServiceError
- _OptedOutException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _VerificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _FilterPolicyLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListPhoneNumbersOptedOut = ListPhoneNumbersOptedOut' (Maybe Text)
- newListPhoneNumbersOptedOut :: ListPhoneNumbersOptedOut
- data ListPhoneNumbersOptedOutResponse = ListPhoneNumbersOptedOutResponse' (Maybe [Text]) (Maybe Text) Int
- newListPhoneNumbersOptedOutResponse :: Int -> ListPhoneNumbersOptedOutResponse
- data DeleteEndpoint = DeleteEndpoint' Text
- newDeleteEndpoint :: Text -> DeleteEndpoint
- data DeleteEndpointResponse = DeleteEndpointResponse' {
- newDeleteEndpointResponse :: DeleteEndpointResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data RemovePermission = RemovePermission' Text Text
- newRemovePermission :: Text -> Text -> RemovePermission
- data RemovePermissionResponse = RemovePermissionResponse' {
- newRemovePermissionResponse :: RemovePermissionResponse
- data DeleteTopic = DeleteTopic' Text
- newDeleteTopic :: Text -> DeleteTopic
- data DeleteTopicResponse = DeleteTopicResponse' {
- newDeleteTopicResponse :: DeleteTopicResponse
- data SetSMSAttributes = SetSMSAttributes' (HashMap Text Text)
- newSetSMSAttributes :: SetSMSAttributes
- data SetSMSAttributesResponse = SetSMSAttributesResponse' Int
- newSetSMSAttributesResponse :: Int -> SetSMSAttributesResponse
- data ListTopics = ListTopics' (Maybe Text)
- newListTopics :: ListTopics
- data ListTopicsResponse = ListTopicsResponse' (Maybe [Topic]) (Maybe Text) Int
- newListTopicsResponse :: Int -> ListTopicsResponse
- data VerifySMSSandboxPhoneNumber = VerifySMSSandboxPhoneNumber' Text Text
- newVerifySMSSandboxPhoneNumber :: Text -> Text -> VerifySMSSandboxPhoneNumber
- data VerifySMSSandboxPhoneNumberResponse = VerifySMSSandboxPhoneNumberResponse' Int
- newVerifySMSSandboxPhoneNumberResponse :: Int -> VerifySMSSandboxPhoneNumberResponse
- data CreatePlatformEndpoint = CreatePlatformEndpoint' (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreatePlatformEndpoint :: Text -> Text -> CreatePlatformEndpoint
- data CreatePlatformEndpointResponse = CreatePlatformEndpointResponse' (Maybe Text) Int
- newCreatePlatformEndpointResponse :: Int -> CreatePlatformEndpointResponse
- data SetPlatformApplicationAttributes = SetPlatformApplicationAttributes' Text (HashMap Text Text)
- newSetPlatformApplicationAttributes :: Text -> SetPlatformApplicationAttributes
- data SetPlatformApplicationAttributesResponse = SetPlatformApplicationAttributesResponse' {
- newSetPlatformApplicationAttributesResponse :: SetPlatformApplicationAttributesResponse
- data ListSubscriptionsByTopic = ListSubscriptionsByTopic' (Maybe Text) Text
- newListSubscriptionsByTopic :: Text -> ListSubscriptionsByTopic
- data ListSubscriptionsByTopicResponse = ListSubscriptionsByTopicResponse' (Maybe Text) (Maybe [Subscription]) Int
- newListSubscriptionsByTopicResponse :: Int -> ListSubscriptionsByTopicResponse
- data GetTopicAttributes = GetTopicAttributes' Text
- newGetTopicAttributes :: Text -> GetTopicAttributes
- data GetTopicAttributesResponse = GetTopicAttributesResponse' (Maybe (HashMap Text Text)) Int
- newGetTopicAttributesResponse :: Int -> GetTopicAttributesResponse
- data CreateSMSSandboxPhoneNumber = CreateSMSSandboxPhoneNumber' (Maybe LanguageCodeString) Text
- newCreateSMSSandboxPhoneNumber :: Text -> CreateSMSSandboxPhoneNumber
- data CreateSMSSandboxPhoneNumberResponse = CreateSMSSandboxPhoneNumberResponse' Int
- newCreateSMSSandboxPhoneNumberResponse :: Int -> CreateSMSSandboxPhoneNumberResponse
- data OptInPhoneNumber = OptInPhoneNumber' Text
- newOptInPhoneNumber :: Text -> OptInPhoneNumber
- data OptInPhoneNumberResponse = OptInPhoneNumberResponse' Int
- newOptInPhoneNumberResponse :: Int -> OptInPhoneNumberResponse
- data DeleteSMSSandboxPhoneNumber = DeleteSMSSandboxPhoneNumber' Text
- newDeleteSMSSandboxPhoneNumber :: Text -> DeleteSMSSandboxPhoneNumber
- data DeleteSMSSandboxPhoneNumberResponse = DeleteSMSSandboxPhoneNumberResponse' Int
- newDeleteSMSSandboxPhoneNumberResponse :: Int -> DeleteSMSSandboxPhoneNumberResponse
- data ListSMSSandboxPhoneNumbers = ListSMSSandboxPhoneNumbers' (Maybe Text) (Maybe Natural)
- newListSMSSandboxPhoneNumbers :: ListSMSSandboxPhoneNumbers
- data ListSMSSandboxPhoneNumbersResponse = ListSMSSandboxPhoneNumbersResponse' (Maybe Text) Int [SMSSandboxPhoneNumber]
- newListSMSSandboxPhoneNumbersResponse :: Int -> ListSMSSandboxPhoneNumbersResponse
- data CreatePlatformApplication = CreatePlatformApplication' Text Text (HashMap Text Text)
- newCreatePlatformApplication :: Text -> Text -> CreatePlatformApplication
- data CreatePlatformApplicationResponse = CreatePlatformApplicationResponse' (Maybe Text) Int
- newCreatePlatformApplicationResponse :: Int -> CreatePlatformApplicationResponse
- data GetPlatformApplicationAttributes = GetPlatformApplicationAttributes' Text
- newGetPlatformApplicationAttributes :: Text -> GetPlatformApplicationAttributes
- data GetPlatformApplicationAttributesResponse = GetPlatformApplicationAttributesResponse' (Maybe (HashMap Text Text)) Int
- newGetPlatformApplicationAttributesResponse :: Int -> GetPlatformApplicationAttributesResponse
- data ListEndpointsByPlatformApplication = ListEndpointsByPlatformApplication' (Maybe Text) Text
- newListEndpointsByPlatformApplication :: Text -> ListEndpointsByPlatformApplication
- data ListEndpointsByPlatformApplicationResponse = ListEndpointsByPlatformApplicationResponse' (Maybe Text) (Maybe [Endpoint]) Int
- newListEndpointsByPlatformApplicationResponse :: Int -> ListEndpointsByPlatformApplicationResponse
- data SetTopicAttributes = SetTopicAttributes' (Maybe Text) Text Text
- newSetTopicAttributes :: Text -> Text -> SetTopicAttributes
- data SetTopicAttributesResponse = SetTopicAttributesResponse' {
- newSetTopicAttributesResponse :: SetTopicAttributesResponse
- data DeletePlatformApplication = DeletePlatformApplication' Text
- newDeletePlatformApplication :: Text -> DeletePlatformApplication
- data DeletePlatformApplicationResponse = DeletePlatformApplicationResponse' {
- newDeletePlatformApplicationResponse :: DeletePlatformApplicationResponse
- data GetSMSAttributes = GetSMSAttributes' (Maybe [Text])
- newGetSMSAttributes :: GetSMSAttributes
- data GetSMSAttributesResponse = GetSMSAttributesResponse' (Maybe (HashMap Text Text)) Int
- newGetSMSAttributesResponse :: Int -> GetSMSAttributesResponse
- data ListPlatformApplications = ListPlatformApplications' (Maybe Text)
- newListPlatformApplications :: ListPlatformApplications
- data ListPlatformApplicationsResponse = ListPlatformApplicationsResponse' (Maybe [PlatformApplication]) (Maybe Text) Int
- newListPlatformApplicationsResponse :: Int -> ListPlatformApplicationsResponse
- data AddPermission = AddPermission' Text Text [Text] [Text]
- newAddPermission :: Text -> Text -> AddPermission
- data AddPermissionResponse = AddPermissionResponse' {
- newAddPermissionResponse :: AddPermissionResponse
- data GetEndpointAttributes = GetEndpointAttributes' Text
- newGetEndpointAttributes :: Text -> GetEndpointAttributes
- data GetEndpointAttributesResponse = GetEndpointAttributesResponse' (Maybe (HashMap Text Text)) Int
- newGetEndpointAttributesResponse :: Int -> GetEndpointAttributesResponse
- data ListSubscriptions = ListSubscriptions' (Maybe Text)
- newListSubscriptions :: ListSubscriptions
- data ListSubscriptionsResponse = ListSubscriptionsResponse' (Maybe Text) (Maybe [Subscription]) Int
- newListSubscriptionsResponse :: Int -> ListSubscriptionsResponse
- data GetSubscriptionAttributes = GetSubscriptionAttributes' Text
- newGetSubscriptionAttributes :: Text -> GetSubscriptionAttributes
- data GetSubscriptionAttributesResponse = GetSubscriptionAttributesResponse' (Maybe (HashMap Text Text)) Int
- newGetSubscriptionAttributesResponse :: Int -> GetSubscriptionAttributesResponse
- data CreateTopic = CreateTopic' (Maybe (HashMap Text Text)) (Maybe [Tag]) Text
- newCreateTopic :: Text -> CreateTopic
- data CreateTopicResponse = CreateTopicResponse' (Maybe Text) Int
- newCreateTopicResponse :: Int -> CreateTopicResponse
- data CheckIfPhoneNumberIsOptedOut = CheckIfPhoneNumberIsOptedOut' Text
- newCheckIfPhoneNumberIsOptedOut :: Text -> CheckIfPhoneNumberIsOptedOut
- data CheckIfPhoneNumberIsOptedOutResponse = CheckIfPhoneNumberIsOptedOutResponse' (Maybe Bool) Int
- newCheckIfPhoneNumberIsOptedOutResponse :: Int -> CheckIfPhoneNumberIsOptedOutResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data Subscribe = Subscribe' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) Text Text
- newSubscribe :: Text -> Text -> Subscribe
- data SubscribeResponse = SubscribeResponse' (Maybe Text) Int
- newSubscribeResponse :: Int -> SubscribeResponse
- data ListOriginationNumbers = ListOriginationNumbers' (Maybe Text) (Maybe Natural)
- newListOriginationNumbers :: ListOriginationNumbers
- data ListOriginationNumbersResponse = ListOriginationNumbersResponse' (Maybe Text) (Maybe [PhoneNumberInformation]) Int
- newListOriginationNumbersResponse :: Int -> ListOriginationNumbersResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data Unsubscribe = Unsubscribe' Text
- newUnsubscribe :: Text -> Unsubscribe
- data UnsubscribeResponse = UnsubscribeResponse' {
- newUnsubscribeResponse :: UnsubscribeResponse
- data GetSMSSandboxAccountStatus = GetSMSSandboxAccountStatus' {
- newGetSMSSandboxAccountStatus :: GetSMSSandboxAccountStatus
- data GetSMSSandboxAccountStatusResponse = GetSMSSandboxAccountStatusResponse' Int Bool
- newGetSMSSandboxAccountStatusResponse :: Int -> Bool -> GetSMSSandboxAccountStatusResponse
- data SetEndpointAttributes = SetEndpointAttributes' Text (HashMap Text Text)
- newSetEndpointAttributes :: Text -> SetEndpointAttributes
- data SetEndpointAttributesResponse = SetEndpointAttributesResponse' {
- newSetEndpointAttributesResponse :: SetEndpointAttributesResponse
- data SetSubscriptionAttributes = SetSubscriptionAttributes' (Maybe Text) Text Text
- newSetSubscriptionAttributes :: Text -> Text -> SetSubscriptionAttributes
- data SetSubscriptionAttributesResponse = SetSubscriptionAttributesResponse' {
- newSetSubscriptionAttributesResponse :: SetSubscriptionAttributesResponse
- data ConfirmSubscription = ConfirmSubscription' (Maybe Text) Text Text
- newConfirmSubscription :: Text -> Text -> ConfirmSubscription
- data ConfirmSubscriptionResponse = ConfirmSubscriptionResponse' (Maybe Text) Int
- newConfirmSubscriptionResponse :: Int -> ConfirmSubscriptionResponse
- data Publish = Publish' (Maybe Text) (Maybe Text) (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newPublish :: Text -> Publish
- data PublishResponse = PublishResponse' (Maybe Text) (Maybe Text) Int
- newPublishResponse :: Int -> PublishResponse
- newtype LanguageCodeString where
- LanguageCodeString' { }
- pattern LanguageCodeString_De_DE :: LanguageCodeString
- pattern LanguageCodeString_En_GB :: LanguageCodeString
- pattern LanguageCodeString_En_US :: LanguageCodeString
- pattern LanguageCodeString_Es_419 :: LanguageCodeString
- pattern LanguageCodeString_Es_ES :: LanguageCodeString
- pattern LanguageCodeString_Fr_CA :: LanguageCodeString
- pattern LanguageCodeString_Fr_FR :: LanguageCodeString
- pattern LanguageCodeString_It_IT :: LanguageCodeString
- pattern LanguageCodeString_Ja_JP :: LanguageCodeString
- pattern LanguageCodeString_Kr_KR :: LanguageCodeString
- pattern LanguageCodeString_Pt_BR :: LanguageCodeString
- pattern LanguageCodeString_Zh_CN :: LanguageCodeString
- pattern LanguageCodeString_Zh_TW :: LanguageCodeString
- newtype NumberCapability where
- NumberCapability' { }
- pattern NumberCapability_MMS :: NumberCapability
- pattern NumberCapability_SMS :: NumberCapability
- pattern NumberCapability_VOICE :: NumberCapability
- newtype RouteType where
- RouteType' { }
- pattern RouteType_Premium :: RouteType
- pattern RouteType_Promotional :: RouteType
- pattern RouteType_Transactional :: RouteType
- newtype SMSSandboxPhoneNumberVerificationStatus where
- data Endpoint = Endpoint' (Maybe (HashMap Text Text)) (Maybe Text)
- newEndpoint :: Endpoint
- data MessageAttributeValue = MessageAttributeValue' (Maybe Base64) (Maybe Text) Text
- newMessageAttributeValue :: Text -> MessageAttributeValue
- data PhoneNumberInformation = PhoneNumberInformation' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [NumberCapability]) (Maybe RouteType)
- newPhoneNumberInformation :: PhoneNumberInformation
- data PlatformApplication = PlatformApplication' (Maybe Text) (Maybe (HashMap Text Text))
- newPlatformApplication :: PlatformApplication
- data SMSSandboxPhoneNumber = SMSSandboxPhoneNumber' (Maybe SMSSandboxPhoneNumberVerificationStatus) (Maybe Text)
- newSMSSandboxPhoneNumber :: SMSSandboxPhoneNumber
- data Subscription = Subscription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSubscription :: Subscription
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Topic = Topic' (Maybe Text)
- newTopic :: Topic
Service Configuration
defaultService :: Service Source #
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.
KMSInvalidStateException
_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.
EndpointDisabledException
_EndpointDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception error indicating endpoint disabled.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a parameter in the request is invalid.
AuthorizationErrorException
_AuthorizationErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the user has been denied access to the requested resource.
KMSThrottlingException
_KMSThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.
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.
KMSOptInRequired
_KMSOptInRequired :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Amazon Web Services access key ID needs a subscription for the service.
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.
KMSNotFoundException
_KMSNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified entity or resource can't be found.
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.
StaleTagException
_StaleTagException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
KMSDisabledException
_KMSDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified customer master key (CMK) isn't enabled.
TagPolicyException
_TagPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
InvalidSecurityException
_InvalidSecurityException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
TopicLimitExceededException
_TopicLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the customer already owns the maximum allowed number of topics.
ConcurrentAccessException
_ConcurrentAccessException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
OptedOutException
_OptedOutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the specified phone number opted out of receiving SMS messages from your account. You can't send SMS messages to phone numbers that opt out.
TagLimitExceededException
_TagLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Can't add more than 50 tags to a topic.
UserErrorException
_UserErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a request parameter does not comply with the associated constraints.
VerificationException
_VerificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the one-time password (OTP) used for verification is invalid.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Can’t perform the action on the specified resource. Make sure that the resource exists.
FilterPolicyLimitExceededException
_FilterPolicyLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the number of filter polices in your account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the Amazon Web Services Support Center.
KMSAccessDeniedException
_KMSAccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The ciphertext references a key that doesn't exist or that you don't have access to.
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 (Paginated)
data ListPhoneNumbersOptedOut Source #
The input for the ListPhoneNumbersOptedOut action.
See: newListPhoneNumbersOptedOut smart constructor.
Constructors
| ListPhoneNumbersOptedOut' (Maybe Text) |
Instances
newListPhoneNumbersOptedOut :: ListPhoneNumbersOptedOut Source #
Create a value of ListPhoneNumbersOptedOut 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:ListPhoneNumbersOptedOut', listPhoneNumbersOptedOut_nextToken - A NextToken string is used when you call the
ListPhoneNumbersOptedOut action to retrieve additional records that
are available after the first page of results.
data ListPhoneNumbersOptedOutResponse Source #
The response from the ListPhoneNumbersOptedOut action.
See: newListPhoneNumbersOptedOutResponse smart constructor.
Instances
newListPhoneNumbersOptedOutResponse Source #
Create a value of ListPhoneNumbersOptedOutResponse 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:phoneNumbers:ListPhoneNumbersOptedOutResponse', listPhoneNumbersOptedOutResponse_phoneNumbers - A list of phone numbers that are opted out of receiving SMS messages.
The list is paginated, and each page can contain up to 100 phone
numbers.
$sel:nextToken:ListPhoneNumbersOptedOut', listPhoneNumbersOptedOutResponse_nextToken - A NextToken string is returned when you call the
ListPhoneNumbersOptedOut action if additional records are available
after the first page of results.
$sel:httpStatus:ListPhoneNumbersOptedOutResponse', listPhoneNumbersOptedOutResponse_httpStatus - The response's http status code.
DeleteEndpoint
data DeleteEndpoint Source #
Input for DeleteEndpoint action.
See: newDeleteEndpoint smart constructor.
Constructors
| DeleteEndpoint' Text |
Instances
Arguments
| :: Text | |
| -> DeleteEndpoint |
Create a value of DeleteEndpoint 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:DeleteEndpoint', deleteEndpoint_endpointArn - EndpointArn of endpoint to delete.
data DeleteEndpointResponse Source #
See: newDeleteEndpointResponse smart constructor.
Constructors
| DeleteEndpointResponse' | |
Instances
| Eq DeleteEndpointResponse Source # | |
Defined in Amazonka.SNS.DeleteEndpoint Methods (==) :: DeleteEndpointResponse -> DeleteEndpointResponse -> Bool # (/=) :: DeleteEndpointResponse -> DeleteEndpointResponse -> Bool # | |
| Read DeleteEndpointResponse Source # | |
Defined in Amazonka.SNS.DeleteEndpoint | |
| Show DeleteEndpointResponse Source # | |
Defined in Amazonka.SNS.DeleteEndpoint Methods showsPrec :: Int -> DeleteEndpointResponse -> ShowS # show :: DeleteEndpointResponse -> String # showList :: [DeleteEndpointResponse] -> ShowS # | |
| Generic DeleteEndpointResponse Source # | |
Defined in Amazonka.SNS.DeleteEndpoint Associated Types type Rep DeleteEndpointResponse :: Type -> Type # Methods from :: DeleteEndpointResponse -> Rep DeleteEndpointResponse x # to :: Rep DeleteEndpointResponse x -> DeleteEndpointResponse # | |
| NFData DeleteEndpointResponse Source # | |
Defined in Amazonka.SNS.DeleteEndpoint Methods rnf :: DeleteEndpointResponse -> () # | |
| type Rep DeleteEndpointResponse Source # | |
newDeleteEndpointResponse :: DeleteEndpointResponse Source #
Create a value of DeleteEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the topic for which to list tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags associated with the specified topic.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
RemovePermission
data RemovePermission Source #
Input for RemovePermission action.
See: newRemovePermission smart constructor.
Constructors
| RemovePermission' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RemovePermission |
Create a value of RemovePermission 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:topicArn:RemovePermission', removePermission_topicArn - The ARN of the topic whose access control policy you wish to modify.
$sel:label:RemovePermission', removePermission_label - The unique label of the statement you want to remove.
data RemovePermissionResponse Source #
See: newRemovePermissionResponse smart constructor.
Constructors
| RemovePermissionResponse' | |
Instances
newRemovePermissionResponse :: RemovePermissionResponse Source #
Create a value of RemovePermissionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteTopic
data DeleteTopic Source #
See: newDeleteTopic smart constructor.
Constructors
| DeleteTopic' Text |
Instances
Arguments
| :: Text | |
| -> DeleteTopic |
Create a value of DeleteTopic 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:topicArn:DeleteTopic', deleteTopic_topicArn - The ARN of the topic you want to delete.
data DeleteTopicResponse Source #
See: newDeleteTopicResponse smart constructor.
Constructors
| DeleteTopicResponse' | |
Instances
| Eq DeleteTopicResponse Source # | |
Defined in Amazonka.SNS.DeleteTopic Methods (==) :: DeleteTopicResponse -> DeleteTopicResponse -> Bool # (/=) :: DeleteTopicResponse -> DeleteTopicResponse -> Bool # | |
| Read DeleteTopicResponse Source # | |
Defined in Amazonka.SNS.DeleteTopic Methods readsPrec :: Int -> ReadS DeleteTopicResponse # readList :: ReadS [DeleteTopicResponse] # | |
| Show DeleteTopicResponse Source # | |
Defined in Amazonka.SNS.DeleteTopic Methods showsPrec :: Int -> DeleteTopicResponse -> ShowS # show :: DeleteTopicResponse -> String # showList :: [DeleteTopicResponse] -> ShowS # | |
| Generic DeleteTopicResponse Source # | |
Defined in Amazonka.SNS.DeleteTopic Associated Types type Rep DeleteTopicResponse :: Type -> Type # Methods from :: DeleteTopicResponse -> Rep DeleteTopicResponse x # to :: Rep DeleteTopicResponse x -> DeleteTopicResponse # | |
| NFData DeleteTopicResponse Source # | |
Defined in Amazonka.SNS.DeleteTopic Methods rnf :: DeleteTopicResponse -> () # | |
| type Rep DeleteTopicResponse Source # | |
newDeleteTopicResponse :: DeleteTopicResponse Source #
Create a value of DeleteTopicResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetSMSAttributes
data SetSMSAttributes Source #
The input for the SetSMSAttributes action.
See: newSetSMSAttributes smart constructor.
Constructors
| SetSMSAttributes' (HashMap Text Text) |
Instances
newSetSMSAttributes :: SetSMSAttributes Source #
Create a value of SetSMSAttributes 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:SetSMSAttributes', setSMSAttributes_attributes - The default settings for sending SMS messages from your account. You can
set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to
spend each month to send SMS messages. When Amazon SNS determines that
sending an SMS message would incur a cost that exceeds this limit, it
stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS
to write logs about SMS deliveries in CloudWatch Logs. For each SMS
message that you send, Amazon SNS writes a log that includes the message
price, the success or failure status, the reason for failure (if the
message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS
deliveries for which Amazon SNS will write logs in CloudWatch Logs. The
value can be an integer from 0 - 100. For example, to write logs only
for failed deliveries, set this value to 0. To write logs for 10% of
your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is
displayed as the sender on the receiving device. Support for sender IDs
varies by country. The sender ID can be 1 - 11 alphanumeric characters,
and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by
default. You can assign the following values:
Promotional– (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.Transactional– Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive
daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will
deliver a usage report as a CSV file to the bucket. The report includes
the following information for each SMS message that was successfully
delivered by your account:
- Time that the message was published (in UTC)
- Message ID
- Destination phone number
- Message type
- Delivery status
- Message price (in USD)
- Part number (a message is split into multiple parts if it is too long for a single message)
- Total number of parts
To receive the report, the bucket must have a policy that allows the
Amazon SNS service principal to perform the s3:PutObject and
s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.
data SetSMSAttributesResponse Source #
The response for the SetSMSAttributes action.
See: newSetSMSAttributesResponse smart constructor.
Constructors
| SetSMSAttributesResponse' Int |
Instances
newSetSMSAttributesResponse Source #
Create a value of SetSMSAttributesResponse 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:httpStatus:SetSMSAttributesResponse', setSMSAttributesResponse_httpStatus - The response's http status code.
ListTopics (Paginated)
data ListTopics Source #
See: newListTopics smart constructor.
Constructors
| ListTopics' (Maybe Text) |
Instances
newListTopics :: ListTopics Source #
Create a value of ListTopics 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:ListTopics', listTopics_nextToken - Token returned by the previous ListTopics request.
data ListTopicsResponse Source #
Response for ListTopics action.
See: newListTopicsResponse smart constructor.
Instances
newListTopicsResponse Source #
Arguments
| :: Int | |
| -> ListTopicsResponse |
Create a value of ListTopicsResponse 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:topics:ListTopicsResponse', listTopicsResponse_topics - A list of topic ARNs.
$sel:nextToken:ListTopics', listTopicsResponse_nextToken - Token to pass along to the next ListTopics request. This element is
returned if there are additional topics to retrieve.
$sel:httpStatus:ListTopicsResponse', listTopicsResponse_httpStatus - The response's http status code.
VerifySMSSandboxPhoneNumber
data VerifySMSSandboxPhoneNumber Source #
See: newVerifySMSSandboxPhoneNumber smart constructor.
Constructors
| VerifySMSSandboxPhoneNumber' Text Text |
Instances
newVerifySMSSandboxPhoneNumber Source #
Arguments
| :: Text | |
| -> Text | |
| -> VerifySMSSandboxPhoneNumber |
Create a value of VerifySMSSandboxPhoneNumber 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:phoneNumber:VerifySMSSandboxPhoneNumber', verifySMSSandboxPhoneNumber_phoneNumber - The destination phone number to verify.
$sel:oneTimePassword:VerifySMSSandboxPhoneNumber', verifySMSSandboxPhoneNumber_oneTimePassword - The OTP sent to the destination number from the
CreateSMSSandBoxPhoneNumber call.
data VerifySMSSandboxPhoneNumberResponse Source #
The destination phone number's verification status.
See: newVerifySMSSandboxPhoneNumberResponse smart constructor.
Constructors
| VerifySMSSandboxPhoneNumberResponse' Int |
Instances
newVerifySMSSandboxPhoneNumberResponse Source #
Arguments
| :: Int | |
| -> VerifySMSSandboxPhoneNumberResponse |
Create a value of VerifySMSSandboxPhoneNumberResponse 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:httpStatus:VerifySMSSandboxPhoneNumberResponse', verifySMSSandboxPhoneNumberResponse_httpStatus - The response's http status code.
CreatePlatformEndpoint
data CreatePlatformEndpoint Source #
Input for CreatePlatformEndpoint action.
See: newCreatePlatformEndpoint smart constructor.
Instances
newCreatePlatformEndpoint Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreatePlatformEndpoint |
Create a value of CreatePlatformEndpoint 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:customUserData:CreatePlatformEndpoint', createPlatformEndpoint_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.
$sel:attributes:CreatePlatformEndpoint', createPlatformEndpoint_attributes - For a list of attributes, see
SetEndpointAttributes.
$sel:platformApplicationArn:CreatePlatformEndpoint', createPlatformEndpoint_platformApplicationArn - PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.
$sel:token:CreatePlatformEndpoint', createPlatformEndpoint_token - Unique identifier created by the notification service for an app on a
device. The specific name for Token will vary, depending on which
notification service is being used. For example, when using APNS as the
notification service, you need the device token. Alternatively, when
using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent
is called the registration ID.
data CreatePlatformEndpointResponse Source #
Response from CreateEndpoint action.
See: newCreatePlatformEndpointResponse smart constructor.
Constructors
| CreatePlatformEndpointResponse' (Maybe Text) Int |
Instances
newCreatePlatformEndpointResponse Source #
Create a value of CreatePlatformEndpointResponse 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:CreatePlatformEndpointResponse', createPlatformEndpointResponse_endpointArn - EndpointArn returned from CreateEndpoint action.
$sel:httpStatus:CreatePlatformEndpointResponse', createPlatformEndpointResponse_httpStatus - The response's http status code.
SetPlatformApplicationAttributes
data SetPlatformApplicationAttributes Source #
Input for SetPlatformApplicationAttributes action.
See: newSetPlatformApplicationAttributes smart constructor.
Constructors
| SetPlatformApplicationAttributes' Text (HashMap Text Text) |
Instances
newSetPlatformApplicationAttributes Source #
Arguments
| :: Text |
|
| -> SetPlatformApplicationAttributes |
Create a value of SetPlatformApplicationAttributes 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:platformApplicationArn:SetPlatformApplicationAttributes', setPlatformApplicationAttributes_platformApplicationArn - PlatformApplicationArn for SetPlatformApplicationAttributes action.
$sel:attributes:SetPlatformApplicationAttributes', setPlatformApplicationAttributes_attributes - A map of the platform application attributes. Attributes in this map
include the following:
PlatformCredential– The credential received from the notification service. ForAPNSandAPNS_SANDBOX,PlatformCredentialisprivate key. ForGCM(Firebase Cloud Messaging),PlatformCredentialisAPI key. ForADM,PlatformCredentialisclient secret.PlatformPrincipal– The principal received from the notification service. ForAPNSandAPNS_SANDBOX,PlatformPrincipalisSSL certificate. ForGCM(Firebase Cloud Messaging), there is noPlatformPrincipal. ForADM,PlatformPrincipalisclient id.EventEndpointCreated– Topic ARN to whichEndpointCreatedevent notifications are sent.EventEndpointDeleted– Topic ARN to whichEndpointDeletedevent notifications are sent.EventEndpointUpdated– Topic ARN to whichEndpointUpdateevent notifications are sent.EventDeliveryFailure– Topic ARN to whichDeliveryFailureevent notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.SuccessFeedbackRoleArn– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.FailureFeedbackRoleArn– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.SuccessFeedbackSampleRate– Sample rate percentage (0-100) of successfully delivered messages.
data SetPlatformApplicationAttributesResponse Source #
See: newSetPlatformApplicationAttributesResponse smart constructor.
Constructors
| SetPlatformApplicationAttributesResponse' | |
Instances
| Eq SetPlatformApplicationAttributesResponse Source # | |
| Read SetPlatformApplicationAttributesResponse Source # | |
| Show SetPlatformApplicationAttributesResponse Source # | |
| Generic SetPlatformApplicationAttributesResponse Source # | |
Defined in Amazonka.SNS.SetPlatformApplicationAttributes Associated Types type Rep SetPlatformApplicationAttributesResponse :: Type -> Type # | |
| NFData SetPlatformApplicationAttributesResponse Source # | |
Defined in Amazonka.SNS.SetPlatformApplicationAttributes Methods rnf :: SetPlatformApplicationAttributesResponse -> () # | |
| type Rep SetPlatformApplicationAttributesResponse Source # | |
Defined in Amazonka.SNS.SetPlatformApplicationAttributes type Rep SetPlatformApplicationAttributesResponse = D1 ('MetaData "SetPlatformApplicationAttributesResponse" "Amazonka.SNS.SetPlatformApplicationAttributes" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "SetPlatformApplicationAttributesResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newSetPlatformApplicationAttributesResponse :: SetPlatformApplicationAttributesResponse Source #
Create a value of SetPlatformApplicationAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListSubscriptionsByTopic (Paginated)
data ListSubscriptionsByTopic Source #
Input for ListSubscriptionsByTopic action.
See: newListSubscriptionsByTopic smart constructor.
Constructors
| ListSubscriptionsByTopic' (Maybe Text) Text |
Instances
newListSubscriptionsByTopic Source #
Create a value of ListSubscriptionsByTopic 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:ListSubscriptionsByTopic', listSubscriptionsByTopic_nextToken - Token returned by the previous ListSubscriptionsByTopic request.
$sel:topicArn:ListSubscriptionsByTopic', listSubscriptionsByTopic_topicArn - The ARN of the topic for which you wish to find subscriptions.
data ListSubscriptionsByTopicResponse Source #
Response for ListSubscriptionsByTopic action.
See: newListSubscriptionsByTopicResponse smart constructor.
Constructors
| ListSubscriptionsByTopicResponse' (Maybe Text) (Maybe [Subscription]) Int |
Instances
newListSubscriptionsByTopicResponse Source #
Create a value of ListSubscriptionsByTopicResponse 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:ListSubscriptionsByTopic', listSubscriptionsByTopicResponse_nextToken - Token to pass along to the next ListSubscriptionsByTopic request. This
element is returned if there are more subscriptions to retrieve.
$sel:subscriptions:ListSubscriptionsByTopicResponse', listSubscriptionsByTopicResponse_subscriptions - A list of subscriptions.
$sel:httpStatus:ListSubscriptionsByTopicResponse', listSubscriptionsByTopicResponse_httpStatus - The response's http status code.
GetTopicAttributes
data GetTopicAttributes Source #
Input for GetTopicAttributes action.
See: newGetTopicAttributes smart constructor.
Constructors
| GetTopicAttributes' Text |
Instances
newGetTopicAttributes Source #
Arguments
| :: Text | |
| -> GetTopicAttributes |
Create a value of GetTopicAttributes 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:topicArn:GetTopicAttributes', getTopicAttributes_topicArn - The ARN of the topic whose properties you want to get.
data GetTopicAttributesResponse Source #
Response for GetTopicAttributes action.
See: newGetTopicAttributesResponse smart constructor.
Instances
newGetTopicAttributesResponse Source #
Create a value of GetTopicAttributesResponse 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:GetTopicAttributesResponse', getTopicAttributesResponse_attributes - A map of the topic's attributes. Attributes in this map include the
following:
DeliveryPolicy– The JSON serialization of the topic's delivery policy.DisplayName– The human-readable name used in theFromfield for notifications toemailandemail-jsonendpoints.Owner– The account ID of the topic's owner.Policy– The JSON serialization of the topic's access control policy.SubscriptionsConfirmed– The number of confirmed subscriptions for the topic.SubscriptionsDeleted– The number of deleted subscriptions for the topic.SubscriptionsPending– The number of subscriptions pending confirmation for the topic.TopicArn– The topic's ARN.EffectiveDeliveryPolicy– The JSON serialization of the effective delivery policy, taking system defaults into account.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId- The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic– When this is set totrue, a FIFO topic is created.ContentBasedDeduplication– Enables content-based deduplication for FIFO topics.- By default,
ContentBasedDeduplicationis set tofalse. If you create a FIFO topic and this attribute isfalse, you must specify a value for theMessageDeduplicationIdparameter for the Publish action. When you set
ContentBasedDeduplicationtotrue, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationIdusing the body of the message (but not the attributes of the message).(Optional) To override the generated value, you can specify a value for the
MessageDeduplicationIdparameter for thePublishaction.
- By default,
$sel:httpStatus:GetTopicAttributesResponse', getTopicAttributesResponse_httpStatus - The response's http status code.
CreateSMSSandboxPhoneNumber
data CreateSMSSandboxPhoneNumber Source #
See: newCreateSMSSandboxPhoneNumber smart constructor.
Constructors
| CreateSMSSandboxPhoneNumber' (Maybe LanguageCodeString) Text |
Instances
newCreateSMSSandboxPhoneNumber Source #
Create a value of CreateSMSSandboxPhoneNumber 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:languageCode:CreateSMSSandboxPhoneNumber', createSMSSandboxPhoneNumber_languageCode - The language to use for sending the OTP. The default value is en-US.
$sel:phoneNumber:CreateSMSSandboxPhoneNumber', createSMSSandboxPhoneNumber_phoneNumber - The destination phone number to verify. On verification, Amazon SNS adds
this phone number to the list of verified phone numbers that you can
send SMS messages to.
data CreateSMSSandboxPhoneNumberResponse Source #
See: newCreateSMSSandboxPhoneNumberResponse smart constructor.
Constructors
| CreateSMSSandboxPhoneNumberResponse' Int |
Instances
newCreateSMSSandboxPhoneNumberResponse Source #
Arguments
| :: Int | |
| -> CreateSMSSandboxPhoneNumberResponse |
Create a value of CreateSMSSandboxPhoneNumberResponse 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:httpStatus:CreateSMSSandboxPhoneNumberResponse', createSMSSandboxPhoneNumberResponse_httpStatus - The response's http status code.
OptInPhoneNumber
data OptInPhoneNumber Source #
Input for the OptInPhoneNumber action.
See: newOptInPhoneNumber smart constructor.
Constructors
| OptInPhoneNumber' Text |
Instances
Arguments
| :: Text | |
| -> OptInPhoneNumber |
Create a value of OptInPhoneNumber 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:phoneNumber:OptInPhoneNumber', optInPhoneNumber_phoneNumber - The phone number to opt in. Use E.164 format.
data OptInPhoneNumberResponse Source #
The response for the OptInPhoneNumber action.
See: newOptInPhoneNumberResponse smart constructor.
Constructors
| OptInPhoneNumberResponse' Int |
Instances
newOptInPhoneNumberResponse Source #
Create a value of OptInPhoneNumberResponse 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:httpStatus:OptInPhoneNumberResponse', optInPhoneNumberResponse_httpStatus - The response's http status code.
DeleteSMSSandboxPhoneNumber
data DeleteSMSSandboxPhoneNumber Source #
See: newDeleteSMSSandboxPhoneNumber smart constructor.
Constructors
| DeleteSMSSandboxPhoneNumber' Text |
Instances
newDeleteSMSSandboxPhoneNumber Source #
Create a value of DeleteSMSSandboxPhoneNumber 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:phoneNumber:DeleteSMSSandboxPhoneNumber', deleteSMSSandboxPhoneNumber_phoneNumber - The destination phone number to delete.
data DeleteSMSSandboxPhoneNumberResponse Source #
See: newDeleteSMSSandboxPhoneNumberResponse smart constructor.
Constructors
| DeleteSMSSandboxPhoneNumberResponse' Int |
Instances
newDeleteSMSSandboxPhoneNumberResponse Source #
Arguments
| :: Int | |
| -> DeleteSMSSandboxPhoneNumberResponse |
Create a value of DeleteSMSSandboxPhoneNumberResponse 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:httpStatus:DeleteSMSSandboxPhoneNumberResponse', deleteSMSSandboxPhoneNumberResponse_httpStatus - The response's http status code.
ListSMSSandboxPhoneNumbers (Paginated)
data ListSMSSandboxPhoneNumbers Source #
See: newListSMSSandboxPhoneNumbers smart constructor.
Constructors
| ListSMSSandboxPhoneNumbers' (Maybe Text) (Maybe Natural) |
Instances
newListSMSSandboxPhoneNumbers :: ListSMSSandboxPhoneNumbers Source #
Create a value of ListSMSSandboxPhoneNumbers 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:ListSMSSandboxPhoneNumbers', listSMSSandboxPhoneNumbers_nextToken - Token that the previous ListSMSSandboxPhoneNumbersInput request
returns.
$sel:maxResults:ListSMSSandboxPhoneNumbers', listSMSSandboxPhoneNumbers_maxResults - The maximum number of phone numbers to return.
data ListSMSSandboxPhoneNumbersResponse Source #
See: newListSMSSandboxPhoneNumbersResponse smart constructor.
Constructors
| ListSMSSandboxPhoneNumbersResponse' (Maybe Text) Int [SMSSandboxPhoneNumber] |
Instances
newListSMSSandboxPhoneNumbersResponse Source #
Arguments
| :: Int | |
| -> ListSMSSandboxPhoneNumbersResponse |
Create a value of ListSMSSandboxPhoneNumbersResponse 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:ListSMSSandboxPhoneNumbers', listSMSSandboxPhoneNumbersResponse_nextToken - A NextToken string is returned when you call the
ListSMSSandboxPhoneNumbersInput operation if additional pages of
records are available.
$sel:httpStatus:ListSMSSandboxPhoneNumbersResponse', listSMSSandboxPhoneNumbersResponse_httpStatus - The response's http status code.
$sel:phoneNumbers:ListSMSSandboxPhoneNumbersResponse', listSMSSandboxPhoneNumbersResponse_phoneNumbers - A list of the calling account's pending and verified phone numbers.
CreatePlatformApplication
data CreatePlatformApplication Source #
Input for CreatePlatformApplication action.
See: newCreatePlatformApplication smart constructor.
Instances
newCreatePlatformApplication Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreatePlatformApplication |
Create a value of CreatePlatformApplication 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:name:CreatePlatformApplication', createPlatformApplication_name - Application names must be made up of only uppercase and lowercase ASCII
letters, numbers, underscores, hyphens, and periods, and must be between
1 and 256 characters long.
$sel:platform:CreatePlatformApplication', createPlatformApplication_platform - The following platforms are supported: ADM (Amazon Device Messaging),
APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase
Cloud Messaging).
$sel:attributes:CreatePlatformApplication', createPlatformApplication_attributes - For a list of attributes, see
SetPlatformApplicationAttributes.
data CreatePlatformApplicationResponse Source #
Response from CreatePlatformApplication action.
See: newCreatePlatformApplicationResponse smart constructor.
Constructors
| CreatePlatformApplicationResponse' (Maybe Text) Int |
Instances
newCreatePlatformApplicationResponse Source #
Arguments
| :: Int | |
| -> CreatePlatformApplicationResponse |
Create a value of CreatePlatformApplicationResponse 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:platformApplicationArn:CreatePlatformApplicationResponse', createPlatformApplicationResponse_platformApplicationArn - PlatformApplicationArn is returned.
$sel:httpStatus:CreatePlatformApplicationResponse', createPlatformApplicationResponse_httpStatus - The response's http status code.
GetPlatformApplicationAttributes
data GetPlatformApplicationAttributes Source #
Input for GetPlatformApplicationAttributes action.
See: newGetPlatformApplicationAttributes smart constructor.
Constructors
| GetPlatformApplicationAttributes' Text |
Instances
newGetPlatformApplicationAttributes Source #
Arguments
| :: Text |
|
| -> GetPlatformApplicationAttributes |
Create a value of GetPlatformApplicationAttributes 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:platformApplicationArn:GetPlatformApplicationAttributes', getPlatformApplicationAttributes_platformApplicationArn - PlatformApplicationArn for GetPlatformApplicationAttributesInput.
data GetPlatformApplicationAttributesResponse Source #
Response for GetPlatformApplicationAttributes action.
See: newGetPlatformApplicationAttributesResponse smart constructor.
Instances
newGetPlatformApplicationAttributesResponse Source #
Arguments
| :: Int | |
| -> GetPlatformApplicationAttributesResponse |
Create a value of GetPlatformApplicationAttributesResponse 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:GetPlatformApplicationAttributesResponse', getPlatformApplicationAttributesResponse_attributes - Attributes include the following:
EventEndpointCreated– Topic ARN to which EndpointCreated event notifications should be sent.EventEndpointDeleted– Topic ARN to which EndpointDeleted event notifications should be sent.EventEndpointUpdated– Topic ARN to which EndpointUpdate event notifications should be sent.EventDeliveryFailure– Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
$sel:httpStatus:GetPlatformApplicationAttributesResponse', getPlatformApplicationAttributesResponse_httpStatus - The response's http status code.
ListEndpointsByPlatformApplication (Paginated)
data ListEndpointsByPlatformApplication Source #
Input for ListEndpointsByPlatformApplication action.
See: newListEndpointsByPlatformApplication smart constructor.
Constructors
| ListEndpointsByPlatformApplication' (Maybe Text) Text |
Instances
newListEndpointsByPlatformApplication Source #
Arguments
| :: Text |
|
| -> ListEndpointsByPlatformApplication |
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.
data ListEndpointsByPlatformApplicationResponse Source #
Response for ListEndpointsByPlatformApplication action.
See: newListEndpointsByPlatformApplicationResponse smart constructor.
Instances
newListEndpointsByPlatformApplicationResponse Source #
Arguments
| :: Int | |
| -> ListEndpointsByPlatformApplicationResponse |
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.
SetTopicAttributes
data SetTopicAttributes Source #
Input for SetTopicAttributes action.
See: newSetTopicAttributes smart constructor.
Constructors
| SetTopicAttributes' (Maybe Text) Text Text |
Instances
newSetTopicAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> SetTopicAttributes |
Create a value of SetTopicAttributes 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:attributeValue:SetTopicAttributes', setTopicAttributes_attributeValue - The new value for the attribute.
$sel:topicArn:SetTopicAttributes', setTopicAttributes_topicArn - The ARN of the topic to modify.
$sel:attributeName:SetTopicAttributes', setTopicAttributes_attributeName - A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters that the SetTopicAttributes action uses:
DeliveryPolicy– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.DisplayName– The display name to use for a topic with SMS subscriptions.Policy– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication– Enables content-based deduplication for FIFO topics.- By default,
ContentBasedDeduplicationis set tofalse. If you create a FIFO topic and this attribute isfalse, you must specify a value for theMessageDeduplicationIdparameter for the Publish action. When you set
ContentBasedDeduplicationtotrue, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationIdusing the body of the message (but not the attributes of the message).(Optional) To override the generated value, you can specify a value for the
MessageDeduplicationIdparameter for thePublishaction.
- By default,
data SetTopicAttributesResponse Source #
See: newSetTopicAttributesResponse smart constructor.
Constructors
| SetTopicAttributesResponse' | |
Instances
newSetTopicAttributesResponse :: SetTopicAttributesResponse Source #
Create a value of SetTopicAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePlatformApplication
data DeletePlatformApplication Source #
Input for DeletePlatformApplication action.
See: newDeletePlatformApplication smart constructor.
Constructors
| DeletePlatformApplication' Text |
Instances
newDeletePlatformApplication Source #
Create a value of DeletePlatformApplication 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:platformApplicationArn:DeletePlatformApplication', deletePlatformApplication_platformApplicationArn - PlatformApplicationArn of platform application object to delete.
data DeletePlatformApplicationResponse Source #
See: newDeletePlatformApplicationResponse smart constructor.
Constructors
| DeletePlatformApplicationResponse' | |
Instances
| Eq DeletePlatformApplicationResponse Source # | |
| Read DeletePlatformApplicationResponse Source # | |
| Show DeletePlatformApplicationResponse Source # | |
Defined in Amazonka.SNS.DeletePlatformApplication Methods showsPrec :: Int -> DeletePlatformApplicationResponse -> ShowS # | |
| Generic DeletePlatformApplicationResponse Source # | |
Defined in Amazonka.SNS.DeletePlatformApplication Associated Types type Rep DeletePlatformApplicationResponse :: Type -> Type # | |
| NFData DeletePlatformApplicationResponse Source # | |
Defined in Amazonka.SNS.DeletePlatformApplication Methods rnf :: DeletePlatformApplicationResponse -> () # | |
| type Rep DeletePlatformApplicationResponse Source # | |
Defined in Amazonka.SNS.DeletePlatformApplication | |
newDeletePlatformApplicationResponse :: DeletePlatformApplicationResponse Source #
Create a value of DeletePlatformApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetSMSAttributes
data GetSMSAttributes Source #
The input for the GetSMSAttributes request.
See: newGetSMSAttributes smart constructor.
Constructors
| GetSMSAttributes' (Maybe [Text]) |
Instances
newGetSMSAttributes :: GetSMSAttributes Source #
Create a value of GetSMSAttributes 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:GetSMSAttributes', getSMSAttributes_attributes - A list of the individual attribute names, such as MonthlySpendLimit,
for which you want values.
For all attribute names, see SetSMSAttributes.
If you don't use this parameter, Amazon SNS returns all SMS attributes.
data GetSMSAttributesResponse Source #
The response from the GetSMSAttributes request.
See: newGetSMSAttributesResponse smart constructor.
Instances
newGetSMSAttributesResponse Source #
Create a value of GetSMSAttributesResponse 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:GetSMSAttributes', getSMSAttributesResponse_attributes - The SMS attribute names and their values.
$sel:httpStatus:GetSMSAttributesResponse', getSMSAttributesResponse_httpStatus - The response's http status code.
ListPlatformApplications (Paginated)
data ListPlatformApplications Source #
Input for ListPlatformApplications action.
See: newListPlatformApplications smart constructor.
Constructors
| ListPlatformApplications' (Maybe Text) |
Instances
newListPlatformApplications :: ListPlatformApplications Source #
Create a value of ListPlatformApplications 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:ListPlatformApplications', listPlatformApplications_nextToken - NextToken string is used when calling ListPlatformApplications action to
retrieve additional records that are available after the first page
results.
data ListPlatformApplicationsResponse Source #
Response for ListPlatformApplications action.
See: newListPlatformApplicationsResponse smart constructor.
Constructors
| ListPlatformApplicationsResponse' (Maybe [PlatformApplication]) (Maybe Text) Int |
Instances
newListPlatformApplicationsResponse Source #
Create a value of ListPlatformApplicationsResponse 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:platformApplications:ListPlatformApplicationsResponse', listPlatformApplicationsResponse_platformApplications - Platform applications returned when calling ListPlatformApplications
action.
$sel:nextToken:ListPlatformApplications', listPlatformApplicationsResponse_nextToken - NextToken string is returned when calling ListPlatformApplications
action if additional records are available after the first page results.
$sel:httpStatus:ListPlatformApplicationsResponse', listPlatformApplicationsResponse_httpStatus - The response's http status code.
AddPermission
data AddPermission Source #
See: newAddPermission smart constructor.
Constructors
| AddPermission' Text Text [Text] [Text] |
Instances
Create a value of AddPermission 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:topicArn:AddPermission', addPermission_topicArn - The ARN of the topic whose access control policy you wish to modify.
$sel:label:AddPermission', addPermission_label - A unique identifier for the new policy statement.
$sel:aWSAccountId:AddPermission', addPermission_aWSAccountId - The account IDs of the users (principals) who will be given access to
the specified actions. The users must have account, but do not need to
be signed up for this service.
$sel:actionName:AddPermission', addPermission_actionName - The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example Publish.
data AddPermissionResponse Source #
See: newAddPermissionResponse smart constructor.
Constructors
| AddPermissionResponse' | |
Instances
newAddPermissionResponse :: AddPermissionResponse Source #
Create a value of AddPermissionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetEndpointAttributes
data GetEndpointAttributes Source #
Input for GetEndpointAttributes action.
See: newGetEndpointAttributes smart constructor.
Constructors
| GetEndpointAttributes' Text |
Instances
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.
data GetEndpointAttributesResponse Source #
Response from GetEndpointAttributes of the EndpointArn.
See: newGetEndpointAttributesResponse smart constructor.
Instances
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.
ListSubscriptions (Paginated)
data ListSubscriptions Source #
Input for ListSubscriptions action.
See: newListSubscriptions smart constructor.
Constructors
| ListSubscriptions' (Maybe Text) |
Instances
newListSubscriptions :: ListSubscriptions Source #
Create a value of ListSubscriptions 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:ListSubscriptions', listSubscriptions_nextToken - Token returned by the previous ListSubscriptions request.
data ListSubscriptionsResponse Source #
Response for ListSubscriptions action
See: newListSubscriptionsResponse smart constructor.
Constructors
| ListSubscriptionsResponse' (Maybe Text) (Maybe [Subscription]) Int |
Instances
newListSubscriptionsResponse Source #
Create a value of ListSubscriptionsResponse 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:ListSubscriptions', listSubscriptionsResponse_nextToken - Token to pass along to the next ListSubscriptions request. This
element is returned if there are more subscriptions to retrieve.
$sel:subscriptions:ListSubscriptionsResponse', listSubscriptionsResponse_subscriptions - A list of subscriptions.
$sel:httpStatus:ListSubscriptionsResponse', listSubscriptionsResponse_httpStatus - The response's http status code.
GetSubscriptionAttributes
data GetSubscriptionAttributes Source #
Input for GetSubscriptionAttributes.
See: newGetSubscriptionAttributes smart constructor.
Constructors
| GetSubscriptionAttributes' Text |
Instances
newGetSubscriptionAttributes Source #
Create a value of GetSubscriptionAttributes 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:subscriptionArn:GetSubscriptionAttributes', getSubscriptionAttributes_subscriptionArn - The ARN of the subscription whose properties you want to get.
data GetSubscriptionAttributesResponse Source #
Response for GetSubscriptionAttributes action.
See: newGetSubscriptionAttributesResponse smart constructor.
Instances
newGetSubscriptionAttributesResponse Source #
Arguments
| :: Int | |
| -> GetSubscriptionAttributesResponse |
Create a value of GetSubscriptionAttributesResponse 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:GetSubscriptionAttributesResponse', getSubscriptionAttributesResponse_attributes - A map of the subscription's attributes. Attributes in this map include
the following:
ConfirmationWasAuthenticated–trueif the subscription confirmation request was authenticated.DeliveryPolicy– The JSON serialization of the subscription's delivery policy.EffectiveDeliveryPolicy– The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.FilterPolicy– The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.Owner– The account ID of the subscription's owner.PendingConfirmation–trueif the subscription hasn't been confirmed. To confirm a pending subscription, call theConfirmSubscriptionaction with a confirmation token.RawMessageDelivery–trueif raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.RedrivePolicy– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.SubscriptionArn– The subscription's ARN.TopicArn– The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn– The ARN of the IAM role that has the following:- Permission to write to the Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
$sel:httpStatus:GetSubscriptionAttributesResponse', getSubscriptionAttributesResponse_httpStatus - The response's http status code.
CreateTopic
data CreateTopic Source #
Input for CreateTopic action.
See: newCreateTopic smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateTopic |
Create a value of CreateTopic 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:CreateTopic', createTopic_attributes - A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters that the CreateTopic action uses:
DeliveryPolicy– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.DisplayName– The display name to use for a topic with SMS subscriptions.FifoTopic– Set to true to create a FIFO topic.Policy– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side encryption:
KmsMasterKeyId– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic– When this is set totrue, a FIFO topic is created.ContentBasedDeduplication– Enables content-based deduplication for FIFO topics.- By default,
ContentBasedDeduplicationis set tofalse. If you create a FIFO topic and this attribute isfalse, you must specify a value for theMessageDeduplicationIdparameter for the Publish action. When you set
ContentBasedDeduplicationtotrue, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationIdusing the body of the message (but not the attributes of the message).(Optional) To override the generated value, you can specify a value for the
MessageDeduplicationIdparameter for thePublishaction.
- By default,
$sel:tags:CreateTopic', createTopic_tags - The list of tags to add to a new topic.
To be able to tag a topic on creation, you must have the
sns:CreateTopic and sns:TagResource permissions.
$sel:name:CreateTopic', createTopic_name - The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the
.fifo suffix.
data CreateTopicResponse Source #
Response from CreateTopic action.
See: newCreateTopicResponse smart constructor.
Constructors
| CreateTopicResponse' (Maybe Text) Int |
Instances
newCreateTopicResponse Source #
Arguments
| :: Int | |
| -> CreateTopicResponse |
Create a value of CreateTopicResponse 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:topicArn:CreateTopicResponse', createTopicResponse_topicArn - The Amazon Resource Name (ARN) assigned to the created topic.
$sel:httpStatus:CreateTopicResponse', createTopicResponse_httpStatus - The response's http status code.
CheckIfPhoneNumberIsOptedOut
data CheckIfPhoneNumberIsOptedOut Source #
The input for the CheckIfPhoneNumberIsOptedOut action.
See: newCheckIfPhoneNumberIsOptedOut smart constructor.
Constructors
| CheckIfPhoneNumberIsOptedOut' Text |
Instances
newCheckIfPhoneNumberIsOptedOut Source #
Create a value of CheckIfPhoneNumberIsOptedOut 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:phoneNumber:CheckIfPhoneNumberIsOptedOut', checkIfPhoneNumberIsOptedOut_phoneNumber - The phone number for which you want to check the opt out status.
data CheckIfPhoneNumberIsOptedOutResponse Source #
The response from the CheckIfPhoneNumberIsOptedOut action.
See: newCheckIfPhoneNumberIsOptedOutResponse smart constructor.
Constructors
| CheckIfPhoneNumberIsOptedOutResponse' (Maybe Bool) Int |
Instances
newCheckIfPhoneNumberIsOptedOutResponse Source #
Arguments
| :: Int | |
| -> CheckIfPhoneNumberIsOptedOutResponse |
Create a value of CheckIfPhoneNumberIsOptedOutResponse 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:isOptedOut:CheckIfPhoneNumberIsOptedOutResponse', checkIfPhoneNumberIsOptedOutResponse_isOptedOut - Indicates whether the phone number is opted out:
true– The phone number is opted out, meaning you cannot publish SMS messages to it.false– The phone number is opted in, meaning you can publish SMS messages to it.
$sel:httpStatus:CheckIfPhoneNumberIsOptedOutResponse', checkIfPhoneNumberIsOptedOutResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the topic to which to add tags.
$sel:tags:TagResource', tagResource_tags - The tags to be added to the specified topic. A tag consists of a
required key and an optional value.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
Subscribe
Input for Subscribe action.
See: newSubscribe smart constructor.
Instances
Create a value of Subscribe 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:returnSubscriptionArn:Subscribe', subscribe_returnSubscriptionArn - Sets whether the response from the Subscribe request includes the
subscription ARN, even if the subscription is not yet confirmed.
If you set this parameter to true, the response includes the ARN in
all cases, even if the subscription is not yet confirmed. In addition to
the ARN for confirmed subscriptions, the response also includes the
pending subscription ARN value for subscriptions that aren't yet
confirmed. A subscription becomes confirmed when the subscriber calls
the ConfirmSubscription action with a confirmation token.
The default value is false.
$sel:attributes:Subscribe', subscribe_attributes - A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters that the Subscribe action uses:
DeliveryPolicy– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.RawMessageDelivery– When set totrue, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn– The ARN of the IAM role that has the following:- Permission to write to the Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
$sel:endpoint:Subscribe', subscribe_endpoint - The endpoint that you want to receive notifications. Endpoints vary by
protocol:
- For the
httpprotocol, the (public) endpoint is a URL beginning withhttp://. - For the
httpsprotocol, the (public) endpoint is a URL beginning withhttps://. - For the
emailprotocol, the endpoint is an email address. - For the
email-jsonprotocol, the endpoint is an email address. - For the
smsprotocol, the endpoint is a phone number of an SMS-enabled device. - For the
sqsprotocol, the endpoint is the ARN of an Amazon SQS queue. - For the
applicationprotocol, the endpoint is the EndpointArn of a mobile app and device. - For the
lambdaprotocol, the endpoint is the ARN of an Lambda function. - For the
firehoseprotocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
$sel:topicArn:Subscribe', subscribe_topicArn - The ARN of the topic you want to subscribe to.
$sel:protocol:Subscribe', subscribe_protocol - The protocol that you want to use. Supported protocols include:
http– delivery of JSON-encoded message via HTTP POSThttps– delivery of JSON-encoded message via HTTPS POSTemail– delivery of message via SMTPemail-json– delivery of JSON-encoded message via SMTPsms– delivery of message via SMSsqs– delivery of JSON-encoded message to an Amazon SQS queueapplication– delivery of JSON-encoded message to an EndpointArn for a mobile app and devicelambda– delivery of JSON-encoded message to an Lambda functionfirehose– delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
data SubscribeResponse Source #
Response for Subscribe action.
See: newSubscribeResponse smart constructor.
Constructors
| SubscribeResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> SubscribeResponse |
Create a value of SubscribeResponse 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:subscriptionArn:SubscribeResponse', subscribeResponse_subscriptionArn - The ARN of the subscription if it is confirmed, or the string "pending
confirmation" if the subscription requires confirmation. However, if
the API request parameter ReturnSubscriptionArn is true, then the
value is always the subscription ARN, even if the subscription requires
confirmation.
$sel:httpStatus:SubscribeResponse', subscribeResponse_httpStatus - The response's http status code.
ListOriginationNumbers (Paginated)
data ListOriginationNumbers Source #
See: newListOriginationNumbers smart constructor.
Constructors
| ListOriginationNumbers' (Maybe Text) (Maybe Natural) |
Instances
newListOriginationNumbers :: ListOriginationNumbers Source #
Create a value of ListOriginationNumbers 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:ListOriginationNumbers', listOriginationNumbers_nextToken - Token that the previous ListOriginationNumbers request returns.
$sel:maxResults:ListOriginationNumbers', listOriginationNumbers_maxResults - The maximum number of origination numbers to return.
data ListOriginationNumbersResponse Source #
See: newListOriginationNumbersResponse smart constructor.
Constructors
| ListOriginationNumbersResponse' (Maybe Text) (Maybe [PhoneNumberInformation]) Int |
Instances
newListOriginationNumbersResponse Source #
Create a value of ListOriginationNumbersResponse 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:ListOriginationNumbers', listOriginationNumbersResponse_nextToken - A NextToken string is returned when you call the
ListOriginationNumbers operation if additional pages of records are
available.
$sel:phoneNumbers:ListOriginationNumbersResponse', listOriginationNumbersResponse_phoneNumbers - A list of the calling account's verified and pending origination
numbers.
$sel:httpStatus:ListOriginationNumbersResponse', listOriginationNumbersResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the topic from which to remove tags.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The list of tag keys to remove from the specified topic.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
Unsubscribe
data Unsubscribe Source #
Input for Unsubscribe action.
See: newUnsubscribe smart constructor.
Constructors
| Unsubscribe' Text |
Instances
Arguments
| :: Text | |
| -> Unsubscribe |
Create a value of Unsubscribe 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:subscriptionArn:Unsubscribe', unsubscribe_subscriptionArn - The ARN of the subscription to be deleted.
data UnsubscribeResponse Source #
See: newUnsubscribeResponse smart constructor.
Constructors
| UnsubscribeResponse' | |
Instances
| Eq UnsubscribeResponse Source # | |
Defined in Amazonka.SNS.Unsubscribe Methods (==) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool # (/=) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool # | |
| Read UnsubscribeResponse Source # | |
Defined in Amazonka.SNS.Unsubscribe Methods readsPrec :: Int -> ReadS UnsubscribeResponse # readList :: ReadS [UnsubscribeResponse] # | |
| Show UnsubscribeResponse Source # | |
Defined in Amazonka.SNS.Unsubscribe Methods showsPrec :: Int -> UnsubscribeResponse -> ShowS # show :: UnsubscribeResponse -> String # showList :: [UnsubscribeResponse] -> ShowS # | |
| Generic UnsubscribeResponse Source # | |
Defined in Amazonka.SNS.Unsubscribe Associated Types type Rep UnsubscribeResponse :: Type -> Type # Methods from :: UnsubscribeResponse -> Rep UnsubscribeResponse x # to :: Rep UnsubscribeResponse x -> UnsubscribeResponse # | |
| NFData UnsubscribeResponse Source # | |
Defined in Amazonka.SNS.Unsubscribe Methods rnf :: UnsubscribeResponse -> () # | |
| type Rep UnsubscribeResponse Source # | |
newUnsubscribeResponse :: UnsubscribeResponse Source #
Create a value of UnsubscribeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetSMSSandboxAccountStatus
data GetSMSSandboxAccountStatus Source #
See: newGetSMSSandboxAccountStatus smart constructor.
Constructors
| GetSMSSandboxAccountStatus' | |
Instances
newGetSMSSandboxAccountStatus :: GetSMSSandboxAccountStatus Source #
Create a value of GetSMSSandboxAccountStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetSMSSandboxAccountStatusResponse Source #
See: newGetSMSSandboxAccountStatusResponse smart constructor.
Constructors
| GetSMSSandboxAccountStatusResponse' Int Bool |
Instances
newGetSMSSandboxAccountStatusResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> GetSMSSandboxAccountStatusResponse |
Create a value of GetSMSSandboxAccountStatusResponse 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:httpStatus:GetSMSSandboxAccountStatusResponse', getSMSSandboxAccountStatusResponse_httpStatus - The response's http status code.
$sel:isInSandbox:GetSMSSandboxAccountStatusResponse', getSMSSandboxAccountStatusResponse_isInSandbox - Indicates whether the calling account is in the SMS sandbox.
SetEndpointAttributes
data SetEndpointAttributes Source #
Input for SetEndpointAttributes action.
See: newSetEndpointAttributes smart constructor.
Constructors
| SetEndpointAttributes' Text (HashMap Text Text) |
Instances
newSetEndpointAttributes Source #
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.
data SetEndpointAttributesResponse Source #
See: newSetEndpointAttributesResponse smart constructor.
Constructors
| SetEndpointAttributesResponse' | |
Instances
| Eq SetEndpointAttributesResponse Source # | |
Defined in Amazonka.SNS.SetEndpointAttributes | |
| Read SetEndpointAttributesResponse Source # | |
| Show SetEndpointAttributesResponse Source # | |
Defined in Amazonka.SNS.SetEndpointAttributes Methods showsPrec :: Int -> SetEndpointAttributesResponse -> ShowS # show :: SetEndpointAttributesResponse -> String # showList :: [SetEndpointAttributesResponse] -> ShowS # | |
| Generic SetEndpointAttributesResponse Source # | |
Defined in Amazonka.SNS.SetEndpointAttributes Associated Types type Rep SetEndpointAttributesResponse :: Type -> Type # | |
| NFData SetEndpointAttributesResponse Source # | |
Defined in Amazonka.SNS.SetEndpointAttributes Methods rnf :: SetEndpointAttributesResponse -> () # | |
| type Rep SetEndpointAttributesResponse Source # | |
Defined in Amazonka.SNS.SetEndpointAttributes | |
newSetEndpointAttributesResponse :: SetEndpointAttributesResponse Source #
Create a value of SetEndpointAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetSubscriptionAttributes
data SetSubscriptionAttributes Source #
Input for SetSubscriptionAttributes action.
See: newSetSubscriptionAttributes smart constructor.
Constructors
| SetSubscriptionAttributes' (Maybe Text) Text Text |
Instances
newSetSubscriptionAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> SetSubscriptionAttributes |
Create a value of SetSubscriptionAttributes 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:attributeValue:SetSubscriptionAttributes', setSubscriptionAttributes_attributeValue - The new value for the attribute in JSON format.
$sel:subscriptionArn:SetSubscriptionAttributes', setSubscriptionAttributes_subscriptionArn - The ARN of the subscription to modify.
$sel:attributeName:SetSubscriptionAttributes', setSubscriptionAttributes_attributeName - A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.FilterPolicy– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.RawMessageDelivery– When set totrue, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.RedrivePolicy– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn– The ARN of the IAM role that has the following:- Permission to write to the Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
data SetSubscriptionAttributesResponse Source #
See: newSetSubscriptionAttributesResponse smart constructor.
Constructors
| SetSubscriptionAttributesResponse' | |
Instances
| Eq SetSubscriptionAttributesResponse Source # | |
| Read SetSubscriptionAttributesResponse Source # | |
| Show SetSubscriptionAttributesResponse Source # | |
Defined in Amazonka.SNS.SetSubscriptionAttributes Methods showsPrec :: Int -> SetSubscriptionAttributesResponse -> ShowS # | |
| Generic SetSubscriptionAttributesResponse Source # | |
Defined in Amazonka.SNS.SetSubscriptionAttributes Associated Types type Rep SetSubscriptionAttributesResponse :: Type -> Type # | |
| NFData SetSubscriptionAttributesResponse Source # | |
Defined in Amazonka.SNS.SetSubscriptionAttributes Methods rnf :: SetSubscriptionAttributesResponse -> () # | |
| type Rep SetSubscriptionAttributesResponse Source # | |
Defined in Amazonka.SNS.SetSubscriptionAttributes | |
newSetSubscriptionAttributesResponse :: SetSubscriptionAttributesResponse Source #
Create a value of SetSubscriptionAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ConfirmSubscription
data ConfirmSubscription Source #
Input for ConfirmSubscription action.
See: newConfirmSubscription smart constructor.
Constructors
| ConfirmSubscription' (Maybe Text) Text Text |
Instances
newConfirmSubscription Source #
Arguments
| :: Text | |
| -> Text | |
| -> ConfirmSubscription |
Create a value of ConfirmSubscription 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:authenticateOnUnsubscribe:ConfirmSubscription', confirmSubscription_authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value
of this parameter is true and the request has an Amazon Web Services
signature, then only the topic owner and the subscription owner can
unsubscribe the endpoint. The unsubscribe action requires Amazon Web
Services authentication.
$sel:topicArn:ConfirmSubscription', confirmSubscription_topicArn - The ARN of the topic for which you wish to confirm a subscription.
$sel:token:ConfirmSubscription', confirmSubscription_token - Short-lived token sent to an endpoint during the Subscribe action.
data ConfirmSubscriptionResponse Source #
Response for ConfirmSubscriptions action.
See: newConfirmSubscriptionResponse smart constructor.
Constructors
| ConfirmSubscriptionResponse' (Maybe Text) Int |
Instances
newConfirmSubscriptionResponse Source #
Create a value of ConfirmSubscriptionResponse 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:subscriptionArn:ConfirmSubscriptionResponse', confirmSubscriptionResponse_subscriptionArn - The ARN of the created subscription.
$sel:httpStatus:ConfirmSubscriptionResponse', confirmSubscriptionResponse_httpStatus - The response's http status code.
Publish
Input for Publish action.
See: newPublish smart constructor.
Constructors
| Publish' (Maybe Text) (Maybe Text) (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of Publish 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:subject:Publish', publish_subject - Optional parameter to be used as the "Subject" line when the message
is delivered to email endpoints. This field will also be included, if
present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
$sel:targetArn:Publish', publish_targetArn - If you don't specify a value for the TargetArn parameter, you must
specify a value for the PhoneNumber or TopicArn parameters.
$sel:messageAttributes:Publish', publish_messageAttributes - Message attributes for Publish action.
$sel:topicArn:Publish', publish_topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must
specify a value for the PhoneNumber or TargetArn parameters.
$sel:phoneNumber:Publish', publish_phoneNumber - The phone number to which you want to deliver an SMS message. Use E.164
format.
If you don't specify a value for the PhoneNumber parameter, you must
specify a value for the TargetArn or TopicArn parameters.
$sel:messageDeduplicationId:Publish', publish_messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) topics. The
MessageDeduplicationId can contain up to 128 alphanumeric characters
(a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is a
token used for deduplication of sent messages. If a message with a
particular MessageDeduplicationId is sent successfully, any message
sent with the same MessageDeduplicationId during the 5-minute
deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your
MessageDeduplicationId overrides the generated one.
$sel:messageStructure:Publish', publish_messageStructure - Set MessageStructure to json if you want to send a different message
for each protocol. For example, using one publish action, you can send a
short message to your SMS subscribers and a longer message to your email
subscribers. If you set MessageStructure to json, the value of the
Message parameter must:
- be a syntactically valid JSON object; and
- contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
Valid value: json
$sel:messageGroupId:Publish', publish_messageGroupId - This parameter applies only to FIFO (first-in-first-out) topics. The
MessageGroupId can contain up to 128 alphanumeric characters (a-z,
A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
The MessageGroupId is a tag that specifies that a message belongs to a
specific message group. Messages that belong to the same message group
are processed in a FIFO manner (however, messages in different message
groups might be processed out of order). Every message must include a
MessageGroupId.
$sel:message:Publish', publish_message - The message you want to send.
If you are publishing to a topic and you want to send the same message
to all transport protocols, include the text of the message as a String
value. If you want to send different messages for each transport
protocol, set the value of the MessageStructure parameter to json
and use a JSON object for the Message parameter.
Constraints:
- With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS
Publishaction is 1,600 characters.
JSON-specific constraints:
- Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
- The values will be parsed (unescaped) before they are used in outgoing messages.
- Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
- Values have a minimum length of 0 (the empty string, "", is allowed).
- Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
- Non-string values will cause the key to be ignored.
- Keys that do not correspond to supported transport protocols are ignored.
- Duplicate keys are not allowed.
- Failure to parse or validate any key or value in the message will
cause the
Publishcall to return an error (no partial delivery).
data PublishResponse Source #
Response for Publish action.
See: newPublishResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> PublishResponse |
Create a value of PublishResponse 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:sequenceNumber:PublishResponse', publishResponse_sequenceNumber - This response element applies only to FIFO (first-in-first-out) topics.
The sequence number is a large, non-consecutive number that Amazon SNS
assigns to each message. The length of SequenceNumber is 128 bits.
SequenceNumber continues to increase for each MessageGroupId.
$sel:messageId:PublishResponse', publishResponse_messageId - Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
$sel:httpStatus:PublishResponse', publishResponse_httpStatus - The response's http status code.
Types
LanguageCodeString
newtype LanguageCodeString Source #
Supported language code for sending OTP message
Constructors
| LanguageCodeString' | |
Fields | |
Bundled Patterns
| pattern LanguageCodeString_De_DE :: LanguageCodeString | |
| pattern LanguageCodeString_En_GB :: LanguageCodeString | |
| pattern LanguageCodeString_En_US :: LanguageCodeString | |
| pattern LanguageCodeString_Es_419 :: LanguageCodeString | |
| pattern LanguageCodeString_Es_ES :: LanguageCodeString | |
| pattern LanguageCodeString_Fr_CA :: LanguageCodeString | |
| pattern LanguageCodeString_Fr_FR :: LanguageCodeString | |
| pattern LanguageCodeString_It_IT :: LanguageCodeString | |
| pattern LanguageCodeString_Ja_JP :: LanguageCodeString | |
| pattern LanguageCodeString_Kr_KR :: LanguageCodeString | |
| pattern LanguageCodeString_Pt_BR :: LanguageCodeString | |
| pattern LanguageCodeString_Zh_CN :: LanguageCodeString | |
| pattern LanguageCodeString_Zh_TW :: LanguageCodeString |
Instances
NumberCapability
newtype NumberCapability Source #
Enum listing out all supported number capabilities.
Constructors
| NumberCapability' | |
Fields | |
Bundled Patterns
| pattern NumberCapability_MMS :: NumberCapability | |
| pattern NumberCapability_SMS :: NumberCapability | |
| pattern NumberCapability_VOICE :: NumberCapability |
Instances
RouteType
Enum listing out all supported route types. The following enum values are supported. 1. Transactional : Non-marketing traffic 2. Promotional : Marketing 3. Premium : Premium routes for OTP delivery to the carriers
Constructors
| RouteType' | |
Fields | |
Bundled Patterns
| pattern RouteType_Premium :: RouteType | |
| pattern RouteType_Promotional :: RouteType | |
| pattern RouteType_Transactional :: RouteType |
Instances
SMSSandboxPhoneNumberVerificationStatus
newtype SMSSandboxPhoneNumberVerificationStatus Source #
Enum listing out all supported destination phone number verification statuses. The following enum values are supported. 1. PENDING : The destination phone number is pending verification. 2. VERIFIED : The destination phone number is verified.
Constructors
| SMSSandboxPhoneNumberVerificationStatus' | |
Bundled Patterns
| pattern SMSSandboxPhoneNumberVerificationStatus_Pending :: SMSSandboxPhoneNumberVerificationStatus | |
| pattern SMSSandboxPhoneNumberVerificationStatus_Verified :: SMSSandboxPhoneNumberVerificationStatus |
Instances
Endpoint
Endpoint for mobile app and device.
See: newEndpoint smart constructor.
Instances
| Eq Endpoint Source # | |
| Read Endpoint Source # | |
| Show Endpoint Source # | |
| Generic Endpoint Source # | |
| NFData Endpoint Source # | |
Defined in Amazonka.SNS.Types.Endpoint | |
| Hashable Endpoint Source # | |
Defined in Amazonka.SNS.Types.Endpoint | |
| FromXML Endpoint Source # | |
| type Rep Endpoint Source # | |
Defined in Amazonka.SNS.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.SNS.Types.Endpoint" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newEndpoint :: Endpoint Source #
Create a value of Endpoint 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:Endpoint', endpoint_attributes - Attributes for endpoint.
$sel:endpointArn:Endpoint', endpoint_endpointArn - 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 Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.
See: newMessageAttributeValue smart constructor.
Instances
newMessageAttributeValue Source #
Create a value of MessageAttributeValue 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:binaryValue:MessageAttributeValue', messageAttributeValue_binaryValue - 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.
$sel:stringValue:MessageAttributeValue', messageAttributeValue_stringValue - Strings are Unicode with UTF8 binary encoding. For a list of code
values, see
ASCII Printable Characters.
$sel:dataType:MessageAttributeValue', messageAttributeValue_dataType - Amazon SNS supports the following logical data types: String,
String.Array, Number, and Binary. For more information, see
Message Attribute Data Types.
PhoneNumberInformation
data PhoneNumberInformation Source #
A list of phone numbers and their metadata.
See: newPhoneNumberInformation smart constructor.
Constructors
| PhoneNumberInformation' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [NumberCapability]) (Maybe RouteType) |
Instances
newPhoneNumberInformation :: PhoneNumberInformation Source #
Create a value of PhoneNumberInformation 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:status:PhoneNumberInformation', phoneNumberInformation_status - The status of the phone number.
$sel:iso2CountryCode:PhoneNumberInformation', phoneNumberInformation_iso2CountryCode - The two-character code for the country or region, in ISO 3166-1 alpha-2
format.
$sel:createdAt:PhoneNumberInformation', phoneNumberInformation_createdAt - The date and time when the phone number was created.
$sel:phoneNumber:PhoneNumberInformation', phoneNumberInformation_phoneNumber - The phone number.
$sel:numberCapabilities:PhoneNumberInformation', phoneNumberInformation_numberCapabilities - The capabilities of each phone number.
$sel:routeType:PhoneNumberInformation', phoneNumberInformation_routeType - The list of supported routes.
PlatformApplication
data PlatformApplication Source #
Platform application object.
See: newPlatformApplication smart constructor.
Instances
newPlatformApplication :: PlatformApplication Source #
Create a value of PlatformApplication 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:platformApplicationArn:PlatformApplication', platformApplication_platformApplicationArn - PlatformApplicationArn for platform application object.
$sel:attributes:PlatformApplication', platformApplication_attributes - Attributes for platform application object.
SMSSandboxPhoneNumber
data SMSSandboxPhoneNumber Source #
A verified or pending destination phone number in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
See: newSMSSandboxPhoneNumber smart constructor.
Constructors
| SMSSandboxPhoneNumber' (Maybe SMSSandboxPhoneNumberVerificationStatus) (Maybe Text) |
Instances
newSMSSandboxPhoneNumber :: SMSSandboxPhoneNumber Source #
Create a value of SMSSandboxPhoneNumber 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:status:SMSSandboxPhoneNumber', sMSSandboxPhoneNumber_status - The destination phone number's verification status.
$sel:phoneNumber:SMSSandboxPhoneNumber', sMSSandboxPhoneNumber_phoneNumber - The destination phone number.
Subscription
data Subscription Source #
A wrapper type for the attributes of an Amazon SNS subscription.
See: newSubscription smart constructor.
Instances
newSubscription :: Subscription Source #
Create a value of Subscription 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:protocol:Subscription', subscription_protocol - The subscription's protocol.
$sel:owner:Subscription', subscription_owner - The subscription's owner.
$sel:topicArn:Subscription', subscription_topicArn - The ARN of the subscription's topic.
$sel:endpoint:Subscription', subscription_endpoint - The subscription's endpoint (format depends on the protocol).
$sel:subscriptionArn:Subscription', subscription_subscriptionArn - The subscription's ARN.
Tag
The list of tags to be added to the specified topic.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.SNS.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.SNS.Types.Tag | |
| ToQuery Tag Source # | |
Defined in Amazonka.SNS.Types.Tag Methods toQuery :: Tag -> QueryString # | |
| FromXML Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.SNS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.SNS.Types.Tag" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - The required key portion of the tag.
$sel:value:Tag', tag_value - The optional value portion of the tag.
Topic
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve
a topic's attributes, use GetTopicAttributes.
See: newTopic smart constructor.
Create a value of Topic 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:topicArn:Topic', topic_topicArn - The topic's ARN.