Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateOriginationIdentity
- CreateConfigurationSet
- CreateEventDestination
- CreateOptOutList
- CreatePool
- DeleteConfigurationSet
- DeleteDefaultMessageType
- DeleteDefaultSenderId
- DeleteEventDestination
- DeleteKeyword
- DeleteOptOutList
- DeleteOptedOutNumber
- DeletePool
- DeleteTextMessageSpendLimitOverride
- DeleteVoiceMessageSpendLimitOverride
- DescribeAccountAttributes (Paginated)
- DescribeAccountLimits (Paginated)
- DescribeConfigurationSets (Paginated)
- DescribeKeywords (Paginated)
- DescribeOptOutLists (Paginated)
- DescribeOptedOutNumbers (Paginated)
- DescribePhoneNumbers (Paginated)
- DescribePools (Paginated)
- DescribeSenderIds (Paginated)
- DescribeSpendLimits (Paginated)
- DisassociateOriginationIdentity
- ListPoolOriginationIdentities (Paginated)
- ListTagsForResource
- PutKeyword
- PutOptedOutNumber
- ReleasePhoneNumber
- RequestPhoneNumber
- SendTextMessage
- SendVoiceMessage
- SetDefaultMessageType
- SetDefaultSenderId
- SetTextMessageSpendLimitOverride
- SetVoiceMessageSpendLimitOverride
- TagResource
- UntagResource
- UpdateEventDestination
- UpdatePhoneNumber
- UpdatePool
- Types
- AccountAttributeName
- AccountLimitName
- ConfigurationSetFilterName
- DestinationCountryParameterKey
- EventType
- KeywordAction
- KeywordFilterName
- MessageType
- NumberCapability
- NumberStatus
- NumberType
- OptedOutFilterName
- PhoneNumberFilterName
- PoolFilterName
- PoolOriginationIdentitiesFilterName
- PoolStatus
- RequestableNumberType
- SenderIdFilterName
- SpendLimitName
- VoiceId
- VoiceMessageBodyTextType
- AccountAttribute
- AccountLimit
- CloudWatchLogsDestination
- ConfigurationSetFilter
- ConfigurationSetInformation
- EventDestination
- KeywordFilter
- KeywordInformation
- KinesisFirehoseDestination
- OptOutListInformation
- OptedOutFilter
- OptedOutNumberInformation
- OriginationIdentityMetadata
- PhoneNumberFilter
- PhoneNumberInformation
- PoolFilter
- PoolInformation
- PoolOriginationIdentitiesFilter
- SenderIdAndCountry
- SenderIdFilter
- SenderIdInformation
- SnsDestination
- SpendLimit
- Tag
Derived from API version 2022-03-31
of the AWS service descriptions, licensed under Apache 2.0.
Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AssociateOriginationIdentity = AssociateOriginationIdentity' (Maybe Text) Text Text Text
- newAssociateOriginationIdentity :: Text -> Text -> Text -> AssociateOriginationIdentity
- data AssociateOriginationIdentityResponse = AssociateOriginationIdentityResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newAssociateOriginationIdentityResponse :: Int -> AssociateOriginationIdentityResponse
- data CreateConfigurationSet = CreateConfigurationSet' (Maybe Text) (Maybe [Tag]) Text
- newCreateConfigurationSet :: Text -> CreateConfigurationSet
- data CreateConfigurationSetResponse = CreateConfigurationSetResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [Tag]) Int
- newCreateConfigurationSetResponse :: Int -> CreateConfigurationSetResponse
- data CreateEventDestination = CreateEventDestination' (Maybe Text) (Maybe CloudWatchLogsDestination) (Maybe KinesisFirehoseDestination) (Maybe SnsDestination) Text Text (NonEmpty EventType)
- newCreateEventDestination :: Text -> Text -> NonEmpty EventType -> CreateEventDestination
- data CreateEventDestinationResponse = CreateEventDestinationResponse' (Maybe Text) (Maybe Text) (Maybe EventDestination) Int
- newCreateEventDestinationResponse :: Int -> CreateEventDestinationResponse
- data CreateOptOutList = CreateOptOutList' (Maybe Text) (Maybe [Tag]) Text
- newCreateOptOutList :: Text -> CreateOptOutList
- data CreateOptOutListResponse = CreateOptOutListResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Tag]) Int
- newCreateOptOutListResponse :: Int -> CreateOptOutListResponse
- data CreatePool = CreatePool' (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Text MessageType
- newCreatePool :: Text -> Text -> MessageType -> CreatePool
- data CreatePoolResponse = CreatePoolResponse' (Maybe POSIX) (Maybe Bool) (Maybe MessageType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe PoolStatus) (Maybe [Tag]) (Maybe Text) (Maybe Bool) Int
- newCreatePoolResponse :: Int -> CreatePoolResponse
- data DeleteConfigurationSet = DeleteConfigurationSet' Text
- newDeleteConfigurationSet :: Text -> DeleteConfigurationSet
- data DeleteConfigurationSetResponse = DeleteConfigurationSetResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MessageType) (Maybe Text) (Maybe [EventDestination]) Int
- newDeleteConfigurationSetResponse :: Int -> DeleteConfigurationSetResponse
- data DeleteDefaultMessageType = DeleteDefaultMessageType' Text
- newDeleteDefaultMessageType :: Text -> DeleteDefaultMessageType
- data DeleteDefaultMessageTypeResponse = DeleteDefaultMessageTypeResponse' (Maybe Text) (Maybe Text) (Maybe MessageType) Int
- newDeleteDefaultMessageTypeResponse :: Int -> DeleteDefaultMessageTypeResponse
- data DeleteDefaultSenderId = DeleteDefaultSenderId' Text
- newDeleteDefaultSenderId :: Text -> DeleteDefaultSenderId
- data DeleteDefaultSenderIdResponse = DeleteDefaultSenderIdResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDeleteDefaultSenderIdResponse :: Int -> DeleteDefaultSenderIdResponse
- data DeleteEventDestination = DeleteEventDestination' Text Text
- newDeleteEventDestination :: Text -> Text -> DeleteEventDestination
- data DeleteEventDestinationResponse = DeleteEventDestinationResponse' (Maybe Text) (Maybe Text) (Maybe EventDestination) Int
- newDeleteEventDestinationResponse :: Int -> DeleteEventDestinationResponse
- data DeleteKeyword = DeleteKeyword' Text Text
- newDeleteKeyword :: Text -> Text -> DeleteKeyword
- data DeleteKeywordResponse = DeleteKeywordResponse' (Maybe Text) (Maybe KeywordAction) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDeleteKeywordResponse :: Int -> DeleteKeywordResponse
- data DeleteOptOutList = DeleteOptOutList' Text
- newDeleteOptOutList :: Text -> DeleteOptOutList
- data DeleteOptOutListResponse = DeleteOptOutListResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newDeleteOptOutListResponse :: Int -> DeleteOptOutListResponse
- data DeleteOptedOutNumber = DeleteOptedOutNumber' Text Text
- newDeleteOptedOutNumber :: Text -> Text -> DeleteOptedOutNumber
- data DeleteOptedOutNumberResponse = DeleteOptedOutNumberResponse' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDeleteOptedOutNumberResponse :: Int -> DeleteOptedOutNumberResponse
- data DeletePool = DeletePool' Text
- newDeletePool :: Text -> DeletePool
- data DeletePoolResponse = DeletePoolResponse' (Maybe POSIX) (Maybe MessageType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe PoolStatus) (Maybe Text) (Maybe Bool) Int
- newDeletePoolResponse :: Int -> DeletePoolResponse
- data DeleteTextMessageSpendLimitOverride = DeleteTextMessageSpendLimitOverride' {
- newDeleteTextMessageSpendLimitOverride :: DeleteTextMessageSpendLimitOverride
- data DeleteTextMessageSpendLimitOverrideResponse = DeleteTextMessageSpendLimitOverrideResponse' (Maybe Natural) Int
- newDeleteTextMessageSpendLimitOverrideResponse :: Int -> DeleteTextMessageSpendLimitOverrideResponse
- data DeleteVoiceMessageSpendLimitOverride = DeleteVoiceMessageSpendLimitOverride' {
- newDeleteVoiceMessageSpendLimitOverride :: DeleteVoiceMessageSpendLimitOverride
- data DeleteVoiceMessageSpendLimitOverrideResponse = DeleteVoiceMessageSpendLimitOverrideResponse' (Maybe Natural) Int
- newDeleteVoiceMessageSpendLimitOverrideResponse :: Int -> DeleteVoiceMessageSpendLimitOverrideResponse
- data DescribeAccountAttributes = DescribeAccountAttributes' (Maybe Natural) (Maybe Text)
- newDescribeAccountAttributes :: DescribeAccountAttributes
- data DescribeAccountAttributesResponse = DescribeAccountAttributesResponse' (Maybe [AccountAttribute]) (Maybe Text) Int
- newDescribeAccountAttributesResponse :: Int -> DescribeAccountAttributesResponse
- data DescribeAccountLimits = DescribeAccountLimits' (Maybe Natural) (Maybe Text)
- newDescribeAccountLimits :: DescribeAccountLimits
- data DescribeAccountLimitsResponse = DescribeAccountLimitsResponse' (Maybe [AccountLimit]) (Maybe Text) Int
- newDescribeAccountLimitsResponse :: Int -> DescribeAccountLimitsResponse
- data DescribeConfigurationSets = DescribeConfigurationSets' (Maybe [Text]) (Maybe [ConfigurationSetFilter]) (Maybe Natural) (Maybe Text)
- newDescribeConfigurationSets :: DescribeConfigurationSets
- data DescribeConfigurationSetsResponse = DescribeConfigurationSetsResponse' (Maybe [ConfigurationSetInformation]) (Maybe Text) Int
- newDescribeConfigurationSetsResponse :: Int -> DescribeConfigurationSetsResponse
- data DescribeKeywords = DescribeKeywords' (Maybe [KeywordFilter]) (Maybe [Text]) (Maybe Natural) (Maybe Text) Text
- newDescribeKeywords :: Text -> DescribeKeywords
- data DescribeKeywordsResponse = DescribeKeywordsResponse' (Maybe [KeywordInformation]) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeKeywordsResponse :: Int -> DescribeKeywordsResponse
- data DescribeOptOutLists = DescribeOptOutLists' (Maybe Natural) (Maybe Text) (Maybe [Text])
- newDescribeOptOutLists :: DescribeOptOutLists
- data DescribeOptOutListsResponse = DescribeOptOutListsResponse' (Maybe Text) (Maybe [OptOutListInformation]) Int
- newDescribeOptOutListsResponse :: Int -> DescribeOptOutListsResponse
- data DescribeOptedOutNumbers = DescribeOptedOutNumbers' (Maybe [OptedOutFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) Text
- newDescribeOptedOutNumbers :: Text -> DescribeOptedOutNumbers
- data DescribeOptedOutNumbersResponse = DescribeOptedOutNumbersResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [OptedOutNumberInformation]) Int
- newDescribeOptedOutNumbersResponse :: Int -> DescribeOptedOutNumbersResponse
- data DescribePhoneNumbers = DescribePhoneNumbers' (Maybe [PhoneNumberFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text])
- newDescribePhoneNumbers :: DescribePhoneNumbers
- data DescribePhoneNumbersResponse = DescribePhoneNumbersResponse' (Maybe Text) (Maybe [PhoneNumberInformation]) Int
- newDescribePhoneNumbersResponse :: Int -> DescribePhoneNumbersResponse
- data DescribePools = DescribePools' (Maybe [PoolFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text])
- newDescribePools :: DescribePools
- data DescribePoolsResponse = DescribePoolsResponse' (Maybe Text) (Maybe [PoolInformation]) Int
- newDescribePoolsResponse :: Int -> DescribePoolsResponse
- data DescribeSenderIds = DescribeSenderIds' (Maybe [SenderIdFilter]) (Maybe Natural) (Maybe Text) (Maybe [SenderIdAndCountry])
- newDescribeSenderIds :: DescribeSenderIds
- data DescribeSenderIdsResponse = DescribeSenderIdsResponse' (Maybe Text) (Maybe [SenderIdInformation]) Int
- newDescribeSenderIdsResponse :: Int -> DescribeSenderIdsResponse
- data DescribeSpendLimits = DescribeSpendLimits' (Maybe Natural) (Maybe Text)
- newDescribeSpendLimits :: DescribeSpendLimits
- data DescribeSpendLimitsResponse = DescribeSpendLimitsResponse' (Maybe Text) (Maybe [SpendLimit]) Int
- newDescribeSpendLimitsResponse :: Int -> DescribeSpendLimitsResponse
- data DisassociateOriginationIdentity = DisassociateOriginationIdentity' (Maybe Text) Text Text Text
- newDisassociateOriginationIdentity :: Text -> Text -> Text -> DisassociateOriginationIdentity
- data DisassociateOriginationIdentityResponse = DisassociateOriginationIdentityResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDisassociateOriginationIdentityResponse :: Int -> DisassociateOriginationIdentityResponse
- data ListPoolOriginationIdentities = ListPoolOriginationIdentities' (Maybe [PoolOriginationIdentitiesFilter]) (Maybe Natural) (Maybe Text) Text
- newListPoolOriginationIdentities :: Text -> ListPoolOriginationIdentities
- data ListPoolOriginationIdentitiesResponse = ListPoolOriginationIdentitiesResponse' (Maybe Text) (Maybe [OriginationIdentityMetadata]) (Maybe Text) (Maybe Text) Int
- newListPoolOriginationIdentitiesResponse :: Int -> ListPoolOriginationIdentitiesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutKeyword = PutKeyword' (Maybe KeywordAction) Text Text Text
- newPutKeyword :: Text -> Text -> Text -> PutKeyword
- data PutKeywordResponse = PutKeywordResponse' (Maybe Text) (Maybe KeywordAction) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newPutKeywordResponse :: Int -> PutKeywordResponse
- data PutOptedOutNumber = PutOptedOutNumber' Text Text
- newPutOptedOutNumber :: Text -> Text -> PutOptedOutNumber
- data PutOptedOutNumberResponse = PutOptedOutNumberResponse' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newPutOptedOutNumberResponse :: Int -> PutOptedOutNumberResponse
- data ReleasePhoneNumber = ReleasePhoneNumber' Text
- newReleasePhoneNumber :: Text -> ReleasePhoneNumber
- data ReleasePhoneNumberResponse = ReleasePhoneNumberResponse' (Maybe POSIX) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe (NonEmpty NumberCapability)) (Maybe NumberType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NumberStatus) (Maybe Text) (Maybe Bool) Int
- newReleasePhoneNumberResponse :: Int -> ReleasePhoneNumberResponse
- data RequestPhoneNumber = RequestPhoneNumber' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text MessageType (NonEmpty NumberCapability) RequestableNumberType
- newRequestPhoneNumber :: Text -> MessageType -> NonEmpty NumberCapability -> RequestableNumberType -> RequestPhoneNumber
- data RequestPhoneNumberResponse = RequestPhoneNumberResponse' (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe (NonEmpty NumberCapability)) (Maybe RequestableNumberType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NumberStatus) (Maybe [Tag]) (Maybe Text) (Maybe Bool) Int
- newRequestPhoneNumberResponse :: Int -> RequestPhoneNumberResponse
- data SendTextMessage = SendTextMessage' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap DestinationCountryParameterKey Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe Natural) Text
- newSendTextMessage :: Text -> SendTextMessage
- data SendTextMessageResponse = SendTextMessageResponse' (Maybe Text) Int
- newSendTextMessageResponse :: Int -> SendTextMessageResponse
- data SendVoiceMessage = SendVoiceMessage' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe VoiceMessageBodyTextType) (Maybe Natural) (Maybe VoiceId) Text Text
- newSendVoiceMessage :: Text -> Text -> SendVoiceMessage
- data SendVoiceMessageResponse = SendVoiceMessageResponse' (Maybe Text) Int
- newSendVoiceMessageResponse :: Int -> SendVoiceMessageResponse
- data SetDefaultMessageType = SetDefaultMessageType' Text MessageType
- newSetDefaultMessageType :: Text -> MessageType -> SetDefaultMessageType
- data SetDefaultMessageTypeResponse = SetDefaultMessageTypeResponse' (Maybe Text) (Maybe Text) (Maybe MessageType) Int
- newSetDefaultMessageTypeResponse :: Int -> SetDefaultMessageTypeResponse
- data SetDefaultSenderId = SetDefaultSenderId' Text Text
- newSetDefaultSenderId :: Text -> Text -> SetDefaultSenderId
- data SetDefaultSenderIdResponse = SetDefaultSenderIdResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newSetDefaultSenderIdResponse :: Int -> SetDefaultSenderIdResponse
- data SetTextMessageSpendLimitOverride = SetTextMessageSpendLimitOverride' Natural
- newSetTextMessageSpendLimitOverride :: Natural -> SetTextMessageSpendLimitOverride
- data SetTextMessageSpendLimitOverrideResponse = SetTextMessageSpendLimitOverrideResponse' (Maybe Natural) Int
- newSetTextMessageSpendLimitOverrideResponse :: Int -> SetTextMessageSpendLimitOverrideResponse
- data SetVoiceMessageSpendLimitOverride = SetVoiceMessageSpendLimitOverride' Natural
- newSetVoiceMessageSpendLimitOverride :: Natural -> SetVoiceMessageSpendLimitOverride
- data SetVoiceMessageSpendLimitOverrideResponse = SetVoiceMessageSpendLimitOverrideResponse' (Maybe Natural) Int
- newSetVoiceMessageSpendLimitOverrideResponse :: Int -> SetVoiceMessageSpendLimitOverrideResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateEventDestination = UpdateEventDestination' (Maybe CloudWatchLogsDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe (NonEmpty EventType)) (Maybe SnsDestination) Text Text
- newUpdateEventDestination :: Text -> Text -> UpdateEventDestination
- data UpdateEventDestinationResponse = UpdateEventDestinationResponse' (Maybe Text) (Maybe Text) (Maybe EventDestination) Int
- newUpdateEventDestinationResponse :: Int -> UpdateEventDestinationResponse
- data UpdatePhoneNumber = UpdatePhoneNumber' (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) Text
- newUpdatePhoneNumber :: Text -> UpdatePhoneNumber
- data UpdatePhoneNumberResponse = UpdatePhoneNumberResponse' (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe (NonEmpty NumberCapability)) (Maybe NumberType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NumberStatus) (Maybe Text) (Maybe Bool) Int
- newUpdatePhoneNumberResponse :: Int -> UpdatePhoneNumberResponse
- data UpdatePool = UpdatePool' (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) Text
- newUpdatePool :: Text -> UpdatePool
- data UpdatePoolResponse = UpdatePoolResponse' (Maybe POSIX) (Maybe Bool) (Maybe MessageType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe PoolStatus) (Maybe Text) (Maybe Bool) Int
- newUpdatePoolResponse :: Int -> UpdatePoolResponse
- newtype AccountAttributeName where
- newtype AccountLimitName where
- AccountLimitName' { }
- pattern AccountLimitName_CONFIGURATION_SETS :: AccountLimitName
- pattern AccountLimitName_OPT_OUT_LISTS :: AccountLimitName
- pattern AccountLimitName_PHONE_NUMBERS :: AccountLimitName
- pattern AccountLimitName_POOLS :: AccountLimitName
- newtype ConfigurationSetFilterName where
- ConfigurationSetFilterName' { }
- pattern ConfigurationSetFilterName_Default_message_type :: ConfigurationSetFilterName
- pattern ConfigurationSetFilterName_Default_sender_id :: ConfigurationSetFilterName
- pattern ConfigurationSetFilterName_Event_destination_name :: ConfigurationSetFilterName
- pattern ConfigurationSetFilterName_Matching_event_types :: ConfigurationSetFilterName
- newtype DestinationCountryParameterKey where
- newtype EventType where
- EventType' { }
- pattern EventType_ALL :: EventType
- pattern EventType_TEXT_ALL :: EventType
- pattern EventType_TEXT_BLOCKED :: EventType
- pattern EventType_TEXT_CARRIER_BLOCKED :: EventType
- pattern EventType_TEXT_CARRIER_UNREACHABLE :: EventType
- pattern EventType_TEXT_DELIVERED :: EventType
- pattern EventType_TEXT_INVALID :: EventType
- pattern EventType_TEXT_INVALID_MESSAGE :: EventType
- pattern EventType_TEXT_PENDING :: EventType
- pattern EventType_TEXT_QUEUED :: EventType
- pattern EventType_TEXT_SENT :: EventType
- pattern EventType_TEXT_SPAM :: EventType
- pattern EventType_TEXT_SUCCESSFUL :: EventType
- pattern EventType_TEXT_TTL_EXPIRED :: EventType
- pattern EventType_TEXT_UNKNOWN :: EventType
- pattern EventType_TEXT_UNREACHABLE :: EventType
- pattern EventType_VOICE_ALL :: EventType
- pattern EventType_VOICE_ANSWERED :: EventType
- pattern EventType_VOICE_BUSY :: EventType
- pattern EventType_VOICE_COMPLETED :: EventType
- pattern EventType_VOICE_FAILED :: EventType
- pattern EventType_VOICE_INITIATED :: EventType
- pattern EventType_VOICE_NO_ANSWER :: EventType
- pattern EventType_VOICE_RINGING :: EventType
- pattern EventType_VOICE_TTL_EXPIRED :: EventType
- newtype KeywordAction where
- KeywordAction' { }
- pattern KeywordAction_AUTOMATIC_RESPONSE :: KeywordAction
- pattern KeywordAction_OPT_IN :: KeywordAction
- pattern KeywordAction_OPT_OUT :: KeywordAction
- newtype KeywordFilterName where
- newtype MessageType where
- MessageType' { }
- pattern MessageType_PROMOTIONAL :: MessageType
- pattern MessageType_TRANSACTIONAL :: MessageType
- newtype NumberCapability where
- NumberCapability' { }
- pattern NumberCapability_SMS :: NumberCapability
- pattern NumberCapability_VOICE :: NumberCapability
- newtype NumberStatus where
- NumberStatus' { }
- pattern NumberStatus_ACTIVE :: NumberStatus
- pattern NumberStatus_ASSOCIATING :: NumberStatus
- pattern NumberStatus_DELETED :: NumberStatus
- pattern NumberStatus_DISASSOCIATING :: NumberStatus
- pattern NumberStatus_PENDING :: NumberStatus
- newtype NumberType where
- NumberType' { }
- pattern NumberType_LONG_CODE :: NumberType
- pattern NumberType_SHORT_CODE :: NumberType
- pattern NumberType_TEN_DLC :: NumberType
- pattern NumberType_TOLL_FREE :: NumberType
- newtype OptedOutFilterName where
- newtype PhoneNumberFilterName where
- PhoneNumberFilterName' { }
- pattern PhoneNumberFilterName_Deletion_protection_enabled :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Iso_country_code :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Message_type :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Number_capability :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Number_type :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Opt_out_list_name :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Self_managed_opt_outs_enabled :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Status :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Two_way_enabled :: PhoneNumberFilterName
- newtype PoolFilterName where
- PoolFilterName' { }
- pattern PoolFilterName_Deletion_protection_enabled :: PoolFilterName
- pattern PoolFilterName_Message_type :: PoolFilterName
- pattern PoolFilterName_Opt_out_list_name :: PoolFilterName
- pattern PoolFilterName_Self_managed_opt_outs_enabled :: PoolFilterName
- pattern PoolFilterName_Shared_routes_enabled :: PoolFilterName
- pattern PoolFilterName_Status :: PoolFilterName
- pattern PoolFilterName_Two_way_enabled :: PoolFilterName
- newtype PoolOriginationIdentitiesFilterName where
- newtype PoolStatus where
- PoolStatus' { }
- pattern PoolStatus_ACTIVE :: PoolStatus
- pattern PoolStatus_CREATING :: PoolStatus
- pattern PoolStatus_DELETING :: PoolStatus
- newtype RequestableNumberType where
- newtype SenderIdFilterName where
- newtype SpendLimitName where
- newtype VoiceId where
- VoiceId' {
- fromVoiceId :: Text
- pattern VoiceId_AMY :: VoiceId
- pattern VoiceId_ASTRID :: VoiceId
- pattern VoiceId_BIANCA :: VoiceId
- pattern VoiceId_BRIAN :: VoiceId
- pattern VoiceId_CAMILA :: VoiceId
- pattern VoiceId_CARLA :: VoiceId
- pattern VoiceId_CARMEN :: VoiceId
- pattern VoiceId_CELINE :: VoiceId
- pattern VoiceId_CHANTAL :: VoiceId
- pattern VoiceId_CONCHITA :: VoiceId
- pattern VoiceId_CRISTIANO :: VoiceId
- pattern VoiceId_DORA :: VoiceId
- pattern VoiceId_EMMA :: VoiceId
- pattern VoiceId_ENRIQUE :: VoiceId
- pattern VoiceId_EWA :: VoiceId
- pattern VoiceId_FILIZ :: VoiceId
- pattern VoiceId_GERAINT :: VoiceId
- pattern VoiceId_GIORGIO :: VoiceId
- pattern VoiceId_GWYNETH :: VoiceId
- pattern VoiceId_HANS :: VoiceId
- pattern VoiceId_INES :: VoiceId
- pattern VoiceId_IVY :: VoiceId
- pattern VoiceId_JACEK :: VoiceId
- pattern VoiceId_JAN :: VoiceId
- pattern VoiceId_JOANNA :: VoiceId
- pattern VoiceId_JOEY :: VoiceId
- pattern VoiceId_JUSTIN :: VoiceId
- pattern VoiceId_KARL :: VoiceId
- pattern VoiceId_KENDRA :: VoiceId
- pattern VoiceId_KIMBERLY :: VoiceId
- pattern VoiceId_LEA :: VoiceId
- pattern VoiceId_LIV :: VoiceId
- pattern VoiceId_LOTTE :: VoiceId
- pattern VoiceId_LUCIA :: VoiceId
- pattern VoiceId_LUPE :: VoiceId
- pattern VoiceId_MADS :: VoiceId
- pattern VoiceId_MAJA :: VoiceId
- pattern VoiceId_MARLENE :: VoiceId
- pattern VoiceId_MATHIEU :: VoiceId
- pattern VoiceId_MATTHEW :: VoiceId
- pattern VoiceId_MAXIM :: VoiceId
- pattern VoiceId_MIA :: VoiceId
- pattern VoiceId_MIGUEL :: VoiceId
- pattern VoiceId_MIZUKI :: VoiceId
- pattern VoiceId_NAJA :: VoiceId
- pattern VoiceId_NICOLE :: VoiceId
- pattern VoiceId_PENELOPE :: VoiceId
- pattern VoiceId_RAVEENA :: VoiceId
- pattern VoiceId_RICARDO :: VoiceId
- pattern VoiceId_RUBEN :: VoiceId
- pattern VoiceId_RUSSELL :: VoiceId
- pattern VoiceId_SALLI :: VoiceId
- pattern VoiceId_SEOYEON :: VoiceId
- pattern VoiceId_TAKUMI :: VoiceId
- pattern VoiceId_TATYANA :: VoiceId
- pattern VoiceId_VICKI :: VoiceId
- pattern VoiceId_VITORIA :: VoiceId
- pattern VoiceId_ZEINA :: VoiceId
- pattern VoiceId_ZHIYU :: VoiceId
- VoiceId' {
- newtype VoiceMessageBodyTextType where
- data AccountAttribute = AccountAttribute' AccountAttributeName Text
- newAccountAttribute :: AccountAttributeName -> Text -> AccountAttribute
- data AccountLimit = AccountLimit' AccountLimitName Integer Integer
- newAccountLimit :: AccountLimitName -> Integer -> Integer -> AccountLimit
- data CloudWatchLogsDestination = CloudWatchLogsDestination' Text Text
- newCloudWatchLogsDestination :: Text -> Text -> CloudWatchLogsDestination
- data ConfigurationSetFilter = ConfigurationSetFilter' ConfigurationSetFilterName (NonEmpty Text)
- newConfigurationSetFilter :: ConfigurationSetFilterName -> NonEmpty Text -> ConfigurationSetFilter
- data ConfigurationSetInformation = ConfigurationSetInformation' (Maybe MessageType) (Maybe Text) Text Text [EventDestination] POSIX
- newConfigurationSetInformation :: Text -> Text -> UTCTime -> ConfigurationSetInformation
- data EventDestination = EventDestination' (Maybe CloudWatchLogsDestination) (Maybe KinesisFirehoseDestination) (Maybe SnsDestination) Text Bool (NonEmpty EventType)
- newEventDestination :: Text -> Bool -> NonEmpty EventType -> EventDestination
- data KeywordFilter = KeywordFilter' KeywordFilterName (NonEmpty Text)
- newKeywordFilter :: KeywordFilterName -> NonEmpty Text -> KeywordFilter
- data KeywordInformation = KeywordInformation' Text Text KeywordAction
- newKeywordInformation :: Text -> Text -> KeywordAction -> KeywordInformation
- data KinesisFirehoseDestination = KinesisFirehoseDestination' Text Text
- newKinesisFirehoseDestination :: Text -> Text -> KinesisFirehoseDestination
- data OptOutListInformation = OptOutListInformation' Text Text POSIX
- newOptOutListInformation :: Text -> Text -> UTCTime -> OptOutListInformation
- data OptedOutFilter = OptedOutFilter' OptedOutFilterName (NonEmpty Text)
- newOptedOutFilter :: OptedOutFilterName -> NonEmpty Text -> OptedOutFilter
- data OptedOutNumberInformation = OptedOutNumberInformation' Text POSIX Bool
- newOptedOutNumberInformation :: Text -> UTCTime -> Bool -> OptedOutNumberInformation
- data OriginationIdentityMetadata = OriginationIdentityMetadata' Text Text Text (NonEmpty NumberCapability)
- newOriginationIdentityMetadata :: Text -> Text -> Text -> NonEmpty NumberCapability -> OriginationIdentityMetadata
- data PhoneNumberFilter = PhoneNumberFilter' PhoneNumberFilterName (NonEmpty Text)
- newPhoneNumberFilter :: PhoneNumberFilterName -> NonEmpty Text -> PhoneNumberFilter
- data PhoneNumberInformation = PhoneNumberInformation' (Maybe Text) (Maybe Text) (Maybe Text) Text Text NumberStatus Text MessageType (NonEmpty NumberCapability) NumberType Text Bool Bool Text Bool POSIX
- newPhoneNumberInformation :: Text -> Text -> NumberStatus -> Text -> MessageType -> NonEmpty NumberCapability -> NumberType -> Text -> Bool -> Bool -> Text -> Bool -> UTCTime -> PhoneNumberInformation
- data PoolFilter = PoolFilter' PoolFilterName (NonEmpty Text)
- newPoolFilter :: PoolFilterName -> NonEmpty Text -> PoolFilter
- data PoolInformation = PoolInformation' (Maybe Text) Text Text PoolStatus MessageType Bool Bool Text Bool Bool POSIX
- newPoolInformation :: Text -> Text -> PoolStatus -> MessageType -> Bool -> Bool -> Text -> Bool -> Bool -> UTCTime -> PoolInformation
- data PoolOriginationIdentitiesFilter = PoolOriginationIdentitiesFilter' PoolOriginationIdentitiesFilterName (NonEmpty Text)
- newPoolOriginationIdentitiesFilter :: PoolOriginationIdentitiesFilterName -> NonEmpty Text -> PoolOriginationIdentitiesFilter
- data SenderIdAndCountry = SenderIdAndCountry' Text Text
- newSenderIdAndCountry :: Text -> Text -> SenderIdAndCountry
- data SenderIdFilter = SenderIdFilter' SenderIdFilterName (NonEmpty Text)
- newSenderIdFilter :: SenderIdFilterName -> NonEmpty Text -> SenderIdFilter
- data SenderIdInformation = SenderIdInformation' Text Text Text [MessageType] Text
- newSenderIdInformation :: Text -> Text -> Text -> Text -> SenderIdInformation
- data SnsDestination = SnsDestination' Text
- newSnsDestination :: Text -> SnsDestination
- data SpendLimit = SpendLimit' SpendLimitName Integer Integer Bool
- newSpendLimit :: SpendLimitName -> Integer -> Integer -> Bool -> SpendLimit
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2022-03-31
of the Amazon Pinpoint SMS Voice V2 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 PinpointSmsVoiceV2
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The request was denied because you don't have sufficient permissions to access the resource.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A requested resource couldn't be found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota to be exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
An error that occurred because too many requests were sent during a certain amount of time.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
A validation exception for a field.
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.
AssociateOriginationIdentity
data AssociateOriginationIdentity Source #
See: newAssociateOriginationIdentity
smart constructor.
Instances
newAssociateOriginationIdentity Source #
:: Text | |
-> Text | |
-> Text | |
-> AssociateOriginationIdentity |
Create a value of AssociateOriginationIdentity
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:clientToken:AssociateOriginationIdentity'
, associateOriginationIdentity_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
AssociateOriginationIdentity
, associateOriginationIdentity_poolId
- The pool to update with the new Identity. This value can be either the
PoolId or PoolArn, and you can find these values using DescribePools.
AssociateOriginationIdentity
, associateOriginationIdentity_originationIdentity
- The origination identity to use, such as PhoneNumberId, PhoneNumberArn,
SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can
be used to get the values for SenderId and SenderIdArn.
AssociateOriginationIdentity
, associateOriginationIdentity_isoCountryCode
- The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the origination identity.
data AssociateOriginationIdentityResponse Source #
See: newAssociateOriginationIdentityResponse
smart constructor.
AssociateOriginationIdentityResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newAssociateOriginationIdentityResponse Source #
Create a value of AssociateOriginationIdentityResponse
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:
AssociateOriginationIdentity
, associateOriginationIdentityResponse_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
AssociateOriginationIdentity
, associateOriginationIdentityResponse_originationIdentity
- The PhoneNumberId or SenderId of the origination identity.
AssociateOriginationIdentityResponse
, associateOriginationIdentityResponse_originationIdentityArn
- The PhoneNumberArn or SenderIdArn of the origination identity.
AssociateOriginationIdentityResponse
, associateOriginationIdentityResponse_poolArn
- The Amazon Resource Name (ARN) of the pool that is now associated with
the origination identity.
AssociateOriginationIdentity
, associateOriginationIdentityResponse_poolId
- The PoolId of the pool that is now associated with the origination
identity.
$sel:httpStatus:AssociateOriginationIdentityResponse'
, associateOriginationIdentityResponse_httpStatus
- The response's http status code.
CreateConfigurationSet
data CreateConfigurationSet Source #
See: newCreateConfigurationSet
smart constructor.
Instances
newCreateConfigurationSet Source #
Create a value of CreateConfigurationSet
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:clientToken:CreateConfigurationSet'
, createConfigurationSet_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
CreateConfigurationSet
, createConfigurationSet_tags
- An array of key and value pair tags that's associated with the new
configuration set.
CreateConfigurationSet
, createConfigurationSet_configurationSetName
- The name to use for the new configuration set.
data CreateConfigurationSetResponse Source #
See: newCreateConfigurationSetResponse
smart constructor.
Instances
newCreateConfigurationSetResponse Source #
Create a value of CreateConfigurationSetResponse
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:
CreateConfigurationSetResponse
, createConfigurationSetResponse_configurationSetArn
- The Amazon Resource Name (ARN) of the newly created configuration set.
CreateConfigurationSet
, createConfigurationSetResponse_configurationSetName
- The name of the new configuration set.
CreateConfigurationSetResponse
, createConfigurationSetResponse_createdTimestamp
- The time when the configuration set was created, in
UNIX epoch time format.
CreateConfigurationSet
, createConfigurationSetResponse_tags
- An array of key and value pair tags that's associated with the
configuration set.
$sel:httpStatus:CreateConfigurationSetResponse'
, createConfigurationSetResponse_httpStatus
- The response's http status code.
CreateEventDestination
data CreateEventDestination Source #
See: newCreateEventDestination
smart constructor.
CreateEventDestination' (Maybe Text) (Maybe CloudWatchLogsDestination) (Maybe KinesisFirehoseDestination) (Maybe SnsDestination) Text Text (NonEmpty EventType) |
Instances
newCreateEventDestination Source #
:: Text | |
-> Text | |
-> NonEmpty EventType | |
-> CreateEventDestination |
Create a value of CreateEventDestination
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:clientToken:CreateEventDestination'
, createEventDestination_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
CreateEventDestination
, createEventDestination_cloudWatchLogsDestination
- An object that contains information about an event destination for
logging to Amazon CloudWatch logs.
CreateEventDestination
, createEventDestination_kinesisFirehoseDestination
- An object that contains information about an event destination for
logging to Amazon Kinesis Data Firehose.
CreateEventDestination
, createEventDestination_snsDestination
- An object that contains information about an event destination for
logging to Amazon SNS.
CreateEventDestination
, createEventDestination_configurationSetName
- Either the name of the configuration set or the configuration set ARN to
apply event logging to. The ConfigurateSetName and ConfigurationSetArn
can be found using the DescribeConfigurationSets action.
CreateEventDestination
, createEventDestination_eventDestinationName
- The name that identifies the event destination.
CreateEventDestination
, createEventDestination_matchingEventTypes
- An array of event types that determine which events to log. If "ALL"
is used, then Amazon Pinpoint logs every event type.
data CreateEventDestinationResponse Source #
See: newCreateEventDestinationResponse
smart constructor.
Instances
newCreateEventDestinationResponse Source #
Create a value of CreateEventDestinationResponse
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:
CreateEventDestinationResponse
, createEventDestinationResponse_configurationSetArn
- The ARN of the configuration set.
CreateEventDestination
, createEventDestinationResponse_configurationSetName
- The name of the configuration set.
$sel:eventDestination:CreateEventDestinationResponse'
, createEventDestinationResponse_eventDestination
- The details of the destination where events are logged.
$sel:httpStatus:CreateEventDestinationResponse'
, createEventDestinationResponse_httpStatus
- The response's http status code.
CreateOptOutList
data CreateOptOutList Source #
See: newCreateOptOutList
smart constructor.
Instances
Create a value of CreateOptOutList
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:clientToken:CreateOptOutList'
, createOptOutList_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
CreateOptOutList
, createOptOutList_tags
- An array of tags (key and value pairs) to associate with the new
OptOutList.
CreateOptOutList
, createOptOutList_optOutListName
- The name of the new OptOutList.
data CreateOptOutListResponse Source #
See: newCreateOptOutListResponse
smart constructor.
Instances
newCreateOptOutListResponse Source #
Create a value of CreateOptOutListResponse
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:
CreateOptOutListResponse
, createOptOutListResponse_createdTimestamp
- The time when the pool was created, in
UNIX epoch time format.
CreateOptOutListResponse
, createOptOutListResponse_optOutListArn
- The Amazon Resource Name (ARN) for the OptOutList.
CreateOptOutList
, createOptOutListResponse_optOutListName
- The name of the new OptOutList.
CreateOptOutList
, createOptOutListResponse_tags
- An array of tags (key and value pairs) associated with the new
OptOutList.
$sel:httpStatus:CreateOptOutListResponse'
, createOptOutListResponse_httpStatus
- The response's http status code.
CreatePool
data CreatePool Source #
See: newCreatePool
smart constructor.
CreatePool' (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Text MessageType |
Instances
Create a value of CreatePool
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:clientToken:CreatePool'
, createPool_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
CreatePool
, createPool_deletionProtectionEnabled
- By default this is set to false. When set to true the pool can't be
deleted. You can change this value using the UpdatePool action.
CreatePool
, createPool_tags
- An array of tags (key and value pairs) associated with the pool.
CreatePool
, createPool_originationIdentity
- The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can
be used to get the values for SenderId and SenderIdArn.
CreatePool
, createPool_isoCountryCode
- The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the new pool.
CreatePool
, createPool_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
data CreatePoolResponse Source #
See: newCreatePoolResponse
smart constructor.
CreatePoolResponse' (Maybe POSIX) (Maybe Bool) (Maybe MessageType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe PoolStatus) (Maybe [Tag]) (Maybe Text) (Maybe Bool) Int |
Instances
newCreatePoolResponse Source #
Create a value of CreatePoolResponse
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:
CreatePoolResponse
, createPoolResponse_createdTimestamp
- The time when the pool was created, in
UNIX epoch time format.
CreatePool
, createPoolResponse_deletionProtectionEnabled
- When set to true deletion protection is enabled. By default this is set
to false.
CreatePool
, createPoolResponse_messageType
- The type of message for the pool to use.
CreatePoolResponse
, createPoolResponse_optOutListName
- The name of the OptOutList associated with the pool.
CreatePoolResponse
, createPoolResponse_poolArn
- The Amazon Resource Name (ARN) for the pool.
CreatePoolResponse
, createPoolResponse_poolId
- The unique identifier for the pool.
CreatePoolResponse
, createPoolResponse_selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message
that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the
end recipient to the OptOutList. When set to true you're responsible
for responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests.
CreatePoolResponse
, createPoolResponse_sharedRoutesEnabled
- Indicates whether shared routes are enabled for the pool.
CreatePoolResponse
, createPoolResponse_status
- The current status of the pool.
- CREATING: The pool is currently being created and isn't yet available for use.
- ACTIVE: The pool is active and available for use.
- DELETING: The pool is being deleted.
CreatePool
, createPoolResponse_tags
- An array of tags (key and value pairs) associated with the pool.
CreatePoolResponse
, createPoolResponse_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
CreatePoolResponse
, createPoolResponse_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:CreatePoolResponse'
, createPoolResponse_httpStatus
- The response's http status code.
DeleteConfigurationSet
data DeleteConfigurationSet Source #
See: newDeleteConfigurationSet
smart constructor.
Instances
newDeleteConfigurationSet Source #
Create a value of DeleteConfigurationSet
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:
DeleteConfigurationSet
, deleteConfigurationSet_configurationSetName
- The name of the configuration set or the configuration set ARN that you
want to delete. The ConfigurationSetName and ConfigurationSetArn can be
found using the DescribeConfigurationSets action.
data DeleteConfigurationSetResponse Source #
See: newDeleteConfigurationSetResponse
smart constructor.
DeleteConfigurationSetResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MessageType) (Maybe Text) (Maybe [EventDestination]) Int |
Instances
newDeleteConfigurationSetResponse Source #
Create a value of DeleteConfigurationSetResponse
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:
DeleteConfigurationSetResponse
, deleteConfigurationSetResponse_configurationSetArn
- The Amazon Resource Name (ARN) of the deleted configuration set.
DeleteConfigurationSet
, deleteConfigurationSetResponse_configurationSetName
- The name of the deleted configuration set.
DeleteConfigurationSetResponse
, deleteConfigurationSetResponse_createdTimestamp
- The time that the deleted configuration set was created in
UNIX epoch time format.
DeleteConfigurationSetResponse
, deleteConfigurationSetResponse_defaultMessageType
- The default message type of the configuration set that was deleted.
DeleteConfigurationSetResponse
, deleteConfigurationSetResponse_defaultSenderId
- The default Sender ID of the configuration set that was deleted.
DeleteConfigurationSetResponse
, deleteConfigurationSetResponse_eventDestinations
- An array of any EventDestination objects that were associated with the
deleted configuration set.
$sel:httpStatus:DeleteConfigurationSetResponse'
, deleteConfigurationSetResponse_httpStatus
- The response's http status code.
DeleteDefaultMessageType
data DeleteDefaultMessageType Source #
See: newDeleteDefaultMessageType
smart constructor.
Instances
newDeleteDefaultMessageType Source #
Create a value of DeleteDefaultMessageType
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:
DeleteDefaultMessageType
, deleteDefaultMessageType_configurationSetName
- The name of the configuration set or the configuration set Amazon
Resource Name (ARN) to delete the default message type from. The
ConfigurationSetName and ConfigurationSetArn can be found using the
DescribeConfigurationSets action.
data DeleteDefaultMessageTypeResponse Source #
See: newDeleteDefaultMessageTypeResponse
smart constructor.
Instances
newDeleteDefaultMessageTypeResponse Source #
Create a value of DeleteDefaultMessageTypeResponse
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:
DeleteDefaultMessageTypeResponse
, deleteDefaultMessageTypeResponse_configurationSetArn
- The Amazon Resource Name (ARN) of the configuration set.
DeleteDefaultMessageType
, deleteDefaultMessageTypeResponse_configurationSetName
- The name of the configuration set.
DeleteDefaultMessageTypeResponse
, deleteDefaultMessageTypeResponse_messageType
- The current message type for the configuration set.
$sel:httpStatus:DeleteDefaultMessageTypeResponse'
, deleteDefaultMessageTypeResponse_httpStatus
- The response's http status code.
DeleteDefaultSenderId
data DeleteDefaultSenderId Source #
See: newDeleteDefaultSenderId
smart constructor.
Instances
newDeleteDefaultSenderId Source #
Create a value of DeleteDefaultSenderId
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:
DeleteDefaultSenderId
, deleteDefaultSenderId_configurationSetName
- The name of the configuration set or the configuration set Amazon
Resource Name (ARN) to delete the default sender ID from. The
ConfigurationSetName and ConfigurationSetArn can be found using the
DescribeConfigurationSets action.
data DeleteDefaultSenderIdResponse Source #
See: newDeleteDefaultSenderIdResponse
smart constructor.
Instances
newDeleteDefaultSenderIdResponse Source #
Create a value of DeleteDefaultSenderIdResponse
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:
DeleteDefaultSenderIdResponse
, deleteDefaultSenderIdResponse_configurationSetArn
- The Amazon Resource Name (ARN) of the configuration set.
DeleteDefaultSenderId
, deleteDefaultSenderIdResponse_configurationSetName
- The name of the configuration set.
DeleteDefaultSenderIdResponse
, deleteDefaultSenderIdResponse_senderId
- The current sender ID for the configuration set.
$sel:httpStatus:DeleteDefaultSenderIdResponse'
, deleteDefaultSenderIdResponse_httpStatus
- The response's http status code.
DeleteEventDestination
data DeleteEventDestination Source #
See: newDeleteEventDestination
smart constructor.
Instances
newDeleteEventDestination Source #
Create a value of DeleteEventDestination
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:
DeleteEventDestination
, deleteEventDestination_configurationSetName
- The name of the configuration set or the configuration set's Amazon
Resource Name (ARN) to remove the event destination from. The
ConfigurateSetName and ConfigurationSetArn can be found using the
DescribeConfigurationSets action.
DeleteEventDestination
, deleteEventDestination_eventDestinationName
- The name of the event destination to delete.
data DeleteEventDestinationResponse Source #
See: newDeleteEventDestinationResponse
smart constructor.
Instances
newDeleteEventDestinationResponse Source #
Create a value of DeleteEventDestinationResponse
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:
DeleteEventDestinationResponse
, deleteEventDestinationResponse_configurationSetArn
- The Amazon Resource Name (ARN) of the configuration set.
DeleteEventDestination
, deleteEventDestinationResponse_configurationSetName
- The name of the configuration set the event destination was deleted
from.
$sel:eventDestination:DeleteEventDestinationResponse'
, deleteEventDestinationResponse_eventDestination
- The event destination object that was deleted.
$sel:httpStatus:DeleteEventDestinationResponse'
, deleteEventDestinationResponse_httpStatus
- The response's http status code.
DeleteKeyword
data DeleteKeyword Source #
See: newDeleteKeyword
smart constructor.
Instances
Create a value of DeleteKeyword
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:
DeleteKeyword
, deleteKeyword_originationIdentity
- The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
PoolId or PoolArn. You can use DescribePhoneNumbers to find the values
for PhoneNumberId and PhoneNumberArn and DescribePools to find the
values of PoolId and PoolArn.
DeleteKeyword
, deleteKeyword_keyword
- The keyword to delete.
data DeleteKeywordResponse Source #
See: newDeleteKeywordResponse
smart constructor.
DeleteKeywordResponse' (Maybe Text) (Maybe KeywordAction) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDeleteKeywordResponse Source #
Create a value of DeleteKeywordResponse
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:
DeleteKeyword
, deleteKeywordResponse_keyword
- The keyword that was deleted.
DeleteKeywordResponse
, deleteKeywordResponse_keywordAction
- The action that was associated with the deleted keyword.
DeleteKeywordResponse
, deleteKeywordResponse_keywordMessage
- The message that was associated with the deleted keyword.
DeleteKeyword
, deleteKeywordResponse_originationIdentity
- The PhoneNumberId or PoolId that the keyword was associated with.
DeleteKeywordResponse
, deleteKeywordResponse_originationIdentityArn
- The PhoneNumberArn or PoolArn that the keyword was associated with.
$sel:httpStatus:DeleteKeywordResponse'
, deleteKeywordResponse_httpStatus
- The response's http status code.
DeleteOptOutList
data DeleteOptOutList Source #
See: newDeleteOptOutList
smart constructor.
Instances
Create a value of DeleteOptOutList
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:
DeleteOptOutList
, deleteOptOutList_optOutListName
- The OptOutListName or OptOutListArn of the OptOutList to delete. You can
use DescribeOptOutLists to find the values for OptOutListName and
OptOutListArn.
data DeleteOptOutListResponse Source #
See: newDeleteOptOutListResponse
smart constructor.
Instances
newDeleteOptOutListResponse Source #
Create a value of DeleteOptOutListResponse
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:
DeleteOptOutListResponse
, deleteOptOutListResponse_createdTimestamp
- The time when the OptOutList was created, in
UNIX epoch time format.
DeleteOptOutListResponse
, deleteOptOutListResponse_optOutListArn
- The Amazon Resource Name (ARN) of the OptOutList that was removed.
DeleteOptOutList
, deleteOptOutListResponse_optOutListName
- The name of the OptOutList that was removed.
$sel:httpStatus:DeleteOptOutListResponse'
, deleteOptOutListResponse_httpStatus
- The response's http status code.
DeleteOptedOutNumber
data DeleteOptedOutNumber Source #
See: newDeleteOptedOutNumber
smart constructor.
Instances
newDeleteOptedOutNumber Source #
Create a value of DeleteOptedOutNumber
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:
DeleteOptedOutNumber
, deleteOptedOutNumber_optOutListName
- The OptOutListName or OptOutListArn to remove the phone number from.
DeleteOptedOutNumber
, deleteOptedOutNumber_optedOutNumber
- The phone number, in E.164 format, to remove from the OptOutList.
data DeleteOptedOutNumberResponse Source #
See: newDeleteOptedOutNumberResponse
smart constructor.
Instances
newDeleteOptedOutNumberResponse Source #
Create a value of DeleteOptedOutNumberResponse
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:
DeleteOptedOutNumberResponse
, deleteOptedOutNumberResponse_endUserOptedOut
- This is true if it was the end user who requested their phone number be
removed.
DeleteOptedOutNumberResponse
, deleteOptedOutNumberResponse_optOutListArn
- The OptOutListArn that the phone number was removed from.
DeleteOptedOutNumber
, deleteOptedOutNumberResponse_optOutListName
- The OptOutListName that the phone number was removed from.
DeleteOptedOutNumber
, deleteOptedOutNumberResponse_optedOutNumber
- The phone number that was removed from the OptOutList.
DeleteOptedOutNumberResponse
, deleteOptedOutNumberResponse_optedOutTimestamp
- The time that the number was removed at, in
UNIX epoch time format.
$sel:httpStatus:DeleteOptedOutNumberResponse'
, deleteOptedOutNumberResponse_httpStatus
- The response's http status code.
DeletePool
data DeletePool Source #
See: newDeletePool
smart constructor.
Instances
:: Text | |
-> DeletePool |
Create a value of DeletePool
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:
DeletePool
, deletePool_poolId
- The PoolId or PoolArn of the pool to delete. You can use DescribePools
to find the values for PoolId and PoolArn .
data DeletePoolResponse Source #
See: newDeletePoolResponse
smart constructor.
DeletePoolResponse' (Maybe POSIX) (Maybe MessageType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe PoolStatus) (Maybe Text) (Maybe Bool) Int |
Instances
newDeletePoolResponse Source #
Create a value of DeletePoolResponse
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:
DeletePoolResponse
, deletePoolResponse_createdTimestamp
- The time when the pool was created, in
UNIX epoch time format.
DeletePoolResponse
, deletePoolResponse_messageType
- The message type that was associated with the deleted pool.
DeletePoolResponse
, deletePoolResponse_optOutListName
- The name of the OptOutList that was associated with the deleted pool.
DeletePoolResponse
, deletePoolResponse_poolArn
- The Amazon Resource Name (ARN) of the pool that was deleted.
DeletePool
, deletePoolResponse_poolId
- The PoolId of the pool that was deleted.
DeletePoolResponse
, deletePoolResponse_selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message
that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the
end recipient to the OptOutList. When set to true you're responsible
for responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests.
DeletePoolResponse
, deletePoolResponse_sharedRoutesEnabled
- Indicates whether shared routes are enabled for the pool.
DeletePoolResponse
, deletePoolResponse_status
- The current status of the pool.
- CREATING: The pool is currently being created and isn't yet available for use.
- ACTIVE: The pool is active and available for use.
- DELETING: The pool is being deleted.
DeletePoolResponse
, deletePoolResponse_twoWayChannelArn
- The Amazon Resource Name (ARN) of the TwoWayChannel.
DeletePoolResponse
, deletePoolResponse_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:DeletePoolResponse'
, deletePoolResponse_httpStatus
- The response's http status code.
DeleteTextMessageSpendLimitOverride
data DeleteTextMessageSpendLimitOverride Source #
See: newDeleteTextMessageSpendLimitOverride
smart constructor.
Instances
newDeleteTextMessageSpendLimitOverride :: DeleteTextMessageSpendLimitOverride Source #
Create a value of DeleteTextMessageSpendLimitOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DeleteTextMessageSpendLimitOverrideResponse Source #
See: newDeleteTextMessageSpendLimitOverrideResponse
smart constructor.
Instances
Generic DeleteTextMessageSpendLimitOverrideResponse Source # | |
Read DeleteTextMessageSpendLimitOverrideResponse Source # | |
Show DeleteTextMessageSpendLimitOverrideResponse Source # | |
NFData DeleteTextMessageSpendLimitOverrideResponse Source # | |
Eq DeleteTextMessageSpendLimitOverrideResponse Source # | |
type Rep DeleteTextMessageSpendLimitOverrideResponse Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.DeleteTextMessageSpendLimitOverride type Rep DeleteTextMessageSpendLimitOverrideResponse = D1 ('MetaData "DeleteTextMessageSpendLimitOverrideResponse" "Amazonka.PinpointSmsVoiceV2.DeleteTextMessageSpendLimitOverride" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DeleteTextMessageSpendLimitOverrideResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monthlyLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteTextMessageSpendLimitOverrideResponse Source #
:: Int |
|
-> DeleteTextMessageSpendLimitOverrideResponse |
Create a value of DeleteTextMessageSpendLimitOverrideResponse
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:monthlyLimit:DeleteTextMessageSpendLimitOverrideResponse'
, deleteTextMessageSpendLimitOverrideResponse_monthlyLimit
- The current monthly limit, in US dollars.
$sel:httpStatus:DeleteTextMessageSpendLimitOverrideResponse'
, deleteTextMessageSpendLimitOverrideResponse_httpStatus
- The response's http status code.
DeleteVoiceMessageSpendLimitOverride
data DeleteVoiceMessageSpendLimitOverride Source #
See: newDeleteVoiceMessageSpendLimitOverride
smart constructor.
Instances
newDeleteVoiceMessageSpendLimitOverride :: DeleteVoiceMessageSpendLimitOverride Source #
Create a value of DeleteVoiceMessageSpendLimitOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DeleteVoiceMessageSpendLimitOverrideResponse Source #
See: newDeleteVoiceMessageSpendLimitOverrideResponse
smart constructor.
Instances
Generic DeleteVoiceMessageSpendLimitOverrideResponse Source # | |
Read DeleteVoiceMessageSpendLimitOverrideResponse Source # | |
Show DeleteVoiceMessageSpendLimitOverrideResponse Source # | |
NFData DeleteVoiceMessageSpendLimitOverrideResponse Source # | |
Eq DeleteVoiceMessageSpendLimitOverrideResponse Source # | |
type Rep DeleteVoiceMessageSpendLimitOverrideResponse Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.DeleteVoiceMessageSpendLimitOverride type Rep DeleteVoiceMessageSpendLimitOverrideResponse = D1 ('MetaData "DeleteVoiceMessageSpendLimitOverrideResponse" "Amazonka.PinpointSmsVoiceV2.DeleteVoiceMessageSpendLimitOverride" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DeleteVoiceMessageSpendLimitOverrideResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monthlyLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteVoiceMessageSpendLimitOverrideResponse Source #
:: Int |
|
-> DeleteVoiceMessageSpendLimitOverrideResponse |
Create a value of DeleteVoiceMessageSpendLimitOverrideResponse
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:monthlyLimit:DeleteVoiceMessageSpendLimitOverrideResponse'
, deleteVoiceMessageSpendLimitOverrideResponse_monthlyLimit
- The current monthly limit, in US dollars.
$sel:httpStatus:DeleteVoiceMessageSpendLimitOverrideResponse'
, deleteVoiceMessageSpendLimitOverrideResponse_httpStatus
- The response's http status code.
DescribeAccountAttributes (Paginated)
data DescribeAccountAttributes Source #
See: newDescribeAccountAttributes
smart constructor.
Instances
newDescribeAccountAttributes :: DescribeAccountAttributes Source #
Create a value of DescribeAccountAttributes
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:maxResults:DescribeAccountAttributes'
, describeAccountAttributes_maxResults
- The maximum number of results to return per each request.
DescribeAccountAttributes
, describeAccountAttributes_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
data DescribeAccountAttributesResponse Source #
See: newDescribeAccountAttributesResponse
smart constructor.
Instances
newDescribeAccountAttributesResponse Source #
Create a value of DescribeAccountAttributesResponse
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:accountAttributes:DescribeAccountAttributesResponse'
, describeAccountAttributesResponse_accountAttributes
- An array of AccountAttributes objects.
DescribeAccountAttributes
, describeAccountAttributesResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:httpStatus:DescribeAccountAttributesResponse'
, describeAccountAttributesResponse_httpStatus
- The response's http status code.
DescribeAccountLimits (Paginated)
data DescribeAccountLimits Source #
See: newDescribeAccountLimits
smart constructor.
Instances
newDescribeAccountLimits :: DescribeAccountLimits Source #
Create a value of DescribeAccountLimits
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:maxResults:DescribeAccountLimits'
, describeAccountLimits_maxResults
- The maximum number of results to return per each request.
DescribeAccountLimits
, describeAccountLimits_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
data DescribeAccountLimitsResponse Source #
See: newDescribeAccountLimitsResponse
smart constructor.
Instances
newDescribeAccountLimitsResponse Source #
Create a value of DescribeAccountLimitsResponse
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:accountLimits:DescribeAccountLimitsResponse'
, describeAccountLimitsResponse_accountLimits
- An array of AccountLimit objects that show the current spend limits.
DescribeAccountLimits
, describeAccountLimitsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:httpStatus:DescribeAccountLimitsResponse'
, describeAccountLimitsResponse_httpStatus
- The response's http status code.
DescribeConfigurationSets (Paginated)
data DescribeConfigurationSets Source #
See: newDescribeConfigurationSets
smart constructor.
DescribeConfigurationSets' (Maybe [Text]) (Maybe [ConfigurationSetFilter]) (Maybe Natural) (Maybe Text) |
Instances
newDescribeConfigurationSets :: DescribeConfigurationSets Source #
Create a value of DescribeConfigurationSets
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:configurationSetNames:DescribeConfigurationSets'
, describeConfigurationSets_configurationSetNames
- An array of strings. Each element can be either a ConfigurationSetName
or ConfigurationSetArn.
$sel:filters:DescribeConfigurationSets'
, describeConfigurationSets_filters
- An array of filters to apply to the results that are returned.
$sel:maxResults:DescribeConfigurationSets'
, describeConfigurationSets_maxResults
- The maximum number of results to return per each request.
DescribeConfigurationSets
, describeConfigurationSets_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
data DescribeConfigurationSetsResponse Source #
See: newDescribeConfigurationSetsResponse
smart constructor.
Instances
newDescribeConfigurationSetsResponse Source #
Create a value of DescribeConfigurationSetsResponse
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:configurationSets:DescribeConfigurationSetsResponse'
, describeConfigurationSetsResponse_configurationSets
- An array of ConfigurationSets objects.
DescribeConfigurationSets
, describeConfigurationSetsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:httpStatus:DescribeConfigurationSetsResponse'
, describeConfigurationSetsResponse_httpStatus
- The response's http status code.
DescribeKeywords (Paginated)
data DescribeKeywords Source #
See: newDescribeKeywords
smart constructor.
DescribeKeywords' (Maybe [KeywordFilter]) (Maybe [Text]) (Maybe Natural) (Maybe Text) Text |
Instances
Create a value of DescribeKeywords
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:filters:DescribeKeywords'
, describeKeywords_filters
- An array of keyword filters to filter the results.
DescribeKeywords
, describeKeywords_keywords
- An array of keywords to search for.
$sel:maxResults:DescribeKeywords'
, describeKeywords_maxResults
- The maximum number of results to return per each request.
DescribeKeywords
, describeKeywords_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
DescribeKeywords
, describeKeywords_originationIdentity
- The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can
be used to get the values for SenderId and SenderIdArn.
data DescribeKeywordsResponse Source #
See: newDescribeKeywordsResponse
smart constructor.
Instances
newDescribeKeywordsResponse Source #
Create a value of DescribeKeywordsResponse
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:
DescribeKeywords
, describeKeywordsResponse_keywords
- An array of KeywordInformation objects that contain the results.
DescribeKeywords
, describeKeywordsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
DescribeKeywords
, describeKeywordsResponse_originationIdentity
- The PhoneNumberId or PoolId that is associated with the
OriginationIdentity.
DescribeKeywordsResponse
, describeKeywordsResponse_originationIdentityArn
- The PhoneNumberArn or PoolArn that is associated with the
OriginationIdentity.
$sel:httpStatus:DescribeKeywordsResponse'
, describeKeywordsResponse_httpStatus
- The response's http status code.
DescribeOptOutLists (Paginated)
data DescribeOptOutLists Source #
See: newDescribeOptOutLists
smart constructor.
Instances
newDescribeOptOutLists :: DescribeOptOutLists Source #
Create a value of DescribeOptOutLists
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:maxResults:DescribeOptOutLists'
, describeOptOutLists_maxResults
- The maximum number of results to return per each request.
DescribeOptOutLists
, describeOptOutLists_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
$sel:optOutListNames:DescribeOptOutLists'
, describeOptOutLists_optOutListNames
- The OptOutLists to show the details of. This is an array of strings that
can be either the OptOutListName or OptOutListArn.
data DescribeOptOutListsResponse Source #
See: newDescribeOptOutListsResponse
smart constructor.
Instances
newDescribeOptOutListsResponse Source #
Create a value of DescribeOptOutListsResponse
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:
DescribeOptOutLists
, describeOptOutListsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:optOutLists:DescribeOptOutListsResponse'
, describeOptOutListsResponse_optOutLists
- An array of OptOutListInformation objects that contain the details for
the requested OptOutLists.
$sel:httpStatus:DescribeOptOutListsResponse'
, describeOptOutListsResponse_httpStatus
- The response's http status code.
DescribeOptedOutNumbers (Paginated)
data DescribeOptedOutNumbers Source #
See: newDescribeOptedOutNumbers
smart constructor.
DescribeOptedOutNumbers' (Maybe [OptedOutFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) Text |
Instances
newDescribeOptedOutNumbers Source #
Create a value of DescribeOptedOutNumbers
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:filters:DescribeOptedOutNumbers'
, describeOptedOutNumbers_filters
- An array of OptedOutFilter objects to filter the results on.
$sel:maxResults:DescribeOptedOutNumbers'
, describeOptedOutNumbers_maxResults
- The maximum number of results to return per each request.
DescribeOptedOutNumbers
, describeOptedOutNumbers_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
DescribeOptedOutNumbers
, describeOptedOutNumbers_optedOutNumbers
- An array of phone numbers to search for in the OptOutList.
DescribeOptedOutNumbers
, describeOptedOutNumbers_optOutListName
- The OptOutListName or OptOutListArn of the OptOutList. You can use
DescribeOptOutLists to find the values for OptOutListName and
OptOutListArn.
data DescribeOptedOutNumbersResponse Source #
See: newDescribeOptedOutNumbersResponse
smart constructor.
DescribeOptedOutNumbersResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [OptedOutNumberInformation]) Int |
Instances
newDescribeOptedOutNumbersResponse Source #
Create a value of DescribeOptedOutNumbersResponse
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:
DescribeOptedOutNumbers
, describeOptedOutNumbersResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
DescribeOptedOutNumbersResponse
, describeOptedOutNumbersResponse_optOutListArn
- The Amazon Resource Name (ARN) of the OptOutList.
DescribeOptedOutNumbers
, describeOptedOutNumbersResponse_optOutListName
- The name of the OptOutList.
DescribeOptedOutNumbers
, describeOptedOutNumbersResponse_optedOutNumbers
- An array of OptedOutNumbersInformation objects that provide information
about the requested OptedOutNumbers.
$sel:httpStatus:DescribeOptedOutNumbersResponse'
, describeOptedOutNumbersResponse_httpStatus
- The response's http status code.
DescribePhoneNumbers (Paginated)
data DescribePhoneNumbers Source #
See: newDescribePhoneNumbers
smart constructor.
DescribePhoneNumbers' (Maybe [PhoneNumberFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) |
Instances
newDescribePhoneNumbers :: DescribePhoneNumbers Source #
Create a value of DescribePhoneNumbers
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:filters:DescribePhoneNumbers'
, describePhoneNumbers_filters
- An array of PhoneNumberFilter objects to filter the results.
$sel:maxResults:DescribePhoneNumbers'
, describePhoneNumbers_maxResults
- The maximum number of results to return per each request.
DescribePhoneNumbers
, describePhoneNumbers_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
$sel:phoneNumberIds:DescribePhoneNumbers'
, describePhoneNumbers_phoneNumberIds
- The unique identifier of phone numbers to find information about. This
is an array of strings that can be either the PhoneNumberId or
PhoneNumberArn.
data DescribePhoneNumbersResponse Source #
See: newDescribePhoneNumbersResponse
smart constructor.
Instances
newDescribePhoneNumbersResponse Source #
Create a value of DescribePhoneNumbersResponse
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:
DescribePhoneNumbers
, describePhoneNumbersResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:phoneNumbers:DescribePhoneNumbersResponse'
, describePhoneNumbersResponse_phoneNumbers
- An array of PhoneNumberInformation objects that contain the details for
the requested phone numbers.
$sel:httpStatus:DescribePhoneNumbersResponse'
, describePhoneNumbersResponse_httpStatus
- The response's http status code.
DescribePools (Paginated)
data DescribePools Source #
See: newDescribePools
smart constructor.
DescribePools' (Maybe [PoolFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) |
Instances
newDescribePools :: DescribePools Source #
Create a value of DescribePools
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:filters:DescribePools'
, describePools_filters
- An array of PoolFilter objects to filter the results.
$sel:maxResults:DescribePools'
, describePools_maxResults
- The maximum number of results to return per each request.
DescribePools
, describePools_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
$sel:poolIds:DescribePools'
, describePools_poolIds
- The unique identifier of pools to find. This is an array of strings that
can be either the PoolId or PoolArn.
data DescribePoolsResponse Source #
See: newDescribePoolsResponse
smart constructor.
Instances
newDescribePoolsResponse Source #
Create a value of DescribePoolsResponse
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:
DescribePools
, describePoolsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:pools:DescribePoolsResponse'
, describePoolsResponse_pools
- An array of PoolInformation objects that contain the details for the
requested pools.
$sel:httpStatus:DescribePoolsResponse'
, describePoolsResponse_httpStatus
- The response's http status code.
DescribeSenderIds (Paginated)
data DescribeSenderIds Source #
See: newDescribeSenderIds
smart constructor.
DescribeSenderIds' (Maybe [SenderIdFilter]) (Maybe Natural) (Maybe Text) (Maybe [SenderIdAndCountry]) |
Instances
newDescribeSenderIds :: DescribeSenderIds Source #
Create a value of DescribeSenderIds
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:filters:DescribeSenderIds'
, describeSenderIds_filters
- An array of SenderIdFilter objects to filter the results.
$sel:maxResults:DescribeSenderIds'
, describeSenderIds_maxResults
- The maximum number of results to return per each request.
DescribeSenderIds
, describeSenderIds_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
DescribeSenderIds
, describeSenderIds_senderIds
- An array of SenderIdAndCountry objects to search for.
data DescribeSenderIdsResponse Source #
See: newDescribeSenderIdsResponse
smart constructor.
Instances
newDescribeSenderIdsResponse Source #
Create a value of DescribeSenderIdsResponse
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:
DescribeSenderIds
, describeSenderIdsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
DescribeSenderIds
, describeSenderIdsResponse_senderIds
- An array of SernderIdInformation objects that contain the details for
the requested SenderIds.
$sel:httpStatus:DescribeSenderIdsResponse'
, describeSenderIdsResponse_httpStatus
- The response's http status code.
DescribeSpendLimits (Paginated)
data DescribeSpendLimits Source #
See: newDescribeSpendLimits
smart constructor.
Instances
newDescribeSpendLimits :: DescribeSpendLimits Source #
Create a value of DescribeSpendLimits
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:maxResults:DescribeSpendLimits'
, describeSpendLimits_maxResults
- The maximum number of results to return per each request.
DescribeSpendLimits
, describeSpendLimits_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
data DescribeSpendLimitsResponse Source #
See: newDescribeSpendLimitsResponse
smart constructor.
Instances
newDescribeSpendLimitsResponse Source #
Create a value of DescribeSpendLimitsResponse
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:
DescribeSpendLimits
, describeSpendLimitsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:spendLimits:DescribeSpendLimitsResponse'
, describeSpendLimitsResponse_spendLimits
- An array of SpendLimit objects that contain the details for the
requested spend limits.
$sel:httpStatus:DescribeSpendLimitsResponse'
, describeSpendLimitsResponse_httpStatus
- The response's http status code.
DisassociateOriginationIdentity
data DisassociateOriginationIdentity Source #
See: newDisassociateOriginationIdentity
smart constructor.
Instances
newDisassociateOriginationIdentity Source #
:: Text | |
-> Text | |
-> Text | |
-> DisassociateOriginationIdentity |
Create a value of DisassociateOriginationIdentity
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:clientToken:DisassociateOriginationIdentity'
, disassociateOriginationIdentity_clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency
of the request. If you don't specify a client token, a randomly
generated token is used for the request to ensure idempotency.
DisassociateOriginationIdentity
, disassociateOriginationIdentity_poolId
- The unique identifier for the pool to disassociate with the origination
identity. This value can be either the PoolId or PoolArn.
DisassociateOriginationIdentity
, disassociateOriginationIdentity_originationIdentity
- The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
SenderId or SenderIdArn. You can use DescribePhoneNumbers find the
values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to
get the values for SenderId and SenderIdArn.
DisassociateOriginationIdentity
, disassociateOriginationIdentity_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
data DisassociateOriginationIdentityResponse Source #
See: newDisassociateOriginationIdentityResponse
smart constructor.
DisassociateOriginationIdentityResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDisassociateOriginationIdentityResponse Source #
Create a value of DisassociateOriginationIdentityResponse
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:
DisassociateOriginationIdentity
, disassociateOriginationIdentityResponse_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
DisassociateOriginationIdentity
, disassociateOriginationIdentityResponse_originationIdentity
- The PhoneNumberId or SenderId of the origination identity.
DisassociateOriginationIdentityResponse
, disassociateOriginationIdentityResponse_originationIdentityArn
- The PhoneNumberArn or SenderIdArn of the origination identity.
DisassociateOriginationIdentityResponse
, disassociateOriginationIdentityResponse_poolArn
- The Amazon Resource Name (ARN) of the pool.
DisassociateOriginationIdentity
, disassociateOriginationIdentityResponse_poolId
- The PoolId of the pool no longer associated with the origination
identity.
$sel:httpStatus:DisassociateOriginationIdentityResponse'
, disassociateOriginationIdentityResponse_httpStatus
- The response's http status code.
ListPoolOriginationIdentities (Paginated)
data ListPoolOriginationIdentities Source #
See: newListPoolOriginationIdentities
smart constructor.
ListPoolOriginationIdentities' (Maybe [PoolOriginationIdentitiesFilter]) (Maybe Natural) (Maybe Text) Text |
Instances
newListPoolOriginationIdentities Source #
Create a value of ListPoolOriginationIdentities
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:filters:ListPoolOriginationIdentities'
, listPoolOriginationIdentities_filters
- An array of PoolOriginationIdentitiesFilter objects to filter the
results..
$sel:maxResults:ListPoolOriginationIdentities'
, listPoolOriginationIdentities_maxResults
- The maximum number of results to return per each request.
ListPoolOriginationIdentities
, listPoolOriginationIdentities_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
ListPoolOriginationIdentities
, listPoolOriginationIdentities_poolId
- The unique identifier for the pool. This value can be either the PoolId
or PoolArn.
data ListPoolOriginationIdentitiesResponse Source #
See: newListPoolOriginationIdentitiesResponse
smart constructor.
ListPoolOriginationIdentitiesResponse' (Maybe Text) (Maybe [OriginationIdentityMetadata]) (Maybe Text) (Maybe Text) Int |
Instances
newListPoolOriginationIdentitiesResponse Source #
Create a value of ListPoolOriginationIdentitiesResponse
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:
ListPoolOriginationIdentities
, listPoolOriginationIdentitiesResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:originationIdentities:ListPoolOriginationIdentitiesResponse'
, listPoolOriginationIdentitiesResponse_originationIdentities
- An array of any OriginationIdentityMetadata objects.
ListPoolOriginationIdentitiesResponse
, listPoolOriginationIdentitiesResponse_poolArn
- The Amazon Resource Name (ARN) for the pool.
ListPoolOriginationIdentities
, listPoolOriginationIdentitiesResponse_poolId
- The unique PoolId of the pool.
$sel:httpStatus:ListPoolOriginationIdentitiesResponse'
, listPoolOriginationIdentitiesResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
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:
ListTagsForResource
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the resource to query for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
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:
ListTagsForResource
, listTagsForResourceResponse_resourceArn
- The ARN of the resource.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- An array of key and value pair tags that are associated with the
resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutKeyword
data PutKeyword Source #
See: newPutKeyword
smart constructor.
Instances
Create a value of PutKeyword
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:
PutKeyword
, putKeyword_keywordAction
- The action to perform for the new keyword when it is received.
PutKeyword
, putKeyword_originationIdentity
- The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values
for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used
to get the values for SenderId and SenderIdArn.
PutKeyword
, putKeyword_keyword
- The new keyword to add.
PutKeyword
, putKeyword_keywordMessage
- The message associated with the keyword.
- AUTOMATIC_RESPONSE: A message is sent to the recipient.
- OPT_OUT: Keeps the recipient from receiving future messages.
- OPT_IN: The recipient wants to receive future messages.
data PutKeywordResponse Source #
See: newPutKeywordResponse
smart constructor.
Instances
newPutKeywordResponse Source #
Create a value of PutKeywordResponse
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:
PutKeyword
, putKeywordResponse_keyword
- The keyword that was added.
PutKeyword
, putKeywordResponse_keywordAction
- The action to perform when the keyword is used.
PutKeyword
, putKeywordResponse_keywordMessage
- The message associated with the keyword.
PutKeyword
, putKeywordResponse_originationIdentity
- The PhoneNumberId or PoolId that the keyword was associated with.
PutKeywordResponse
, putKeywordResponse_originationIdentityArn
- The PhoneNumberArn or PoolArn that the keyword was associated with.
$sel:httpStatus:PutKeywordResponse'
, putKeywordResponse_httpStatus
- The response's http status code.
PutOptedOutNumber
data PutOptedOutNumber Source #
See: newPutOptedOutNumber
smart constructor.
Instances
Create a value of PutOptedOutNumber
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:
PutOptedOutNumber
, putOptedOutNumber_optOutListName
- The OptOutListName or OptOutListArn to add the phone number to.
PutOptedOutNumber
, putOptedOutNumber_optedOutNumber
- The phone number to add to the OptOutList in E.164 format.
data PutOptedOutNumberResponse Source #
See: newPutOptedOutNumberResponse
smart constructor.
Instances
newPutOptedOutNumberResponse Source #
Create a value of PutOptedOutNumberResponse
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:
PutOptedOutNumberResponse
, putOptedOutNumberResponse_endUserOptedOut
- This is true if it was the end user who requested their phone number be
removed.
PutOptedOutNumberResponse
, putOptedOutNumberResponse_optOutListArn
- The OptOutListArn that the phone number was removed from.
PutOptedOutNumber
, putOptedOutNumberResponse_optOutListName
- The OptOutListName that the phone number was removed from.
PutOptedOutNumber
, putOptedOutNumberResponse_optedOutNumber
- The phone number that was added to the OptOutList.
PutOptedOutNumberResponse
, putOptedOutNumberResponse_optedOutTimestamp
- The time that the phone number was added to the OptOutList, in
UNIX epoch time format.
$sel:httpStatus:PutOptedOutNumberResponse'
, putOptedOutNumberResponse_httpStatus
- The response's http status code.
ReleasePhoneNumber
data ReleasePhoneNumber Source #
See: newReleasePhoneNumber
smart constructor.
Instances
newReleasePhoneNumber Source #
Create a value of ReleasePhoneNumber
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:
ReleasePhoneNumber
, releasePhoneNumber_phoneNumberId
- The PhoneNumberId or PhoneNumberArn of the phone number to release. You
can use DescribePhoneNumbers to get the values for PhoneNumberId and
PhoneNumberArn.
data ReleasePhoneNumberResponse Source #
See: newReleasePhoneNumberResponse
smart constructor.
ReleasePhoneNumberResponse' (Maybe POSIX) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe (NonEmpty NumberCapability)) (Maybe NumberType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NumberStatus) (Maybe Text) (Maybe Bool) Int |
Instances
newReleasePhoneNumberResponse Source #
Create a value of ReleasePhoneNumberResponse
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:
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_createdTimestamp
- The time when the phone number was created, in
UNIX epoch time format.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_messageType
- The message type that was associated with the phone number.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_monthlyLeasingPrice
- The monthly price of the phone number, in US dollars.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_numberCapabilities
- Specifies if the number could be used for text messages, voice, or both.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_numberType
- The type of number that was released.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_optOutListName
- The name of the OptOutList that was associated with the phone number.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_phoneNumber
- The phone number that was released.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_phoneNumberArn
- The PhoneNumberArn of the phone number that was released.
ReleasePhoneNumber
, releasePhoneNumberResponse_phoneNumberId
- The PhoneNumberId of the phone number that was released.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message
that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the
end recipient to the OptOutList. When set to true you're responsible
for responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_status
- The current status of the request.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_twoWayChannelArn
- The Amazon Resource Name (ARN) of the TwoWayChannel.
ReleasePhoneNumberResponse
, releasePhoneNumberResponse_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:ReleasePhoneNumberResponse'
, releasePhoneNumberResponse_httpStatus
- The response's http status code.
RequestPhoneNumber
data RequestPhoneNumber Source #
See: newRequestPhoneNumber
smart constructor.
RequestPhoneNumber' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text MessageType (NonEmpty NumberCapability) RequestableNumberType |
Instances
newRequestPhoneNumber Source #
Create a value of RequestPhoneNumber
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:clientToken:RequestPhoneNumber'
, requestPhoneNumber_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
RequestPhoneNumber
, requestPhoneNumber_deletionProtectionEnabled
- By default this is set to false. When set to true the phone number
can't be deleted.
RequestPhoneNumber
, requestPhoneNumber_optOutListName
- The name of the OptOutList to associate with the phone number. You can
use the OutOutListName or OptPutListArn.
RequestPhoneNumber
, requestPhoneNumber_poolId
- The pool to associated with the phone number. You can use the PoolId or
PoolArn.
$sel:registrationId:RequestPhoneNumber'
, requestPhoneNumber_registrationId
- Use this field to attach your phone number for an external registration
process.
RequestPhoneNumber
, requestPhoneNumber_tags
- An array of tags (key and value pairs) associate with the requested
phone number.
RequestPhoneNumber
, requestPhoneNumber_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
RequestPhoneNumber
, requestPhoneNumber_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
RequestPhoneNumber
, requestPhoneNumber_numberCapabilities
- Indicates if the phone number will be used for text messages, voice
messages, or both.
RequestPhoneNumber
, requestPhoneNumber_numberType
- The type of phone number to request.
data RequestPhoneNumberResponse Source #
See: newRequestPhoneNumberResponse
smart constructor.
RequestPhoneNumberResponse' (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe (NonEmpty NumberCapability)) (Maybe RequestableNumberType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NumberStatus) (Maybe [Tag]) (Maybe Text) (Maybe Bool) Int |
Instances
newRequestPhoneNumberResponse Source #
Create a value of RequestPhoneNumberResponse
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:
RequestPhoneNumberResponse
, requestPhoneNumberResponse_createdTimestamp
- The time when the phone number was created, in
UNIX epoch time format.
RequestPhoneNumber
, requestPhoneNumberResponse_deletionProtectionEnabled
- By default this is set to false. When set to true the phone number
can't be deleted.
RequestPhoneNumber
, requestPhoneNumberResponse_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
RequestPhoneNumber
, requestPhoneNumberResponse_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
RequestPhoneNumberResponse
, requestPhoneNumberResponse_monthlyLeasingPrice
- The monthly price, in US dollars, to lease the phone number.
RequestPhoneNumber
, requestPhoneNumberResponse_numberCapabilities
- Indicates if the phone number will be used for text messages, voice
messages or both.
RequestPhoneNumber
, requestPhoneNumberResponse_numberType
- The type of number that was released.
RequestPhoneNumber
, requestPhoneNumberResponse_optOutListName
- The name of the OptOutList that is associated with the requested phone
number.
RequestPhoneNumberResponse
, requestPhoneNumberResponse_phoneNumber
- The new phone number that was requested.
RequestPhoneNumberResponse
, requestPhoneNumberResponse_phoneNumberArn
- The Amazon Resource Name (ARN) of the requested phone number.
RequestPhoneNumberResponse
, requestPhoneNumberResponse_phoneNumberId
- The unique identifier of the new phone number.
RequestPhoneNumber
, requestPhoneNumberResponse_poolId
- The unique identifier of the pool associated with the phone number
RequestPhoneNumberResponse
, requestPhoneNumberResponse_selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message
that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the
end recipient to the OptOutList. When set to true you're responsible
for responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests.
RequestPhoneNumberResponse
, requestPhoneNumberResponse_status
- The current status of the request.
RequestPhoneNumber
, requestPhoneNumberResponse_tags
- An array of key and value pair tags that are associated with the phone
number.
RequestPhoneNumberResponse
, requestPhoneNumberResponse_twoWayChannelArn
- The ARN used to identify the two way channel.
RequestPhoneNumberResponse
, requestPhoneNumberResponse_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:RequestPhoneNumberResponse'
, requestPhoneNumberResponse_httpStatus
- The response's http status code.
SendTextMessage
data SendTextMessage Source #
See: newSendTextMessage
smart constructor.
SendTextMessage' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap DestinationCountryParameterKey Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe Natural) Text |
Instances
Create a value of SendTextMessage
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:
SendTextMessage
, sendTextMessage_configurationSetName
- The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
$sel:context:SendTextMessage'
, sendTextMessage_context
- You can specify custom data in this field. If you do, that data is
logged to the event destination.
$sel:destinationCountryParameters:SendTextMessage'
, sendTextMessage_destinationCountryParameters
- This field is used for any country-specific registration requirements.
Currently, this setting is only used when you send messages to
recipients in India using a sender ID. For more information see
Special requirements for sending SMS messages to recipients in India.
$sel:dryRun:SendTextMessage'
, sendTextMessage_dryRun
- When set to true, the message is checked and validated, but isn't sent
to the end recipient.
SendTextMessage
, sendTextMessage_keyword
- When you register a short code in the US, you must specify a program
name. If you don’t have a US short code, omit this attribute.
$sel:maxPrice:SendTextMessage'
, sendTextMessage_maxPrice
- The maximum amount that you want to spend, in US dollars, per each text
message part. A text message can contain multiple parts.
$sel:messageBody:SendTextMessage'
, sendTextMessage_messageBody
- The body of the text message.
SendTextMessage
, sendTextMessage_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
SendTextMessage
, sendTextMessage_originationIdentity
- The origination identity of the message. This can be either the
PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
PoolId, or PoolArn.
$sel:timeToLive:SendTextMessage'
, sendTextMessage_timeToLive
- How long the text message is valid for. By default this is 72 hours.
$sel:destinationPhoneNumber:SendTextMessage'
, sendTextMessage_destinationPhoneNumber
- The destination phone number in E.164 format.
data SendTextMessageResponse Source #
See: newSendTextMessageResponse
smart constructor.
Instances
newSendTextMessageResponse Source #
Create a value of SendTextMessageResponse
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:messageId:SendTextMessageResponse'
, sendTextMessageResponse_messageId
- The unique identifier for the message.
$sel:httpStatus:SendTextMessageResponse'
, sendTextMessageResponse_httpStatus
- The response's http status code.
SendVoiceMessage
data SendVoiceMessage Source #
See: newSendVoiceMessage
smart constructor.
SendVoiceMessage' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe VoiceMessageBodyTextType) (Maybe Natural) (Maybe VoiceId) Text Text |
Instances
Create a value of SendVoiceMessage
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:
SendVoiceMessage
, sendVoiceMessage_configurationSetName
- The name of the configuration set to use. This can be either the
ConfigurationSetName or ConfigurationSetArn.
$sel:context:SendVoiceMessage'
, sendVoiceMessage_context
- You can specify custom data in this field. If you do, that data is
logged to the event destination.
$sel:dryRun:SendVoiceMessage'
, sendVoiceMessage_dryRun
- When set to true, the message is checked and validated, but isn't sent
to the end recipient.
$sel:maxPricePerMinute:SendVoiceMessage'
, sendVoiceMessage_maxPricePerMinute
- The maximum amount to spend per voice message, in US dollars.
$sel:messageBody:SendVoiceMessage'
, sendVoiceMessage_messageBody
- The text to convert to a voice message.
$sel:messageBodyTextType:SendVoiceMessage'
, sendVoiceMessage_messageBodyTextType
- Specifies if the MessageBody field contains text or
speech synthesis markup language (SSML).
- TEXT: This is the default value. When used the maximum character limit is 3000.
- SSML: When used the maximum character limit is 6000 including SSML tagging.
$sel:timeToLive:SendVoiceMessage'
, sendVoiceMessage_timeToLive
- How long the voice message is valid for. By default this is 72 hours.
$sel:voiceId:SendVoiceMessage'
, sendVoiceMessage_voiceId
- The voice for the
Amazon Polly
service to use. By default this is set to "MATTHEW".
$sel:destinationPhoneNumber:SendVoiceMessage'
, sendVoiceMessage_destinationPhoneNumber
- The destination phone number in E.164 format.
SendVoiceMessage
, sendVoiceMessage_originationIdentity
- The origination identity to use for the voice call. This can be the
PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
data SendVoiceMessageResponse Source #
See: newSendVoiceMessageResponse
smart constructor.
Instances
newSendVoiceMessageResponse Source #
Create a value of SendVoiceMessageResponse
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:messageId:SendVoiceMessageResponse'
, sendVoiceMessageResponse_messageId
- The unique identifier for the message.
$sel:httpStatus:SendVoiceMessageResponse'
, sendVoiceMessageResponse_httpStatus
- The response's http status code.
SetDefaultMessageType
data SetDefaultMessageType Source #
See: newSetDefaultMessageType
smart constructor.
Instances
newSetDefaultMessageType Source #
Create a value of SetDefaultMessageType
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:
SetDefaultMessageType
, setDefaultMessageType_configurationSetName
- The configuration set to update with a new default message type. This
field can be the ConsigurationSetName or ConfigurationSetArn.
SetDefaultMessageType
, setDefaultMessageType_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
data SetDefaultMessageTypeResponse Source #
See: newSetDefaultMessageTypeResponse
smart constructor.
Instances
newSetDefaultMessageTypeResponse Source #
Create a value of SetDefaultMessageTypeResponse
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:
SetDefaultMessageTypeResponse
, setDefaultMessageTypeResponse_configurationSetArn
- The Amazon Resource Name (ARN) of the updated configuration set.
SetDefaultMessageType
, setDefaultMessageTypeResponse_configurationSetName
- The name of the configuration set that was updated.
SetDefaultMessageType
, setDefaultMessageTypeResponse_messageType
- The new default message type of the configuration set.
$sel:httpStatus:SetDefaultMessageTypeResponse'
, setDefaultMessageTypeResponse_httpStatus
- The response's http status code.
SetDefaultSenderId
data SetDefaultSenderId Source #
See: newSetDefaultSenderId
smart constructor.
Instances
newSetDefaultSenderId Source #
Create a value of SetDefaultSenderId
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:
SetDefaultSenderId
, setDefaultSenderId_configurationSetName
- The configuration set to updated with a new default SenderId. This field
can be the ConsigurationSetName or ConfigurationSetArn.
SetDefaultSenderId
, setDefaultSenderId_senderId
- The current sender ID for the configuration set. When sending a text
message to a destination country which supports SenderIds, the default
sender ID on the configuration set specified on SendTextMessage will be
used if no dedicated origination phone numbers or registered SenderIds
are available in your account, instead of a generic sender ID, such as
'NOTICE'.
data SetDefaultSenderIdResponse Source #
See: newSetDefaultSenderIdResponse
smart constructor.
Instances
newSetDefaultSenderIdResponse Source #
Create a value of SetDefaultSenderIdResponse
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:
SetDefaultSenderIdResponse
, setDefaultSenderIdResponse_configurationSetArn
- The Amazon Resource Name (ARN) of the updated configuration set.
SetDefaultSenderId
, setDefaultSenderIdResponse_configurationSetName
- The name of the configuration set that was updated.
SetDefaultSenderId
, setDefaultSenderIdResponse_senderId
- The default sender ID to set for the ConfigurationSet.
$sel:httpStatus:SetDefaultSenderIdResponse'
, setDefaultSenderIdResponse_httpStatus
- The response's http status code.
SetTextMessageSpendLimitOverride
data SetTextMessageSpendLimitOverride Source #
See: newSetTextMessageSpendLimitOverride
smart constructor.
Instances
newSetTextMessageSpendLimitOverride Source #
Create a value of SetTextMessageSpendLimitOverride
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:
SetTextMessageSpendLimitOverride
, setTextMessageSpendLimitOverride_monthlyLimit
- The new monthly limit to enforce on text messages.
data SetTextMessageSpendLimitOverrideResponse Source #
See: newSetTextMessageSpendLimitOverrideResponse
smart constructor.
Instances
Generic SetTextMessageSpendLimitOverrideResponse Source # | |
Read SetTextMessageSpendLimitOverrideResponse Source # | |
Show SetTextMessageSpendLimitOverrideResponse Source # | |
NFData SetTextMessageSpendLimitOverrideResponse Source # | |
Eq SetTextMessageSpendLimitOverrideResponse Source # | |
type Rep SetTextMessageSpendLimitOverrideResponse Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.SetTextMessageSpendLimitOverride type Rep SetTextMessageSpendLimitOverrideResponse = D1 ('MetaData "SetTextMessageSpendLimitOverrideResponse" "Amazonka.PinpointSmsVoiceV2.SetTextMessageSpendLimitOverride" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "SetTextMessageSpendLimitOverrideResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monthlyLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newSetTextMessageSpendLimitOverrideResponse Source #
Create a value of SetTextMessageSpendLimitOverrideResponse
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:
SetTextMessageSpendLimitOverride
, setTextMessageSpendLimitOverrideResponse_monthlyLimit
- The current monthly limit to enforce on sending text messages.
$sel:httpStatus:SetTextMessageSpendLimitOverrideResponse'
, setTextMessageSpendLimitOverrideResponse_httpStatus
- The response's http status code.
SetVoiceMessageSpendLimitOverride
data SetVoiceMessageSpendLimitOverride Source #
See: newSetVoiceMessageSpendLimitOverride
smart constructor.
Instances
newSetVoiceMessageSpendLimitOverride Source #
Create a value of SetVoiceMessageSpendLimitOverride
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:
SetVoiceMessageSpendLimitOverride
, setVoiceMessageSpendLimitOverride_monthlyLimit
- The new monthly limit to enforce on voice messages.
data SetVoiceMessageSpendLimitOverrideResponse Source #
See: newSetVoiceMessageSpendLimitOverrideResponse
smart constructor.
Instances
Generic SetVoiceMessageSpendLimitOverrideResponse Source # | |
Read SetVoiceMessageSpendLimitOverrideResponse Source # | |
Show SetVoiceMessageSpendLimitOverrideResponse Source # | |
NFData SetVoiceMessageSpendLimitOverrideResponse Source # | |
Eq SetVoiceMessageSpendLimitOverrideResponse Source # | |
type Rep SetVoiceMessageSpendLimitOverrideResponse Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.SetVoiceMessageSpendLimitOverride type Rep SetVoiceMessageSpendLimitOverrideResponse = D1 ('MetaData "SetVoiceMessageSpendLimitOverrideResponse" "Amazonka.PinpointSmsVoiceV2.SetVoiceMessageSpendLimitOverride" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "SetVoiceMessageSpendLimitOverrideResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monthlyLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newSetVoiceMessageSpendLimitOverrideResponse Source #
Create a value of SetVoiceMessageSpendLimitOverrideResponse
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:
SetVoiceMessageSpendLimitOverride
, setVoiceMessageSpendLimitOverrideResponse_monthlyLimit
- The current monthly limit to enforce on sending voice messages.
$sel:httpStatus:SetVoiceMessageSpendLimitOverrideResponse'
, setVoiceMessageSpendLimitOverrideResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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 Amazon Resource Name (ARN) of the resource.
$sel:tags:TagResource'
, tagResource_tags
- An array of key and value pair tags that are associated with the
resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
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.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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 Amazon Resource Name (ARN) of the resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- An array of tag key values to unassociate with the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
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.
UpdateEventDestination
data UpdateEventDestination Source #
See: newUpdateEventDestination
smart constructor.
UpdateEventDestination' (Maybe CloudWatchLogsDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe (NonEmpty EventType)) (Maybe SnsDestination) Text Text |
Instances
newUpdateEventDestination Source #
Create a value of UpdateEventDestination
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:
UpdateEventDestination
, updateEventDestination_cloudWatchLogsDestination
- An object that contains information about an event destination that
sends data to CloudWatch Logs.
UpdateEventDestination
, updateEventDestination_enabled
- When set to true logging is enabled.
UpdateEventDestination
, updateEventDestination_kinesisFirehoseDestination
- An object that contains information about an event destination for
logging to Kinesis Data Firehose.
UpdateEventDestination
, updateEventDestination_matchingEventTypes
- An array of event types that determine which events to log.
UpdateEventDestination
, updateEventDestination_snsDestination
- An object that contains information about an event destination that
sends data to Amazon SNS.
UpdateEventDestination
, updateEventDestination_configurationSetName
- The configuration set to update with the new event destination. Valid
values for this can be the ConfigurationSetName or ConfigurationSetArn.
UpdateEventDestination
, updateEventDestination_eventDestinationName
- The name to use for the event destination.
data UpdateEventDestinationResponse Source #
See: newUpdateEventDestinationResponse
smart constructor.
Instances
newUpdateEventDestinationResponse Source #
Create a value of UpdateEventDestinationResponse
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:
UpdateEventDestinationResponse
, updateEventDestinationResponse_configurationSetArn
- The Amazon Resource Name (ARN) for the ConfigurationSet that was
updated.
UpdateEventDestination
, updateEventDestinationResponse_configurationSetName
- The name of the configuration set.
$sel:eventDestination:UpdateEventDestinationResponse'
, updateEventDestinationResponse_eventDestination
- An EventDestination object containing the details of where events will
be logged.
$sel:httpStatus:UpdateEventDestinationResponse'
, updateEventDestinationResponse_httpStatus
- The response's http status code.
UpdatePhoneNumber
data UpdatePhoneNumber Source #
See: newUpdatePhoneNumber
smart constructor.
Instances
Create a value of UpdatePhoneNumber
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:
UpdatePhoneNumber
, updatePhoneNumber_deletionProtectionEnabled
- By default this is set to false. When set to true the phone number
can't be deleted.
UpdatePhoneNumber
, updatePhoneNumber_optOutListName
- The OptOutList to add the phone number to. Valid values for this field
can be either the OutOutListName or OutOutListArn.
UpdatePhoneNumber
, updatePhoneNumber_selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message
that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the
end recipient to the OptOutList. When set to true you're responsible
for responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests.
UpdatePhoneNumber
, updatePhoneNumber_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
UpdatePhoneNumber
, updatePhoneNumber_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
UpdatePhoneNumber
, updatePhoneNumber_phoneNumberId
- The unique identifier of the phone number. Valid values for this field
can be either the PhoneNumberId or PhoneNumberArn.
data UpdatePhoneNumberResponse Source #
See: newUpdatePhoneNumberResponse
smart constructor.
UpdatePhoneNumberResponse' (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe MessageType) (Maybe Text) (Maybe (NonEmpty NumberCapability)) (Maybe NumberType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe NumberStatus) (Maybe Text) (Maybe Bool) Int |
Instances
newUpdatePhoneNumberResponse Source #
Create a value of UpdatePhoneNumberResponse
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:
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_createdTimestamp
- The time when the phone number was created, in
UNIX epoch time format.
UpdatePhoneNumber
, updatePhoneNumberResponse_deletionProtectionEnabled
- When set to true the phone number can't be deleted.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_monthlyLeasingPrice
- The monthly leasing price of the phone number, in US dollars.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_numberCapabilities
- Specifies if the number could be used for text messages, voice or both.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_numberType
- The type of number that was requested.
UpdatePhoneNumber
, updatePhoneNumberResponse_optOutListName
- The name of the OptOutList associated with the phone number.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_phoneNumber
- The phone number that was updated.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_phoneNumberArn
- The Amazon Resource Name (ARN) of the updated phone number.
UpdatePhoneNumber
, updatePhoneNumberResponse_phoneNumberId
- The unique identifier of the phone number.
UpdatePhoneNumber
, updatePhoneNumberResponse_selfManagedOptOutsEnabled
- This is true if self managed opt-out are enabled.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_status
- The current status of the request.
UpdatePhoneNumber
, updatePhoneNumberResponse_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
UpdatePhoneNumber
, updatePhoneNumberResponse_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:UpdatePhoneNumberResponse'
, updatePhoneNumberResponse_httpStatus
- The response's http status code.
UpdatePool
data UpdatePool Source #
See: newUpdatePool
smart constructor.
Instances
:: Text | |
-> UpdatePool |
Create a value of UpdatePool
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:
UpdatePool
, updatePool_deletionProtectionEnabled
- When set to true the pool can't be deleted.
UpdatePool
, updatePool_optOutListName
- The OptOutList to associate with the pool. Valid values are either
OptOutListName or OptOutListArn.
UpdatePool
, updatePool_selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message
that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the
end recipient to the OptOutList. When set to true you're responsible
for responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests.
UpdatePool
, updatePool_sharedRoutesEnabled
- Indicates whether shared routes are enabled for the pool.
UpdatePool
, updatePool_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
UpdatePool
, updatePool_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
UpdatePool
, updatePool_poolId
- The unique identifier of the pool to update. Valid values are either the
PoolId or PoolArn.
data UpdatePoolResponse Source #
See: newUpdatePoolResponse
smart constructor.
UpdatePoolResponse' (Maybe POSIX) (Maybe Bool) (Maybe MessageType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe PoolStatus) (Maybe Text) (Maybe Bool) Int |
Instances
newUpdatePoolResponse Source #
Create a value of UpdatePoolResponse
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:
UpdatePoolResponse
, updatePoolResponse_createdTimestamp
- The time when the pool was created, in
UNIX epoch time format.
UpdatePool
, updatePoolResponse_deletionProtectionEnabled
- When set to true the pool can't be deleted.
UpdatePoolResponse
, updatePoolResponse_messageType
- The type of message for the pool to use.
UpdatePool
, updatePoolResponse_optOutListName
- The name of the OptOutList associated with the pool.
UpdatePoolResponse
, updatePoolResponse_poolArn
- The ARN of the pool.
UpdatePool
, updatePoolResponse_poolId
- The unique identifier of the pool.
UpdatePool
, updatePoolResponse_selfManagedOptOutsEnabled
- When an end recipient sends a message that begins with HELP or STOP to
one of your dedicated numbers, Amazon Pinpoint automatically replies
with a customizable message and adds the end recipient to the
OptOutList. When set to true you're responsible for responding to HELP
and STOP requests. You're also responsible for tracking and honoring
opt-out requests.
UpdatePool
, updatePoolResponse_sharedRoutesEnabled
- Indicates whether shared routes are enabled for the pool.
UpdatePoolResponse
, updatePoolResponse_status
- The current status of the pool update request.
UpdatePool
, updatePoolResponse_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
UpdatePool
, updatePoolResponse_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:UpdatePoolResponse'
, updatePoolResponse_httpStatus
- The response's http status code.
Types
AccountAttributeName
newtype AccountAttributeName Source #
Instances
AccountLimitName
newtype AccountLimitName Source #
pattern AccountLimitName_CONFIGURATION_SETS :: AccountLimitName | |
pattern AccountLimitName_OPT_OUT_LISTS :: AccountLimitName | |
pattern AccountLimitName_PHONE_NUMBERS :: AccountLimitName | |
pattern AccountLimitName_POOLS :: AccountLimitName |
Instances
ConfigurationSetFilterName
newtype ConfigurationSetFilterName Source #
Instances
DestinationCountryParameterKey
newtype DestinationCountryParameterKey Source #
pattern DestinationCountryParameterKey_IN_ENTITY_ID :: DestinationCountryParameterKey | |
pattern DestinationCountryParameterKey_IN_TEMPLATE_ID :: DestinationCountryParameterKey |
Instances
EventType
Instances
KeywordAction
newtype KeywordAction Source #
pattern KeywordAction_AUTOMATIC_RESPONSE :: KeywordAction | |
pattern KeywordAction_OPT_IN :: KeywordAction | |
pattern KeywordAction_OPT_OUT :: KeywordAction |
Instances
KeywordFilterName
newtype KeywordFilterName Source #
Instances
MessageType
newtype MessageType Source #
pattern MessageType_PROMOTIONAL :: MessageType | |
pattern MessageType_TRANSACTIONAL :: MessageType |
Instances
NumberCapability
newtype NumberCapability Source #
pattern NumberCapability_SMS :: NumberCapability | |
pattern NumberCapability_VOICE :: NumberCapability |
Instances
NumberStatus
newtype NumberStatus Source #
pattern NumberStatus_ACTIVE :: NumberStatus | |
pattern NumberStatus_ASSOCIATING :: NumberStatus | |
pattern NumberStatus_DELETED :: NumberStatus | |
pattern NumberStatus_DISASSOCIATING :: NumberStatus | |
pattern NumberStatus_PENDING :: NumberStatus |
Instances
NumberType
newtype NumberType Source #
pattern NumberType_LONG_CODE :: NumberType | |
pattern NumberType_SHORT_CODE :: NumberType | |
pattern NumberType_TEN_DLC :: NumberType | |
pattern NumberType_TOLL_FREE :: NumberType |
Instances
OptedOutFilterName
newtype OptedOutFilterName Source #
Instances
PhoneNumberFilterName
newtype PhoneNumberFilterName Source #
Instances
PoolFilterName
newtype PoolFilterName Source #
pattern PoolFilterName_Deletion_protection_enabled :: PoolFilterName | |
pattern PoolFilterName_Message_type :: PoolFilterName | |
pattern PoolFilterName_Opt_out_list_name :: PoolFilterName | |
pattern PoolFilterName_Self_managed_opt_outs_enabled :: PoolFilterName | |
pattern PoolFilterName_Shared_routes_enabled :: PoolFilterName | |
pattern PoolFilterName_Status :: PoolFilterName | |
pattern PoolFilterName_Two_way_enabled :: PoolFilterName |
Instances
PoolOriginationIdentitiesFilterName
newtype PoolOriginationIdentitiesFilterName Source #
Instances
PoolStatus
newtype PoolStatus Source #
pattern PoolStatus_ACTIVE :: PoolStatus | |
pattern PoolStatus_CREATING :: PoolStatus | |
pattern PoolStatus_DELETING :: PoolStatus |
Instances
RequestableNumberType
newtype RequestableNumberType Source #
pattern RequestableNumberType_LONG_CODE :: RequestableNumberType | |
pattern RequestableNumberType_TEN_DLC :: RequestableNumberType | |
pattern RequestableNumberType_TOLL_FREE :: RequestableNumberType |
Instances
SenderIdFilterName
newtype SenderIdFilterName Source #
pattern SenderIdFilterName_Iso_country_code :: SenderIdFilterName | |
pattern SenderIdFilterName_Message_type :: SenderIdFilterName | |
pattern SenderIdFilterName_Sender_id :: SenderIdFilterName |
Instances
SpendLimitName
newtype SpendLimitName Source #
pattern SpendLimitName_TEXT_MESSAGE_MONTHLY_SPEND_LIMIT :: SpendLimitName | |
pattern SpendLimitName_VOICE_MESSAGE_MONTHLY_SPEND_LIMIT :: SpendLimitName |
Instances
VoiceId
Instances
VoiceMessageBodyTextType
newtype VoiceMessageBodyTextType Source #
pattern VoiceMessageBodyTextType_SSML :: VoiceMessageBodyTextType | |
pattern VoiceMessageBodyTextType_TEXT :: VoiceMessageBodyTextType |
Instances
AccountAttribute
data AccountAttribute Source #
Displays the attributes associated with a single Amazon Web Services account.
See: newAccountAttribute
smart constructor.
Instances
Create a value of AccountAttribute
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:AccountAttribute'
, accountAttribute_name
- The name of the account attribute.
$sel:value:AccountAttribute'
, accountAttribute_value
- The value associated with the account attribute name.
AccountLimit
data AccountLimit Source #
The current resource quotas associated with an Amazon Web Services account.
See: newAccountLimit
smart constructor.
Instances
:: AccountLimitName | |
-> Integer | |
-> Integer | |
-> AccountLimit |
Create a value of AccountLimit
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:AccountLimit'
, accountLimit_name
- The name of the attribute to apply the account limit to.
$sel:used:AccountLimit'
, accountLimit_used
- The current amount that has been spent, in US dollars.
$sel:max:AccountLimit'
, accountLimit_max
- The Amazon Web Services set limit for that resource type, in US dollars.
CloudWatchLogsDestination
data CloudWatchLogsDestination Source #
Contains the destination configuration to use when publishing message sending events.
See: newCloudWatchLogsDestination
smart constructor.
Instances
newCloudWatchLogsDestination Source #
:: Text | |
-> Text | |
-> CloudWatchLogsDestination |
Create a value of CloudWatchLogsDestination
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:iamRoleArn:CloudWatchLogsDestination'
, cloudWatchLogsDestination_iamRoleArn
- The Amazon Resource Name (ARN) of an Amazon Identity and Access
Management (IAM) role that is able to write event data to an Amazon
CloudWatch destination.
$sel:logGroupArn:CloudWatchLogsDestination'
, cloudWatchLogsDestination_logGroupArn
- The name of the Amazon CloudWatch log group that you want to record
events in.
ConfigurationSetFilter
data ConfigurationSetFilter Source #
The information for configuration sets that meet a specified criteria.
See: newConfigurationSetFilter
smart constructor.
Instances
newConfigurationSetFilter Source #
Create a value of ConfigurationSetFilter
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:ConfigurationSetFilter'
, configurationSetFilter_name
- The name of the attribute to filter on.
$sel:values:ConfigurationSetFilter'
, configurationSetFilter_values
- An array values to filter for.
ConfigurationSetInformation
data ConfigurationSetInformation Source #
Information related to a given configuration set in your Amazon Web Services account.
See: newConfigurationSetInformation
smart constructor.
Instances
newConfigurationSetInformation Source #
:: Text | |
-> Text | |
-> UTCTime | |
-> ConfigurationSetInformation |
Create a value of ConfigurationSetInformation
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:defaultMessageType:ConfigurationSetInformation'
, configurationSetInformation_defaultMessageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:defaultSenderId:ConfigurationSetInformation'
, configurationSetInformation_defaultSenderId
- The default sender ID used by the ConfigurationSet.
$sel:configurationSetArn:ConfigurationSetInformation'
, configurationSetInformation_configurationSetArn
- The Resource Name (ARN) of the ConfigurationSet.
$sel:configurationSetName:ConfigurationSetInformation'
, configurationSetInformation_configurationSetName
- The name of the ConfigurationSet.
$sel:eventDestinations:ConfigurationSetInformation'
, configurationSetInformation_eventDestinations
- An array of EventDestination objects that describe any events to log and
where to log them.
$sel:createdTimestamp:ConfigurationSetInformation'
, configurationSetInformation_createdTimestamp
- The time when the ConfigurationSet was created, in
UNIX epoch time format.
EventDestination
data EventDestination Source #
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.
See: newEventDestination
smart constructor.
EventDestination' (Maybe CloudWatchLogsDestination) (Maybe KinesisFirehoseDestination) (Maybe SnsDestination) Text Bool (NonEmpty EventType) |
Instances
:: Text | |
-> Bool | |
-> NonEmpty EventType | |
-> EventDestination |
Create a value of EventDestination
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:cloudWatchLogsDestination:EventDestination'
, eventDestination_cloudWatchLogsDestination
- An object that contains information about an event destination that
sends logging events to Amazon CloudWatch logs.
$sel:kinesisFirehoseDestination:EventDestination'
, eventDestination_kinesisFirehoseDestination
- An object that contains information about an event destination for
logging to Amazon Kinesis Data Firehose.
$sel:snsDestination:EventDestination'
, eventDestination_snsDestination
- An object that contains information about an event destination that
sends logging events to Amazon SNS.
$sel:eventDestinationName:EventDestination'
, eventDestination_eventDestinationName
- The name of the EventDestination.
$sel:enabled:EventDestination'
, eventDestination_enabled
- When set to true events will be logged.
$sel:matchingEventTypes:EventDestination'
, eventDestination_matchingEventTypes
- An array of event types that determine which events to log.
KeywordFilter
data KeywordFilter Source #
The information for keywords that meet a specified criteria.
See: newKeywordFilter
smart constructor.
Instances
Create a value of KeywordFilter
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:KeywordFilter'
, keywordFilter_name
- The name of the attribute to filter on.
$sel:values:KeywordFilter'
, keywordFilter_values
- An array values to filter for.
KeywordInformation
data KeywordInformation Source #
The information for all keywords in a pool.
See: newKeywordInformation
smart constructor.
Instances
newKeywordInformation Source #
:: Text | |
-> Text | |
-> KeywordAction | |
-> KeywordInformation |
Create a value of KeywordInformation
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:keyword:KeywordInformation'
, keywordInformation_keyword
- The keyword as a string.
$sel:keywordMessage:KeywordInformation'
, keywordInformation_keywordMessage
- A custom message that can be used with the keyword.
$sel:keywordAction:KeywordInformation'
, keywordInformation_keywordAction
- The action to perform for the keyword.
KinesisFirehoseDestination
data KinesisFirehoseDestination Source #
Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event destination.
Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.
See: newKinesisFirehoseDestination
smart constructor.
Instances
newKinesisFirehoseDestination Source #
:: Text | |
-> Text | |
-> KinesisFirehoseDestination |
Create a value of KinesisFirehoseDestination
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:iamRoleArn:KinesisFirehoseDestination'
, kinesisFirehoseDestination_iamRoleArn
- The ARN of an Amazon Identity and Access Management (IAM) role that is
able to write event data to an Amazon Firehose destination.
$sel:deliveryStreamArn:KinesisFirehoseDestination'
, kinesisFirehoseDestination_deliveryStreamArn
- The Amazon Resource Name (ARN) of the delivery stream.
OptOutListInformation
data OptOutListInformation Source #
The information for all OptOutList in an Amazon Web Services account.
See: newOptOutListInformation
smart constructor.
Instances
newOptOutListInformation Source #
:: Text | |
-> Text | |
-> UTCTime | |
-> OptOutListInformation |
Create a value of OptOutListInformation
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:optOutListArn:OptOutListInformation'
, optOutListInformation_optOutListArn
- The Amazon Resource Name (ARN) of the OptOutList.
$sel:optOutListName:OptOutListInformation'
, optOutListInformation_optOutListName
- The name of the OptOutList.
$sel:createdTimestamp:OptOutListInformation'
, optOutListInformation_createdTimestamp
- The time when the OutOutList was created, in
UNIX epoch time format.
OptedOutFilter
data OptedOutFilter Source #
The information for opted out numbers that meet a specified criteria.
See: newOptedOutFilter
smart constructor.
Instances
Create a value of OptedOutFilter
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:OptedOutFilter'
, optedOutFilter_name
- The name of the attribute to filter on.
$sel:values:OptedOutFilter'
, optedOutFilter_values
- An array of values to filter for.
OptedOutNumberInformation
data OptedOutNumberInformation Source #
The information for an opted out number in an Amazon Web Services account.
See: newOptedOutNumberInformation
smart constructor.
Instances
newOptedOutNumberInformation Source #
:: Text | |
-> UTCTime | |
-> Bool | |
-> OptedOutNumberInformation |
Create a value of OptedOutNumberInformation
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:optedOutNumber:OptedOutNumberInformation'
, optedOutNumberInformation_optedOutNumber
- The phone number that is opted out.
$sel:optedOutTimestamp:OptedOutNumberInformation'
, optedOutNumberInformation_optedOutTimestamp
- The time that the op tout occurred, in
UNIX epoch time format.
$sel:endUserOptedOut:OptedOutNumberInformation'
, optedOutNumberInformation_endUserOptedOut
- This is set to true if it was the end recipient that opted out.
OriginationIdentityMetadata
data OriginationIdentityMetadata Source #
The metadata for an origination identity associated with a pool.
See: newOriginationIdentityMetadata
smart constructor.
Instances
newOriginationIdentityMetadata Source #
:: Text | |
-> Text | |
-> Text | |
-> NonEmpty NumberCapability | |
-> OriginationIdentityMetadata |
Create a value of OriginationIdentityMetadata
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:originationIdentityArn:OriginationIdentityMetadata'
, originationIdentityMetadata_originationIdentityArn
- The Amazon Resource Name (ARN) associated with the origination identity.
$sel:originationIdentity:OriginationIdentityMetadata'
, originationIdentityMetadata_originationIdentity
- The unique identifier of the origination identity.
$sel:isoCountryCode:OriginationIdentityMetadata'
, originationIdentityMetadata_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
$sel:numberCapabilities:OriginationIdentityMetadata'
, originationIdentityMetadata_numberCapabilities
- Describes if the origination identity can be used for text messages,
voice calls or both.
PhoneNumberFilter
data PhoneNumberFilter Source #
The information for a phone number that meets a specified criteria.
See: newPhoneNumberFilter
smart constructor.
Instances
Create a value of PhoneNumberFilter
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:PhoneNumberFilter'
, phoneNumberFilter_name
- The name of the attribute to filter on.
$sel:values:PhoneNumberFilter'
, phoneNumberFilter_values
- An array values to filter for.
PhoneNumberInformation
data PhoneNumberInformation Source #
The information for a phone number in an Amazon Web Services account.
See: newPhoneNumberInformation
smart constructor.
PhoneNumberInformation' (Maybe Text) (Maybe Text) (Maybe Text) Text Text NumberStatus Text MessageType (NonEmpty NumberCapability) NumberType Text Bool Bool Text Bool POSIX |
Instances
newPhoneNumberInformation Source #
:: Text | |
-> Text | |
-> NumberStatus | |
-> Text | |
-> MessageType | |
-> NonEmpty NumberCapability | |
-> NumberType | |
-> Text | |
-> Bool | |
-> Bool | |
-> Text | |
-> Bool | |
-> UTCTime | |
-> PhoneNumberInformation |
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:phoneNumberId:PhoneNumberInformation'
, phoneNumberInformation_phoneNumberId
- The unique identifier for the phone number.
$sel:poolId:PhoneNumberInformation'
, phoneNumberInformation_poolId
- The unique identifier of the pool associated with the phone number.
$sel:twoWayChannelArn:PhoneNumberInformation'
, phoneNumberInformation_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
$sel:phoneNumberArn:PhoneNumberInformation'
, phoneNumberInformation_phoneNumberArn
- The Amazon Resource Name (ARN) associated with the phone number.
$sel:phoneNumber:PhoneNumberInformation'
, phoneNumberInformation_phoneNumber
- The phone number in E.164 format.
$sel:status:PhoneNumberInformation'
, phoneNumberInformation_status
- The current status of the phone number.
$sel:isoCountryCode:PhoneNumberInformation'
, phoneNumberInformation_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
$sel:messageType:PhoneNumberInformation'
, phoneNumberInformation_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:numberCapabilities:PhoneNumberInformation'
, phoneNumberInformation_numberCapabilities
- Describes if the origination identity can be used for text messages,
voice calls or both.
$sel:numberType:PhoneNumberInformation'
, phoneNumberInformation_numberType
- The type of phone number.
$sel:monthlyLeasingPrice:PhoneNumberInformation'
, phoneNumberInformation_monthlyLeasingPrice
- The price, in US dollars, to lease the phone number.
$sel:twoWayEnabled:PhoneNumberInformation'
, phoneNumberInformation_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients using the
TwoWayChannelArn.
$sel:selfManagedOptOutsEnabled:PhoneNumberInformation'
, phoneNumberInformation_selfManagedOptOutsEnabled
- When set to false an end recipient sends a message that begins with HELP
or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
replies with a customizable message and adds the end recipient to the
OptOutList. When set to true you're responsible for responding to HELP
and STOP requests. You're also responsible for tracking and honoring
opt-out request. For more information see
Self-managed opt-outs
$sel:optOutListName:PhoneNumberInformation'
, phoneNumberInformation_optOutListName
- The name of the OptOutList associated with the phone number.
$sel:deletionProtectionEnabled:PhoneNumberInformation'
, phoneNumberInformation_deletionProtectionEnabled
- When set to true the phone number can't be deleted.
$sel:createdTimestamp:PhoneNumberInformation'
, phoneNumberInformation_createdTimestamp
- The time when the phone number was created, in
UNIX epoch time format.
PoolFilter
data PoolFilter Source #
The information for a pool that meets a specified criteria.
See: newPoolFilter
smart constructor.
Instances
Create a value of PoolFilter
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:PoolFilter'
, poolFilter_name
- The name of the attribute to filter on.
$sel:values:PoolFilter'
, poolFilter_values
- An array values to filter for.
PoolInformation
data PoolInformation Source #
The information for a pool in an Amazon Web Services account.
See: newPoolInformation
smart constructor.
Instances
:: Text | |
-> Text | |
-> PoolStatus | |
-> MessageType | |
-> Bool | |
-> Bool | |
-> Text | |
-> Bool | |
-> Bool | |
-> UTCTime | |
-> PoolInformation |
Create a value of PoolInformation
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:twoWayChannelArn:PoolInformation'
, poolInformation_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
$sel:poolArn:PoolInformation'
, poolInformation_poolArn
- The Amazon Resource Name (ARN) for the pool.
$sel:poolId:PoolInformation'
, poolInformation_poolId
- The unique identifier for the pool.
$sel:status:PoolInformation'
, poolInformation_status
- The current status of the pool.
$sel:messageType:PoolInformation'
, poolInformation_messageType
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:twoWayEnabled:PoolInformation'
, poolInformation_twoWayEnabled
- When set to true you can receive incoming text messages from your end
recipients using the TwoWayChannelArn.
$sel:selfManagedOptOutsEnabled:PoolInformation'
, poolInformation_selfManagedOptOutsEnabled
- When set to false, an end recipient sends a message that begins with
HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
automatically replies with a customizable message and adds the end
recipient to the OptOutList. When set to true you're responsible for
responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests. For more information see
Self-managed opt-outs
$sel:optOutListName:PoolInformation'
, poolInformation_optOutListName
- The name of the OptOutList associated with the pool.
$sel:sharedRoutesEnabled:PoolInformation'
, poolInformation_sharedRoutesEnabled
- Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
,
your messages are sent using phone numbers or sender IDs (depending on
the country) that are shared with other Amazon Pinpoint users. In some
countries, such as the United States, senders aren't allowed to use
shared routes and must use a dedicated phone number or short code.
$sel:deletionProtectionEnabled:PoolInformation'
, poolInformation_deletionProtectionEnabled
- When set to true the pool can't be deleted.
$sel:createdTimestamp:PoolInformation'
, poolInformation_createdTimestamp
- The time when the pool was created, in
UNIX epoch time format.
PoolOriginationIdentitiesFilter
data PoolOriginationIdentitiesFilter Source #
Information about origination identities associated with a pool that meets a specified criteria.
See: newPoolOriginationIdentitiesFilter
smart constructor.
Instances
ToJSON PoolOriginationIdentitiesFilter Source # | |
Generic PoolOriginationIdentitiesFilter Source # | |
Read PoolOriginationIdentitiesFilter Source # | |
Show PoolOriginationIdentitiesFilter Source # | |
NFData PoolOriginationIdentitiesFilter Source # | |
Eq PoolOriginationIdentitiesFilter Source # | |
Hashable PoolOriginationIdentitiesFilter Source # | |
type Rep PoolOriginationIdentitiesFilter Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.PoolOriginationIdentitiesFilter type Rep PoolOriginationIdentitiesFilter = D1 ('MetaData "PoolOriginationIdentitiesFilter" "Amazonka.PinpointSmsVoiceV2.Types.PoolOriginationIdentitiesFilter" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "PoolOriginationIdentitiesFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PoolOriginationIdentitiesFilterName) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) |
newPoolOriginationIdentitiesFilter Source #
Create a value of PoolOriginationIdentitiesFilter
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:PoolOriginationIdentitiesFilter'
, poolOriginationIdentitiesFilter_name
- The name of the attribute to filter on.
$sel:values:PoolOriginationIdentitiesFilter'
, poolOriginationIdentitiesFilter_values
- An array values to filter for.
SenderIdAndCountry
data SenderIdAndCountry Source #
The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.
See: newSenderIdAndCountry
smart constructor.
Instances
newSenderIdAndCountry Source #
:: Text | |
-> Text | |
-> SenderIdAndCountry |
Create a value of SenderIdAndCountry
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:senderId:SenderIdAndCountry'
, senderIdAndCountry_senderId
- The unique identifier of the sender.
$sel:isoCountryCode:SenderIdAndCountry'
, senderIdAndCountry_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
SenderIdFilter
data SenderIdFilter Source #
The information for a sender ID that meets a specified criteria.
See: newSenderIdFilter
smart constructor.
Instances
Create a value of SenderIdFilter
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:SenderIdFilter'
, senderIdFilter_name
- The name of the attribute to filter on.
$sel:values:SenderIdFilter'
, senderIdFilter_values
- An array of values to filter for.
SenderIdInformation
data SenderIdInformation Source #
The information for all SenderIds in an Amazon Web Services account.
See: newSenderIdInformation
smart constructor.
Instances
newSenderIdInformation Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> SenderIdInformation |
Create a value of SenderIdInformation
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:senderIdArn:SenderIdInformation'
, senderIdInformation_senderIdArn
- The Amazon Resource Name (ARN) associated with the SenderId.
$sel:senderId:SenderIdInformation'
, senderIdInformation_senderId
- The alphanumeric sender ID in a specific country that you'd like to
describe.
$sel:isoCountryCode:SenderIdInformation'
, senderIdInformation_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
$sel:messageTypes:SenderIdInformation'
, senderIdInformation_messageTypes
- The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:monthlyLeasingPrice:SenderIdInformation'
, senderIdInformation_monthlyLeasingPrice
- The monthly leasing price, in US dollars.
SnsDestination
data SnsDestination Source #
An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
See: newSnsDestination
smart constructor.
Instances
Create a value of SnsDestination
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:SnsDestination'
, snsDestination_topicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to
publish events to.
SpendLimit
data SpendLimit Source #
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
See: newSpendLimit
smart constructor.
Instances
:: SpendLimitName | |
-> Integer | |
-> Integer | |
-> Bool | |
-> SpendLimit |
Create a value of SpendLimit
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:SpendLimit'
, spendLimit_name
- The name for the SpendLimit.
$sel:enforcedLimit:SpendLimit'
, spendLimit_enforcedLimit
- The maximum amount of money, in US dollars, that you want to be able to
spend sending messages each month. This value has to be less than or
equal to the amount in MaxLimit
. To use this custom limit,
Overridden
must be set to true.
$sel:maxLimit:SpendLimit'
, spendLimit_maxLimit
- The maximum amount of money that you are able to spend to send messages
each month, in US dollars.
$sel:overridden:SpendLimit'
, spendLimit_overridden
- When set to True
, the value that has been specified in the
EnforcedLimit
is used to determine the maximum amount in US dollars
that can be spent to send messages each month, in US dollars.
Tag
The list of tags to be added to the specified topic.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.PinpointSmsVoiceV2.Types.Tag" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" '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 key identifier, or name, of the tag.
$sel:value:Tag'
, tag_value
- The string value associated with the key of the tag.