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 |
- Operations
- AssociateOriginationIdentity
- CreateConfigurationSet
- CreateEventDestination
- CreateOptOutList
- CreatePool
- DeleteConfigurationSet
- DeleteDefaultMessageType
- DeleteDefaultSenderId
- DeleteEventDestination
- DeleteKeyword
- DeleteOptOutList
- DeleteOptedOutNumber
- DeletePool
- DeleteTextMessageSpendLimitOverride
- DeleteVoiceMessageSpendLimitOverride
- DescribeAccountAttributes
- DescribeAccountLimits
- DescribeConfigurationSets
- DescribeKeywords
- DescribeOptOutLists
- DescribeOptedOutNumbers
- DescribePhoneNumbers
- DescribePools
- DescribeSenderIds
- DescribeSpendLimits
- DisassociateOriginationIdentity
- ListPoolOriginationIdentities
- ListTagsForResource
- PutKeyword
- PutOptedOutNumber
- ReleasePhoneNumber
- RequestPhoneNumber
- SendTextMessage
- SendVoiceMessage
- SetDefaultMessageType
- SetDefaultSenderId
- SetTextMessageSpendLimitOverride
- SetVoiceMessageSpendLimitOverride
- TagResource
- UntagResource
- UpdateEventDestination
- UpdatePhoneNumber
- UpdatePool
- Types
- AccountAttribute
- AccountLimit
- CloudWatchLogsDestination
- ConfigurationSetFilter
- ConfigurationSetInformation
- EventDestination
- KeywordFilter
- KeywordInformation
- KinesisFirehoseDestination
- OptOutListInformation
- OptedOutFilter
- OptedOutNumberInformation
- OriginationIdentityMetadata
- PhoneNumberFilter
- PhoneNumberInformation
- PoolFilter
- PoolInformation
- PoolOriginationIdentitiesFilter
- SenderIdAndCountry
- SenderIdFilter
- SenderIdInformation
- SnsDestination
- SpendLimit
- Tag
Synopsis
- associateOriginationIdentity_clientToken :: Lens' AssociateOriginationIdentity (Maybe Text)
- associateOriginationIdentity_poolId :: Lens' AssociateOriginationIdentity Text
- associateOriginationIdentity_originationIdentity :: Lens' AssociateOriginationIdentity Text
- associateOriginationIdentity_isoCountryCode :: Lens' AssociateOriginationIdentity Text
- associateOriginationIdentityResponse_isoCountryCode :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_originationIdentity :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_originationIdentityArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_poolArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_poolId :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_httpStatus :: Lens' AssociateOriginationIdentityResponse Int
- createConfigurationSet_clientToken :: Lens' CreateConfigurationSet (Maybe Text)
- createConfigurationSet_tags :: Lens' CreateConfigurationSet (Maybe [Tag])
- createConfigurationSet_configurationSetName :: Lens' CreateConfigurationSet Text
- createConfigurationSetResponse_configurationSetArn :: Lens' CreateConfigurationSetResponse (Maybe Text)
- createConfigurationSetResponse_configurationSetName :: Lens' CreateConfigurationSetResponse (Maybe Text)
- createConfigurationSetResponse_createdTimestamp :: Lens' CreateConfigurationSetResponse (Maybe UTCTime)
- createConfigurationSetResponse_tags :: Lens' CreateConfigurationSetResponse (Maybe [Tag])
- createConfigurationSetResponse_httpStatus :: Lens' CreateConfigurationSetResponse Int
- createEventDestination_clientToken :: Lens' CreateEventDestination (Maybe Text)
- createEventDestination_cloudWatchLogsDestination :: Lens' CreateEventDestination (Maybe CloudWatchLogsDestination)
- createEventDestination_kinesisFirehoseDestination :: Lens' CreateEventDestination (Maybe KinesisFirehoseDestination)
- createEventDestination_snsDestination :: Lens' CreateEventDestination (Maybe SnsDestination)
- createEventDestination_configurationSetName :: Lens' CreateEventDestination Text
- createEventDestination_eventDestinationName :: Lens' CreateEventDestination Text
- createEventDestination_matchingEventTypes :: Lens' CreateEventDestination (NonEmpty EventType)
- createEventDestinationResponse_configurationSetArn :: Lens' CreateEventDestinationResponse (Maybe Text)
- createEventDestinationResponse_configurationSetName :: Lens' CreateEventDestinationResponse (Maybe Text)
- createEventDestinationResponse_eventDestination :: Lens' CreateEventDestinationResponse (Maybe EventDestination)
- createEventDestinationResponse_httpStatus :: Lens' CreateEventDestinationResponse Int
- createOptOutList_clientToken :: Lens' CreateOptOutList (Maybe Text)
- createOptOutList_tags :: Lens' CreateOptOutList (Maybe [Tag])
- createOptOutList_optOutListName :: Lens' CreateOptOutList Text
- createOptOutListResponse_createdTimestamp :: Lens' CreateOptOutListResponse (Maybe UTCTime)
- createOptOutListResponse_optOutListArn :: Lens' CreateOptOutListResponse (Maybe Text)
- createOptOutListResponse_optOutListName :: Lens' CreateOptOutListResponse (Maybe Text)
- createOptOutListResponse_tags :: Lens' CreateOptOutListResponse (Maybe [Tag])
- createOptOutListResponse_httpStatus :: Lens' CreateOptOutListResponse Int
- createPool_clientToken :: Lens' CreatePool (Maybe Text)
- createPool_deletionProtectionEnabled :: Lens' CreatePool (Maybe Bool)
- createPool_tags :: Lens' CreatePool (Maybe [Tag])
- createPool_originationIdentity :: Lens' CreatePool Text
- createPool_isoCountryCode :: Lens' CreatePool Text
- createPool_messageType :: Lens' CreatePool MessageType
- createPoolResponse_createdTimestamp :: Lens' CreatePoolResponse (Maybe UTCTime)
- createPoolResponse_deletionProtectionEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_messageType :: Lens' CreatePoolResponse (Maybe MessageType)
- createPoolResponse_optOutListName :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_poolArn :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_poolId :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_selfManagedOptOutsEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_sharedRoutesEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_status :: Lens' CreatePoolResponse (Maybe PoolStatus)
- createPoolResponse_tags :: Lens' CreatePoolResponse (Maybe [Tag])
- createPoolResponse_twoWayChannelArn :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_twoWayEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_httpStatus :: Lens' CreatePoolResponse Int
- deleteConfigurationSet_configurationSetName :: Lens' DeleteConfigurationSet Text
- deleteConfigurationSetResponse_configurationSetArn :: Lens' DeleteConfigurationSetResponse (Maybe Text)
- deleteConfigurationSetResponse_configurationSetName :: Lens' DeleteConfigurationSetResponse (Maybe Text)
- deleteConfigurationSetResponse_createdTimestamp :: Lens' DeleteConfigurationSetResponse (Maybe UTCTime)
- deleteConfigurationSetResponse_defaultMessageType :: Lens' DeleteConfigurationSetResponse (Maybe MessageType)
- deleteConfigurationSetResponse_defaultSenderId :: Lens' DeleteConfigurationSetResponse (Maybe Text)
- deleteConfigurationSetResponse_eventDestinations :: Lens' DeleteConfigurationSetResponse (Maybe [EventDestination])
- deleteConfigurationSetResponse_httpStatus :: Lens' DeleteConfigurationSetResponse Int
- deleteDefaultMessageType_configurationSetName :: Lens' DeleteDefaultMessageType Text
- deleteDefaultMessageTypeResponse_configurationSetArn :: Lens' DeleteDefaultMessageTypeResponse (Maybe Text)
- deleteDefaultMessageTypeResponse_configurationSetName :: Lens' DeleteDefaultMessageTypeResponse (Maybe Text)
- deleteDefaultMessageTypeResponse_messageType :: Lens' DeleteDefaultMessageTypeResponse (Maybe MessageType)
- deleteDefaultMessageTypeResponse_httpStatus :: Lens' DeleteDefaultMessageTypeResponse Int
- deleteDefaultSenderId_configurationSetName :: Lens' DeleteDefaultSenderId Text
- deleteDefaultSenderIdResponse_configurationSetArn :: Lens' DeleteDefaultSenderIdResponse (Maybe Text)
- deleteDefaultSenderIdResponse_configurationSetName :: Lens' DeleteDefaultSenderIdResponse (Maybe Text)
- deleteDefaultSenderIdResponse_senderId :: Lens' DeleteDefaultSenderIdResponse (Maybe Text)
- deleteDefaultSenderIdResponse_httpStatus :: Lens' DeleteDefaultSenderIdResponse Int
- deleteEventDestination_configurationSetName :: Lens' DeleteEventDestination Text
- deleteEventDestination_eventDestinationName :: Lens' DeleteEventDestination Text
- deleteEventDestinationResponse_configurationSetArn :: Lens' DeleteEventDestinationResponse (Maybe Text)
- deleteEventDestinationResponse_configurationSetName :: Lens' DeleteEventDestinationResponse (Maybe Text)
- deleteEventDestinationResponse_eventDestination :: Lens' DeleteEventDestinationResponse (Maybe EventDestination)
- deleteEventDestinationResponse_httpStatus :: Lens' DeleteEventDestinationResponse Int
- deleteKeyword_originationIdentity :: Lens' DeleteKeyword Text
- deleteKeyword_keyword :: Lens' DeleteKeyword Text
- deleteKeywordResponse_keyword :: Lens' DeleteKeywordResponse (Maybe Text)
- deleteKeywordResponse_keywordAction :: Lens' DeleteKeywordResponse (Maybe KeywordAction)
- deleteKeywordResponse_keywordMessage :: Lens' DeleteKeywordResponse (Maybe Text)
- deleteKeywordResponse_originationIdentity :: Lens' DeleteKeywordResponse (Maybe Text)
- deleteKeywordResponse_originationIdentityArn :: Lens' DeleteKeywordResponse (Maybe Text)
- deleteKeywordResponse_httpStatus :: Lens' DeleteKeywordResponse Int
- deleteOptOutList_optOutListName :: Lens' DeleteOptOutList Text
- deleteOptOutListResponse_createdTimestamp :: Lens' DeleteOptOutListResponse (Maybe UTCTime)
- deleteOptOutListResponse_optOutListArn :: Lens' DeleteOptOutListResponse (Maybe Text)
- deleteOptOutListResponse_optOutListName :: Lens' DeleteOptOutListResponse (Maybe Text)
- deleteOptOutListResponse_httpStatus :: Lens' DeleteOptOutListResponse Int
- deleteOptedOutNumber_optOutListName :: Lens' DeleteOptedOutNumber Text
- deleteOptedOutNumber_optedOutNumber :: Lens' DeleteOptedOutNumber Text
- deleteOptedOutNumberResponse_endUserOptedOut :: Lens' DeleteOptedOutNumberResponse (Maybe Bool)
- deleteOptedOutNumberResponse_optOutListArn :: Lens' DeleteOptedOutNumberResponse (Maybe Text)
- deleteOptedOutNumberResponse_optOutListName :: Lens' DeleteOptedOutNumberResponse (Maybe Text)
- deleteOptedOutNumberResponse_optedOutNumber :: Lens' DeleteOptedOutNumberResponse (Maybe Text)
- deleteOptedOutNumberResponse_optedOutTimestamp :: Lens' DeleteOptedOutNumberResponse (Maybe UTCTime)
- deleteOptedOutNumberResponse_httpStatus :: Lens' DeleteOptedOutNumberResponse Int
- deletePool_poolId :: Lens' DeletePool Text
- deletePoolResponse_createdTimestamp :: Lens' DeletePoolResponse (Maybe UTCTime)
- deletePoolResponse_messageType :: Lens' DeletePoolResponse (Maybe MessageType)
- deletePoolResponse_optOutListName :: Lens' DeletePoolResponse (Maybe Text)
- deletePoolResponse_poolArn :: Lens' DeletePoolResponse (Maybe Text)
- deletePoolResponse_poolId :: Lens' DeletePoolResponse (Maybe Text)
- deletePoolResponse_selfManagedOptOutsEnabled :: Lens' DeletePoolResponse (Maybe Bool)
- deletePoolResponse_sharedRoutesEnabled :: Lens' DeletePoolResponse (Maybe Bool)
- deletePoolResponse_status :: Lens' DeletePoolResponse (Maybe PoolStatus)
- deletePoolResponse_twoWayChannelArn :: Lens' DeletePoolResponse (Maybe Text)
- deletePoolResponse_twoWayEnabled :: Lens' DeletePoolResponse (Maybe Bool)
- deletePoolResponse_httpStatus :: Lens' DeletePoolResponse Int
- deleteTextMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' DeleteTextMessageSpendLimitOverrideResponse (Maybe Natural)
- deleteTextMessageSpendLimitOverrideResponse_httpStatus :: Lens' DeleteTextMessageSpendLimitOverrideResponse Int
- deleteVoiceMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' DeleteVoiceMessageSpendLimitOverrideResponse (Maybe Natural)
- deleteVoiceMessageSpendLimitOverrideResponse_httpStatus :: Lens' DeleteVoiceMessageSpendLimitOverrideResponse Int
- describeAccountAttributes_maxResults :: Lens' DescribeAccountAttributes (Maybe Natural)
- describeAccountAttributes_nextToken :: Lens' DescribeAccountAttributes (Maybe Text)
- describeAccountAttributesResponse_accountAttributes :: Lens' DescribeAccountAttributesResponse (Maybe [AccountAttribute])
- describeAccountAttributesResponse_nextToken :: Lens' DescribeAccountAttributesResponse (Maybe Text)
- describeAccountAttributesResponse_httpStatus :: Lens' DescribeAccountAttributesResponse Int
- describeAccountLimits_maxResults :: Lens' DescribeAccountLimits (Maybe Natural)
- describeAccountLimits_nextToken :: Lens' DescribeAccountLimits (Maybe Text)
- describeAccountLimitsResponse_accountLimits :: Lens' DescribeAccountLimitsResponse (Maybe [AccountLimit])
- describeAccountLimitsResponse_nextToken :: Lens' DescribeAccountLimitsResponse (Maybe Text)
- describeAccountLimitsResponse_httpStatus :: Lens' DescribeAccountLimitsResponse Int
- describeConfigurationSets_configurationSetNames :: Lens' DescribeConfigurationSets (Maybe [Text])
- describeConfigurationSets_filters :: Lens' DescribeConfigurationSets (Maybe [ConfigurationSetFilter])
- describeConfigurationSets_maxResults :: Lens' DescribeConfigurationSets (Maybe Natural)
- describeConfigurationSets_nextToken :: Lens' DescribeConfigurationSets (Maybe Text)
- describeConfigurationSetsResponse_configurationSets :: Lens' DescribeConfigurationSetsResponse (Maybe [ConfigurationSetInformation])
- describeConfigurationSetsResponse_nextToken :: Lens' DescribeConfigurationSetsResponse (Maybe Text)
- describeConfigurationSetsResponse_httpStatus :: Lens' DescribeConfigurationSetsResponse Int
- describeKeywords_filters :: Lens' DescribeKeywords (Maybe [KeywordFilter])
- describeKeywords_keywords :: Lens' DescribeKeywords (Maybe [Text])
- describeKeywords_maxResults :: Lens' DescribeKeywords (Maybe Natural)
- describeKeywords_nextToken :: Lens' DescribeKeywords (Maybe Text)
- describeKeywords_originationIdentity :: Lens' DescribeKeywords Text
- describeKeywordsResponse_keywords :: Lens' DescribeKeywordsResponse (Maybe [KeywordInformation])
- describeKeywordsResponse_nextToken :: Lens' DescribeKeywordsResponse (Maybe Text)
- describeKeywordsResponse_originationIdentity :: Lens' DescribeKeywordsResponse (Maybe Text)
- describeKeywordsResponse_originationIdentityArn :: Lens' DescribeKeywordsResponse (Maybe Text)
- describeKeywordsResponse_httpStatus :: Lens' DescribeKeywordsResponse Int
- describeOptOutLists_maxResults :: Lens' DescribeOptOutLists (Maybe Natural)
- describeOptOutLists_nextToken :: Lens' DescribeOptOutLists (Maybe Text)
- describeOptOutLists_optOutListNames :: Lens' DescribeOptOutLists (Maybe [Text])
- describeOptOutListsResponse_nextToken :: Lens' DescribeOptOutListsResponse (Maybe Text)
- describeOptOutListsResponse_optOutLists :: Lens' DescribeOptOutListsResponse (Maybe [OptOutListInformation])
- describeOptOutListsResponse_httpStatus :: Lens' DescribeOptOutListsResponse Int
- describeOptedOutNumbers_filters :: Lens' DescribeOptedOutNumbers (Maybe [OptedOutFilter])
- describeOptedOutNumbers_maxResults :: Lens' DescribeOptedOutNumbers (Maybe Natural)
- describeOptedOutNumbers_nextToken :: Lens' DescribeOptedOutNumbers (Maybe Text)
- describeOptedOutNumbers_optedOutNumbers :: Lens' DescribeOptedOutNumbers (Maybe [Text])
- describeOptedOutNumbers_optOutListName :: Lens' DescribeOptedOutNumbers Text
- describeOptedOutNumbersResponse_nextToken :: Lens' DescribeOptedOutNumbersResponse (Maybe Text)
- describeOptedOutNumbersResponse_optOutListArn :: Lens' DescribeOptedOutNumbersResponse (Maybe Text)
- describeOptedOutNumbersResponse_optOutListName :: Lens' DescribeOptedOutNumbersResponse (Maybe Text)
- describeOptedOutNumbersResponse_optedOutNumbers :: Lens' DescribeOptedOutNumbersResponse (Maybe [OptedOutNumberInformation])
- describeOptedOutNumbersResponse_httpStatus :: Lens' DescribeOptedOutNumbersResponse Int
- describePhoneNumbers_filters :: Lens' DescribePhoneNumbers (Maybe [PhoneNumberFilter])
- describePhoneNumbers_maxResults :: Lens' DescribePhoneNumbers (Maybe Natural)
- describePhoneNumbers_nextToken :: Lens' DescribePhoneNumbers (Maybe Text)
- describePhoneNumbers_phoneNumberIds :: Lens' DescribePhoneNumbers (Maybe [Text])
- describePhoneNumbersResponse_nextToken :: Lens' DescribePhoneNumbersResponse (Maybe Text)
- describePhoneNumbersResponse_phoneNumbers :: Lens' DescribePhoneNumbersResponse (Maybe [PhoneNumberInformation])
- describePhoneNumbersResponse_httpStatus :: Lens' DescribePhoneNumbersResponse Int
- describePools_filters :: Lens' DescribePools (Maybe [PoolFilter])
- describePools_maxResults :: Lens' DescribePools (Maybe Natural)
- describePools_nextToken :: Lens' DescribePools (Maybe Text)
- describePools_poolIds :: Lens' DescribePools (Maybe [Text])
- describePoolsResponse_nextToken :: Lens' DescribePoolsResponse (Maybe Text)
- describePoolsResponse_pools :: Lens' DescribePoolsResponse (Maybe [PoolInformation])
- describePoolsResponse_httpStatus :: Lens' DescribePoolsResponse Int
- describeSenderIds_filters :: Lens' DescribeSenderIds (Maybe [SenderIdFilter])
- describeSenderIds_maxResults :: Lens' DescribeSenderIds (Maybe Natural)
- describeSenderIds_nextToken :: Lens' DescribeSenderIds (Maybe Text)
- describeSenderIds_senderIds :: Lens' DescribeSenderIds (Maybe [SenderIdAndCountry])
- describeSenderIdsResponse_nextToken :: Lens' DescribeSenderIdsResponse (Maybe Text)
- describeSenderIdsResponse_senderIds :: Lens' DescribeSenderIdsResponse (Maybe [SenderIdInformation])
- describeSenderIdsResponse_httpStatus :: Lens' DescribeSenderIdsResponse Int
- describeSpendLimits_maxResults :: Lens' DescribeSpendLimits (Maybe Natural)
- describeSpendLimits_nextToken :: Lens' DescribeSpendLimits (Maybe Text)
- describeSpendLimitsResponse_nextToken :: Lens' DescribeSpendLimitsResponse (Maybe Text)
- describeSpendLimitsResponse_spendLimits :: Lens' DescribeSpendLimitsResponse (Maybe [SpendLimit])
- describeSpendLimitsResponse_httpStatus :: Lens' DescribeSpendLimitsResponse Int
- disassociateOriginationIdentity_clientToken :: Lens' DisassociateOriginationIdentity (Maybe Text)
- disassociateOriginationIdentity_poolId :: Lens' DisassociateOriginationIdentity Text
- disassociateOriginationIdentity_originationIdentity :: Lens' DisassociateOriginationIdentity Text
- disassociateOriginationIdentity_isoCountryCode :: Lens' DisassociateOriginationIdentity Text
- disassociateOriginationIdentityResponse_isoCountryCode :: Lens' DisassociateOriginationIdentityResponse (Maybe Text)
- disassociateOriginationIdentityResponse_originationIdentity :: Lens' DisassociateOriginationIdentityResponse (Maybe Text)
- disassociateOriginationIdentityResponse_originationIdentityArn :: Lens' DisassociateOriginationIdentityResponse (Maybe Text)
- disassociateOriginationIdentityResponse_poolArn :: Lens' DisassociateOriginationIdentityResponse (Maybe Text)
- disassociateOriginationIdentityResponse_poolId :: Lens' DisassociateOriginationIdentityResponse (Maybe Text)
- disassociateOriginationIdentityResponse_httpStatus :: Lens' DisassociateOriginationIdentityResponse Int
- listPoolOriginationIdentities_filters :: Lens' ListPoolOriginationIdentities (Maybe [PoolOriginationIdentitiesFilter])
- listPoolOriginationIdentities_maxResults :: Lens' ListPoolOriginationIdentities (Maybe Natural)
- listPoolOriginationIdentities_nextToken :: Lens' ListPoolOriginationIdentities (Maybe Text)
- listPoolOriginationIdentities_poolId :: Lens' ListPoolOriginationIdentities Text
- listPoolOriginationIdentitiesResponse_nextToken :: Lens' ListPoolOriginationIdentitiesResponse (Maybe Text)
- listPoolOriginationIdentitiesResponse_originationIdentities :: Lens' ListPoolOriginationIdentitiesResponse (Maybe [OriginationIdentityMetadata])
- listPoolOriginationIdentitiesResponse_poolArn :: Lens' ListPoolOriginationIdentitiesResponse (Maybe Text)
- listPoolOriginationIdentitiesResponse_poolId :: Lens' ListPoolOriginationIdentitiesResponse (Maybe Text)
- listPoolOriginationIdentitiesResponse_httpStatus :: Lens' ListPoolOriginationIdentitiesResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- putKeyword_keywordAction :: Lens' PutKeyword (Maybe KeywordAction)
- putKeyword_originationIdentity :: Lens' PutKeyword Text
- putKeyword_keyword :: Lens' PutKeyword Text
- putKeyword_keywordMessage :: Lens' PutKeyword Text
- putKeywordResponse_keyword :: Lens' PutKeywordResponse (Maybe Text)
- putKeywordResponse_keywordAction :: Lens' PutKeywordResponse (Maybe KeywordAction)
- putKeywordResponse_keywordMessage :: Lens' PutKeywordResponse (Maybe Text)
- putKeywordResponse_originationIdentity :: Lens' PutKeywordResponse (Maybe Text)
- putKeywordResponse_originationIdentityArn :: Lens' PutKeywordResponse (Maybe Text)
- putKeywordResponse_httpStatus :: Lens' PutKeywordResponse Int
- putOptedOutNumber_optOutListName :: Lens' PutOptedOutNumber Text
- putOptedOutNumber_optedOutNumber :: Lens' PutOptedOutNumber Text
- putOptedOutNumberResponse_endUserOptedOut :: Lens' PutOptedOutNumberResponse (Maybe Bool)
- putOptedOutNumberResponse_optOutListArn :: Lens' PutOptedOutNumberResponse (Maybe Text)
- putOptedOutNumberResponse_optOutListName :: Lens' PutOptedOutNumberResponse (Maybe Text)
- putOptedOutNumberResponse_optedOutNumber :: Lens' PutOptedOutNumberResponse (Maybe Text)
- putOptedOutNumberResponse_optedOutTimestamp :: Lens' PutOptedOutNumberResponse (Maybe UTCTime)
- putOptedOutNumberResponse_httpStatus :: Lens' PutOptedOutNumberResponse Int
- releasePhoneNumber_phoneNumberId :: Lens' ReleasePhoneNumber Text
- releasePhoneNumberResponse_createdTimestamp :: Lens' ReleasePhoneNumberResponse (Maybe UTCTime)
- releasePhoneNumberResponse_isoCountryCode :: Lens' ReleasePhoneNumberResponse (Maybe Text)
- releasePhoneNumberResponse_messageType :: Lens' ReleasePhoneNumberResponse (Maybe MessageType)
- releasePhoneNumberResponse_monthlyLeasingPrice :: Lens' ReleasePhoneNumberResponse (Maybe Text)
- releasePhoneNumberResponse_numberCapabilities :: Lens' ReleasePhoneNumberResponse (Maybe (NonEmpty NumberCapability))
- releasePhoneNumberResponse_numberType :: Lens' ReleasePhoneNumberResponse (Maybe NumberType)
- releasePhoneNumberResponse_optOutListName :: Lens' ReleasePhoneNumberResponse (Maybe Text)
- releasePhoneNumberResponse_phoneNumber :: Lens' ReleasePhoneNumberResponse (Maybe Text)
- releasePhoneNumberResponse_phoneNumberArn :: Lens' ReleasePhoneNumberResponse (Maybe Text)
- releasePhoneNumberResponse_phoneNumberId :: Lens' ReleasePhoneNumberResponse (Maybe Text)
- releasePhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' ReleasePhoneNumberResponse (Maybe Bool)
- releasePhoneNumberResponse_status :: Lens' ReleasePhoneNumberResponse (Maybe NumberStatus)
- releasePhoneNumberResponse_twoWayChannelArn :: Lens' ReleasePhoneNumberResponse (Maybe Text)
- releasePhoneNumberResponse_twoWayEnabled :: Lens' ReleasePhoneNumberResponse (Maybe Bool)
- releasePhoneNumberResponse_httpStatus :: Lens' ReleasePhoneNumberResponse Int
- requestPhoneNumber_clientToken :: Lens' RequestPhoneNumber (Maybe Text)
- requestPhoneNumber_deletionProtectionEnabled :: Lens' RequestPhoneNumber (Maybe Bool)
- requestPhoneNumber_optOutListName :: Lens' RequestPhoneNumber (Maybe Text)
- requestPhoneNumber_poolId :: Lens' RequestPhoneNumber (Maybe Text)
- requestPhoneNumber_registrationId :: Lens' RequestPhoneNumber (Maybe Text)
- requestPhoneNumber_tags :: Lens' RequestPhoneNumber (Maybe [Tag])
- requestPhoneNumber_isoCountryCode :: Lens' RequestPhoneNumber Text
- requestPhoneNumber_messageType :: Lens' RequestPhoneNumber MessageType
- requestPhoneNumber_numberCapabilities :: Lens' RequestPhoneNumber (NonEmpty NumberCapability)
- requestPhoneNumber_numberType :: Lens' RequestPhoneNumber RequestableNumberType
- requestPhoneNumberResponse_createdTimestamp :: Lens' RequestPhoneNumberResponse (Maybe UTCTime)
- requestPhoneNumberResponse_deletionProtectionEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool)
- requestPhoneNumberResponse_isoCountryCode :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_messageType :: Lens' RequestPhoneNumberResponse (Maybe MessageType)
- requestPhoneNumberResponse_monthlyLeasingPrice :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_numberCapabilities :: Lens' RequestPhoneNumberResponse (Maybe (NonEmpty NumberCapability))
- requestPhoneNumberResponse_numberType :: Lens' RequestPhoneNumberResponse (Maybe RequestableNumberType)
- requestPhoneNumberResponse_optOutListName :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_phoneNumber :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_phoneNumberArn :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_phoneNumberId :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_poolId :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool)
- requestPhoneNumberResponse_status :: Lens' RequestPhoneNumberResponse (Maybe NumberStatus)
- requestPhoneNumberResponse_tags :: Lens' RequestPhoneNumberResponse (Maybe [Tag])
- requestPhoneNumberResponse_twoWayChannelArn :: Lens' RequestPhoneNumberResponse (Maybe Text)
- requestPhoneNumberResponse_twoWayEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool)
- requestPhoneNumberResponse_httpStatus :: Lens' RequestPhoneNumberResponse Int
- sendTextMessage_configurationSetName :: Lens' SendTextMessage (Maybe Text)
- sendTextMessage_context :: Lens' SendTextMessage (Maybe (HashMap Text Text))
- sendTextMessage_destinationCountryParameters :: Lens' SendTextMessage (Maybe (HashMap DestinationCountryParameterKey Text))
- sendTextMessage_dryRun :: Lens' SendTextMessage (Maybe Bool)
- sendTextMessage_keyword :: Lens' SendTextMessage (Maybe Text)
- sendTextMessage_maxPrice :: Lens' SendTextMessage (Maybe Text)
- sendTextMessage_messageBody :: Lens' SendTextMessage (Maybe Text)
- sendTextMessage_messageType :: Lens' SendTextMessage (Maybe MessageType)
- sendTextMessage_originationIdentity :: Lens' SendTextMessage (Maybe Text)
- sendTextMessage_timeToLive :: Lens' SendTextMessage (Maybe Natural)
- sendTextMessage_destinationPhoneNumber :: Lens' SendTextMessage Text
- sendTextMessageResponse_messageId :: Lens' SendTextMessageResponse (Maybe Text)
- sendTextMessageResponse_httpStatus :: Lens' SendTextMessageResponse Int
- sendVoiceMessage_configurationSetName :: Lens' SendVoiceMessage (Maybe Text)
- sendVoiceMessage_context :: Lens' SendVoiceMessage (Maybe (HashMap Text Text))
- sendVoiceMessage_dryRun :: Lens' SendVoiceMessage (Maybe Bool)
- sendVoiceMessage_maxPricePerMinute :: Lens' SendVoiceMessage (Maybe Text)
- sendVoiceMessage_messageBody :: Lens' SendVoiceMessage (Maybe Text)
- sendVoiceMessage_messageBodyTextType :: Lens' SendVoiceMessage (Maybe VoiceMessageBodyTextType)
- sendVoiceMessage_timeToLive :: Lens' SendVoiceMessage (Maybe Natural)
- sendVoiceMessage_voiceId :: Lens' SendVoiceMessage (Maybe VoiceId)
- sendVoiceMessage_destinationPhoneNumber :: Lens' SendVoiceMessage Text
- sendVoiceMessage_originationIdentity :: Lens' SendVoiceMessage Text
- sendVoiceMessageResponse_messageId :: Lens' SendVoiceMessageResponse (Maybe Text)
- sendVoiceMessageResponse_httpStatus :: Lens' SendVoiceMessageResponse Int
- setDefaultMessageType_configurationSetName :: Lens' SetDefaultMessageType Text
- setDefaultMessageType_messageType :: Lens' SetDefaultMessageType MessageType
- setDefaultMessageTypeResponse_configurationSetArn :: Lens' SetDefaultMessageTypeResponse (Maybe Text)
- setDefaultMessageTypeResponse_configurationSetName :: Lens' SetDefaultMessageTypeResponse (Maybe Text)
- setDefaultMessageTypeResponse_messageType :: Lens' SetDefaultMessageTypeResponse (Maybe MessageType)
- setDefaultMessageTypeResponse_httpStatus :: Lens' SetDefaultMessageTypeResponse Int
- setDefaultSenderId_configurationSetName :: Lens' SetDefaultSenderId Text
- setDefaultSenderId_senderId :: Lens' SetDefaultSenderId Text
- setDefaultSenderIdResponse_configurationSetArn :: Lens' SetDefaultSenderIdResponse (Maybe Text)
- setDefaultSenderIdResponse_configurationSetName :: Lens' SetDefaultSenderIdResponse (Maybe Text)
- setDefaultSenderIdResponse_senderId :: Lens' SetDefaultSenderIdResponse (Maybe Text)
- setDefaultSenderIdResponse_httpStatus :: Lens' SetDefaultSenderIdResponse Int
- setTextMessageSpendLimitOverride_monthlyLimit :: Lens' SetTextMessageSpendLimitOverride Natural
- setTextMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' SetTextMessageSpendLimitOverrideResponse (Maybe Natural)
- setTextMessageSpendLimitOverrideResponse_httpStatus :: Lens' SetTextMessageSpendLimitOverrideResponse Int
- setVoiceMessageSpendLimitOverride_monthlyLimit :: Lens' SetVoiceMessageSpendLimitOverride Natural
- setVoiceMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' SetVoiceMessageSpendLimitOverrideResponse (Maybe Natural)
- setVoiceMessageSpendLimitOverrideResponse_httpStatus :: Lens' SetVoiceMessageSpendLimitOverrideResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (NonEmpty Tag)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateEventDestination_cloudWatchLogsDestination :: Lens' UpdateEventDestination (Maybe CloudWatchLogsDestination)
- updateEventDestination_enabled :: Lens' UpdateEventDestination (Maybe Bool)
- updateEventDestination_kinesisFirehoseDestination :: Lens' UpdateEventDestination (Maybe KinesisFirehoseDestination)
- updateEventDestination_matchingEventTypes :: Lens' UpdateEventDestination (Maybe (NonEmpty EventType))
- updateEventDestination_snsDestination :: Lens' UpdateEventDestination (Maybe SnsDestination)
- updateEventDestination_configurationSetName :: Lens' UpdateEventDestination Text
- updateEventDestination_eventDestinationName :: Lens' UpdateEventDestination Text
- updateEventDestinationResponse_configurationSetArn :: Lens' UpdateEventDestinationResponse (Maybe Text)
- updateEventDestinationResponse_configurationSetName :: Lens' UpdateEventDestinationResponse (Maybe Text)
- updateEventDestinationResponse_eventDestination :: Lens' UpdateEventDestinationResponse (Maybe EventDestination)
- updateEventDestinationResponse_httpStatus :: Lens' UpdateEventDestinationResponse Int
- updatePhoneNumber_deletionProtectionEnabled :: Lens' UpdatePhoneNumber (Maybe Bool)
- updatePhoneNumber_optOutListName :: Lens' UpdatePhoneNumber (Maybe Text)
- updatePhoneNumber_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumber (Maybe Bool)
- updatePhoneNumber_twoWayChannelArn :: Lens' UpdatePhoneNumber (Maybe Text)
- updatePhoneNumber_twoWayEnabled :: Lens' UpdatePhoneNumber (Maybe Bool)
- updatePhoneNumber_phoneNumberId :: Lens' UpdatePhoneNumber Text
- updatePhoneNumberResponse_createdTimestamp :: Lens' UpdatePhoneNumberResponse (Maybe UTCTime)
- updatePhoneNumberResponse_deletionProtectionEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool)
- updatePhoneNumberResponse_isoCountryCode :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_messageType :: Lens' UpdatePhoneNumberResponse (Maybe MessageType)
- updatePhoneNumberResponse_monthlyLeasingPrice :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_numberCapabilities :: Lens' UpdatePhoneNumberResponse (Maybe (NonEmpty NumberCapability))
- updatePhoneNumberResponse_numberType :: Lens' UpdatePhoneNumberResponse (Maybe NumberType)
- updatePhoneNumberResponse_optOutListName :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_phoneNumber :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_phoneNumberArn :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_phoneNumberId :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool)
- updatePhoneNumberResponse_status :: Lens' UpdatePhoneNumberResponse (Maybe NumberStatus)
- updatePhoneNumberResponse_twoWayChannelArn :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_twoWayEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool)
- updatePhoneNumberResponse_httpStatus :: Lens' UpdatePhoneNumberResponse Int
- updatePool_deletionProtectionEnabled :: Lens' UpdatePool (Maybe Bool)
- updatePool_optOutListName :: Lens' UpdatePool (Maybe Text)
- updatePool_selfManagedOptOutsEnabled :: Lens' UpdatePool (Maybe Bool)
- updatePool_sharedRoutesEnabled :: Lens' UpdatePool (Maybe Bool)
- updatePool_twoWayChannelArn :: Lens' UpdatePool (Maybe Text)
- updatePool_twoWayEnabled :: Lens' UpdatePool (Maybe Bool)
- updatePool_poolId :: Lens' UpdatePool Text
- updatePoolResponse_createdTimestamp :: Lens' UpdatePoolResponse (Maybe UTCTime)
- updatePoolResponse_deletionProtectionEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
- updatePoolResponse_messageType :: Lens' UpdatePoolResponse (Maybe MessageType)
- updatePoolResponse_optOutListName :: Lens' UpdatePoolResponse (Maybe Text)
- updatePoolResponse_poolArn :: Lens' UpdatePoolResponse (Maybe Text)
- updatePoolResponse_poolId :: Lens' UpdatePoolResponse (Maybe Text)
- updatePoolResponse_selfManagedOptOutsEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
- updatePoolResponse_sharedRoutesEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
- updatePoolResponse_status :: Lens' UpdatePoolResponse (Maybe PoolStatus)
- updatePoolResponse_twoWayChannelArn :: Lens' UpdatePoolResponse (Maybe Text)
- updatePoolResponse_twoWayEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
- updatePoolResponse_httpStatus :: Lens' UpdatePoolResponse Int
- accountAttribute_name :: Lens' AccountAttribute AccountAttributeName
- accountAttribute_value :: Lens' AccountAttribute Text
- accountLimit_name :: Lens' AccountLimit AccountLimitName
- accountLimit_used :: Lens' AccountLimit Integer
- accountLimit_max :: Lens' AccountLimit Integer
- cloudWatchLogsDestination_iamRoleArn :: Lens' CloudWatchLogsDestination Text
- cloudWatchLogsDestination_logGroupArn :: Lens' CloudWatchLogsDestination Text
- configurationSetFilter_name :: Lens' ConfigurationSetFilter ConfigurationSetFilterName
- configurationSetFilter_values :: Lens' ConfigurationSetFilter (NonEmpty Text)
- configurationSetInformation_defaultMessageType :: Lens' ConfigurationSetInformation (Maybe MessageType)
- configurationSetInformation_defaultSenderId :: Lens' ConfigurationSetInformation (Maybe Text)
- configurationSetInformation_configurationSetArn :: Lens' ConfigurationSetInformation Text
- configurationSetInformation_configurationSetName :: Lens' ConfigurationSetInformation Text
- configurationSetInformation_eventDestinations :: Lens' ConfigurationSetInformation [EventDestination]
- configurationSetInformation_createdTimestamp :: Lens' ConfigurationSetInformation UTCTime
- eventDestination_cloudWatchLogsDestination :: Lens' EventDestination (Maybe CloudWatchLogsDestination)
- eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination)
- eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination)
- eventDestination_eventDestinationName :: Lens' EventDestination Text
- eventDestination_enabled :: Lens' EventDestination Bool
- eventDestination_matchingEventTypes :: Lens' EventDestination (NonEmpty EventType)
- keywordFilter_name :: Lens' KeywordFilter KeywordFilterName
- keywordFilter_values :: Lens' KeywordFilter (NonEmpty Text)
- keywordInformation_keyword :: Lens' KeywordInformation Text
- keywordInformation_keywordMessage :: Lens' KeywordInformation Text
- keywordInformation_keywordAction :: Lens' KeywordInformation KeywordAction
- kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text
- kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text
- optOutListInformation_optOutListArn :: Lens' OptOutListInformation Text
- optOutListInformation_optOutListName :: Lens' OptOutListInformation Text
- optOutListInformation_createdTimestamp :: Lens' OptOutListInformation UTCTime
- optedOutFilter_name :: Lens' OptedOutFilter OptedOutFilterName
- optedOutFilter_values :: Lens' OptedOutFilter (NonEmpty Text)
- optedOutNumberInformation_optedOutNumber :: Lens' OptedOutNumberInformation Text
- optedOutNumberInformation_optedOutTimestamp :: Lens' OptedOutNumberInformation UTCTime
- optedOutNumberInformation_endUserOptedOut :: Lens' OptedOutNumberInformation Bool
- originationIdentityMetadata_originationIdentityArn :: Lens' OriginationIdentityMetadata Text
- originationIdentityMetadata_originationIdentity :: Lens' OriginationIdentityMetadata Text
- originationIdentityMetadata_isoCountryCode :: Lens' OriginationIdentityMetadata Text
- originationIdentityMetadata_numberCapabilities :: Lens' OriginationIdentityMetadata (NonEmpty NumberCapability)
- phoneNumberFilter_name :: Lens' PhoneNumberFilter PhoneNumberFilterName
- phoneNumberFilter_values :: Lens' PhoneNumberFilter (NonEmpty Text)
- phoneNumberInformation_phoneNumberId :: Lens' PhoneNumberInformation (Maybe Text)
- phoneNumberInformation_poolId :: Lens' PhoneNumberInformation (Maybe Text)
- phoneNumberInformation_twoWayChannelArn :: Lens' PhoneNumberInformation (Maybe Text)
- phoneNumberInformation_phoneNumberArn :: Lens' PhoneNumberInformation Text
- phoneNumberInformation_phoneNumber :: Lens' PhoneNumberInformation Text
- phoneNumberInformation_status :: Lens' PhoneNumberInformation NumberStatus
- phoneNumberInformation_isoCountryCode :: Lens' PhoneNumberInformation Text
- phoneNumberInformation_messageType :: Lens' PhoneNumberInformation MessageType
- phoneNumberInformation_numberCapabilities :: Lens' PhoneNumberInformation (NonEmpty NumberCapability)
- phoneNumberInformation_numberType :: Lens' PhoneNumberInformation NumberType
- phoneNumberInformation_monthlyLeasingPrice :: Lens' PhoneNumberInformation Text
- phoneNumberInformation_twoWayEnabled :: Lens' PhoneNumberInformation Bool
- phoneNumberInformation_selfManagedOptOutsEnabled :: Lens' PhoneNumberInformation Bool
- phoneNumberInformation_optOutListName :: Lens' PhoneNumberInformation Text
- phoneNumberInformation_deletionProtectionEnabled :: Lens' PhoneNumberInformation Bool
- phoneNumberInformation_createdTimestamp :: Lens' PhoneNumberInformation UTCTime
- poolFilter_name :: Lens' PoolFilter PoolFilterName
- poolFilter_values :: Lens' PoolFilter (NonEmpty Text)
- poolInformation_twoWayChannelArn :: Lens' PoolInformation (Maybe Text)
- poolInformation_poolArn :: Lens' PoolInformation Text
- poolInformation_poolId :: Lens' PoolInformation Text
- poolInformation_status :: Lens' PoolInformation PoolStatus
- poolInformation_messageType :: Lens' PoolInformation MessageType
- poolInformation_twoWayEnabled :: Lens' PoolInformation Bool
- poolInformation_selfManagedOptOutsEnabled :: Lens' PoolInformation Bool
- poolInformation_optOutListName :: Lens' PoolInformation Text
- poolInformation_sharedRoutesEnabled :: Lens' PoolInformation Bool
- poolInformation_deletionProtectionEnabled :: Lens' PoolInformation Bool
- poolInformation_createdTimestamp :: Lens' PoolInformation UTCTime
- poolOriginationIdentitiesFilter_name :: Lens' PoolOriginationIdentitiesFilter PoolOriginationIdentitiesFilterName
- poolOriginationIdentitiesFilter_values :: Lens' PoolOriginationIdentitiesFilter (NonEmpty Text)
- senderIdAndCountry_senderId :: Lens' SenderIdAndCountry Text
- senderIdAndCountry_isoCountryCode :: Lens' SenderIdAndCountry Text
- senderIdFilter_name :: Lens' SenderIdFilter SenderIdFilterName
- senderIdFilter_values :: Lens' SenderIdFilter (NonEmpty Text)
- senderIdInformation_senderIdArn :: Lens' SenderIdInformation Text
- senderIdInformation_senderId :: Lens' SenderIdInformation Text
- senderIdInformation_isoCountryCode :: Lens' SenderIdInformation Text
- senderIdInformation_messageTypes :: Lens' SenderIdInformation [MessageType]
- senderIdInformation_monthlyLeasingPrice :: Lens' SenderIdInformation Text
- snsDestination_topicArn :: Lens' SnsDestination Text
- spendLimit_name :: Lens' SpendLimit SpendLimitName
- spendLimit_enforcedLimit :: Lens' SpendLimit Integer
- spendLimit_maxLimit :: Lens' SpendLimit Integer
- spendLimit_overridden :: Lens' SpendLimit Bool
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Operations
AssociateOriginationIdentity
associateOriginationIdentity_clientToken :: Lens' AssociateOriginationIdentity (Maybe Text) Source #
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_poolId :: Lens' AssociateOriginationIdentity Text Source #
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_originationIdentity :: Lens' AssociateOriginationIdentity Text Source #
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_isoCountryCode :: Lens' AssociateOriginationIdentity Text Source #
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
associateOriginationIdentityResponse_isoCountryCode :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
associateOriginationIdentityResponse_originationIdentity :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The PhoneNumberId or SenderId of the origination identity.
associateOriginationIdentityResponse_originationIdentityArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The PhoneNumberArn or SenderIdArn of the origination identity.
associateOriginationIdentityResponse_poolArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
associateOriginationIdentityResponse_poolId :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The PoolId of the pool that is now associated with the origination identity.
associateOriginationIdentityResponse_httpStatus :: Lens' AssociateOriginationIdentityResponse Int Source #
The response's http status code.
CreateConfigurationSet
createConfigurationSet_clientToken :: Lens' CreateConfigurationSet (Maybe Text) Source #
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_tags :: Lens' CreateConfigurationSet (Maybe [Tag]) Source #
An array of key and value pair tags that's associated with the new configuration set.
createConfigurationSet_configurationSetName :: Lens' CreateConfigurationSet Text Source #
The name to use for the new configuration set.
createConfigurationSetResponse_configurationSetArn :: Lens' CreateConfigurationSetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the newly created configuration set.
createConfigurationSetResponse_configurationSetName :: Lens' CreateConfigurationSetResponse (Maybe Text) Source #
The name of the new configuration set.
createConfigurationSetResponse_createdTimestamp :: Lens' CreateConfigurationSetResponse (Maybe UTCTime) Source #
The time when the configuration set was created, in UNIX epoch time format.
createConfigurationSetResponse_tags :: Lens' CreateConfigurationSetResponse (Maybe [Tag]) Source #
An array of key and value pair tags that's associated with the configuration set.
createConfigurationSetResponse_httpStatus :: Lens' CreateConfigurationSetResponse Int Source #
The response's http status code.
CreateEventDestination
createEventDestination_clientToken :: Lens' CreateEventDestination (Maybe Text) Source #
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_cloudWatchLogsDestination :: Lens' CreateEventDestination (Maybe CloudWatchLogsDestination) Source #
An object that contains information about an event destination for logging to Amazon CloudWatch logs.
createEventDestination_kinesisFirehoseDestination :: Lens' CreateEventDestination (Maybe KinesisFirehoseDestination) Source #
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
createEventDestination_snsDestination :: Lens' CreateEventDestination (Maybe SnsDestination) Source #
An object that contains information about an event destination for logging to Amazon SNS.
createEventDestination_configurationSetName :: Lens' CreateEventDestination Text Source #
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_eventDestinationName :: Lens' CreateEventDestination Text Source #
The name that identifies the event destination.
createEventDestination_matchingEventTypes :: Lens' CreateEventDestination (NonEmpty EventType) Source #
An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.
createEventDestinationResponse_configurationSetArn :: Lens' CreateEventDestinationResponse (Maybe Text) Source #
The ARN of the configuration set.
createEventDestinationResponse_configurationSetName :: Lens' CreateEventDestinationResponse (Maybe Text) Source #
The name of the configuration set.
createEventDestinationResponse_eventDestination :: Lens' CreateEventDestinationResponse (Maybe EventDestination) Source #
The details of the destination where events are logged.
createEventDestinationResponse_httpStatus :: Lens' CreateEventDestinationResponse Int Source #
The response's http status code.
CreateOptOutList
createOptOutList_clientToken :: Lens' CreateOptOutList (Maybe Text) Source #
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_tags :: Lens' CreateOptOutList (Maybe [Tag]) Source #
An array of tags (key and value pairs) to associate with the new OptOutList.
createOptOutList_optOutListName :: Lens' CreateOptOutList Text Source #
The name of the new OptOutList.
createOptOutListResponse_createdTimestamp :: Lens' CreateOptOutListResponse (Maybe UTCTime) Source #
The time when the pool was created, in UNIX epoch time format.
createOptOutListResponse_optOutListArn :: Lens' CreateOptOutListResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the OptOutList.
createOptOutListResponse_optOutListName :: Lens' CreateOptOutListResponse (Maybe Text) Source #
The name of the new OptOutList.
createOptOutListResponse_tags :: Lens' CreateOptOutListResponse (Maybe [Tag]) Source #
An array of tags (key and value pairs) associated with the new OptOutList.
createOptOutListResponse_httpStatus :: Lens' CreateOptOutListResponse Int Source #
The response's http status code.
CreatePool
createPool_clientToken :: Lens' CreatePool (Maybe Text) Source #
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_deletionProtectionEnabled :: Lens' CreatePool (Maybe Bool) Source #
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_tags :: Lens' CreatePool (Maybe [Tag]) Source #
An array of tags (key and value pairs) associated with the pool.
createPool_originationIdentity :: Lens' CreatePool Text Source #
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_isoCountryCode :: Lens' CreatePool Text Source #
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
createPool_messageType :: Lens' CreatePool MessageType Source #
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.
createPoolResponse_createdTimestamp :: Lens' CreatePoolResponse (Maybe UTCTime) Source #
The time when the pool was created, in UNIX epoch time format.
createPoolResponse_deletionProtectionEnabled :: Lens' CreatePoolResponse (Maybe Bool) Source #
When set to true deletion protection is enabled. By default this is set to false.
createPoolResponse_messageType :: Lens' CreatePoolResponse (Maybe MessageType) Source #
The type of message for the pool to use.
createPoolResponse_optOutListName :: Lens' CreatePoolResponse (Maybe Text) Source #
The name of the OptOutList associated with the pool.
createPoolResponse_poolArn :: Lens' CreatePoolResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the pool.
createPoolResponse_poolId :: Lens' CreatePoolResponse (Maybe Text) Source #
The unique identifier for the pool.
createPoolResponse_selfManagedOptOutsEnabled :: Lens' CreatePoolResponse (Maybe Bool) Source #
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_sharedRoutesEnabled :: Lens' CreatePoolResponse (Maybe Bool) Source #
Indicates whether shared routes are enabled for the pool.
createPoolResponse_status :: Lens' CreatePoolResponse (Maybe PoolStatus) Source #
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.
createPoolResponse_tags :: Lens' CreatePoolResponse (Maybe [Tag]) Source #
An array of tags (key and value pairs) associated with the pool.
createPoolResponse_twoWayChannelArn :: Lens' CreatePoolResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
createPoolResponse_twoWayEnabled :: Lens' CreatePoolResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
createPoolResponse_httpStatus :: Lens' CreatePoolResponse Int Source #
The response's http status code.
DeleteConfigurationSet
deleteConfigurationSet_configurationSetName :: Lens' DeleteConfigurationSet Text Source #
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.
deleteConfigurationSetResponse_configurationSetArn :: Lens' DeleteConfigurationSetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the deleted configuration set.
deleteConfigurationSetResponse_configurationSetName :: Lens' DeleteConfigurationSetResponse (Maybe Text) Source #
The name of the deleted configuration set.
deleteConfigurationSetResponse_createdTimestamp :: Lens' DeleteConfigurationSetResponse (Maybe UTCTime) Source #
The time that the deleted configuration set was created in UNIX epoch time format.
deleteConfigurationSetResponse_defaultMessageType :: Lens' DeleteConfigurationSetResponse (Maybe MessageType) Source #
The default message type of the configuration set that was deleted.
deleteConfigurationSetResponse_defaultSenderId :: Lens' DeleteConfigurationSetResponse (Maybe Text) Source #
The default Sender ID of the configuration set that was deleted.
deleteConfigurationSetResponse_eventDestinations :: Lens' DeleteConfigurationSetResponse (Maybe [EventDestination]) Source #
An array of any EventDestination objects that were associated with the deleted configuration set.
deleteConfigurationSetResponse_httpStatus :: Lens' DeleteConfigurationSetResponse Int Source #
The response's http status code.
DeleteDefaultMessageType
deleteDefaultMessageType_configurationSetName :: Lens' DeleteDefaultMessageType Text Source #
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.
deleteDefaultMessageTypeResponse_configurationSetArn :: Lens' DeleteDefaultMessageTypeResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the configuration set.
deleteDefaultMessageTypeResponse_configurationSetName :: Lens' DeleteDefaultMessageTypeResponse (Maybe Text) Source #
The name of the configuration set.
deleteDefaultMessageTypeResponse_messageType :: Lens' DeleteDefaultMessageTypeResponse (Maybe MessageType) Source #
The current message type for the configuration set.
deleteDefaultMessageTypeResponse_httpStatus :: Lens' DeleteDefaultMessageTypeResponse Int Source #
The response's http status code.
DeleteDefaultSenderId
deleteDefaultSenderId_configurationSetName :: Lens' DeleteDefaultSenderId Text Source #
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.
deleteDefaultSenderIdResponse_configurationSetArn :: Lens' DeleteDefaultSenderIdResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the configuration set.
deleteDefaultSenderIdResponse_configurationSetName :: Lens' DeleteDefaultSenderIdResponse (Maybe Text) Source #
The name of the configuration set.
deleteDefaultSenderIdResponse_senderId :: Lens' DeleteDefaultSenderIdResponse (Maybe Text) Source #
The current sender ID for the configuration set.
deleteDefaultSenderIdResponse_httpStatus :: Lens' DeleteDefaultSenderIdResponse Int Source #
The response's http status code.
DeleteEventDestination
deleteEventDestination_configurationSetName :: Lens' DeleteEventDestination Text Source #
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_eventDestinationName :: Lens' DeleteEventDestination Text Source #
The name of the event destination to delete.
deleteEventDestinationResponse_configurationSetArn :: Lens' DeleteEventDestinationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the configuration set.
deleteEventDestinationResponse_configurationSetName :: Lens' DeleteEventDestinationResponse (Maybe Text) Source #
The name of the configuration set the event destination was deleted from.
deleteEventDestinationResponse_eventDestination :: Lens' DeleteEventDestinationResponse (Maybe EventDestination) Source #
The event destination object that was deleted.
deleteEventDestinationResponse_httpStatus :: Lens' DeleteEventDestinationResponse Int Source #
The response's http status code.
DeleteKeyword
deleteKeyword_originationIdentity :: Lens' DeleteKeyword Text Source #
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_keyword :: Lens' DeleteKeyword Text Source #
The keyword to delete.
deleteKeywordResponse_keyword :: Lens' DeleteKeywordResponse (Maybe Text) Source #
The keyword that was deleted.
deleteKeywordResponse_keywordAction :: Lens' DeleteKeywordResponse (Maybe KeywordAction) Source #
The action that was associated with the deleted keyword.
deleteKeywordResponse_keywordMessage :: Lens' DeleteKeywordResponse (Maybe Text) Source #
The message that was associated with the deleted keyword.
deleteKeywordResponse_originationIdentity :: Lens' DeleteKeywordResponse (Maybe Text) Source #
The PhoneNumberId or PoolId that the keyword was associated with.
deleteKeywordResponse_originationIdentityArn :: Lens' DeleteKeywordResponse (Maybe Text) Source #
The PhoneNumberArn or PoolArn that the keyword was associated with.
deleteKeywordResponse_httpStatus :: Lens' DeleteKeywordResponse Int Source #
The response's http status code.
DeleteOptOutList
deleteOptOutList_optOutListName :: Lens' DeleteOptOutList Text Source #
The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
deleteOptOutListResponse_createdTimestamp :: Lens' DeleteOptOutListResponse (Maybe UTCTime) Source #
The time when the OptOutList was created, in UNIX epoch time format.
deleteOptOutListResponse_optOutListArn :: Lens' DeleteOptOutListResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the OptOutList that was removed.
deleteOptOutListResponse_optOutListName :: Lens' DeleteOptOutListResponse (Maybe Text) Source #
The name of the OptOutList that was removed.
deleteOptOutListResponse_httpStatus :: Lens' DeleteOptOutListResponse Int Source #
The response's http status code.
DeleteOptedOutNumber
deleteOptedOutNumber_optOutListName :: Lens' DeleteOptedOutNumber Text Source #
The OptOutListName or OptOutListArn to remove the phone number from.
deleteOptedOutNumber_optedOutNumber :: Lens' DeleteOptedOutNumber Text Source #
The phone number, in E.164 format, to remove from the OptOutList.
deleteOptedOutNumberResponse_endUserOptedOut :: Lens' DeleteOptedOutNumberResponse (Maybe Bool) Source #
This is true if it was the end user who requested their phone number be removed.
deleteOptedOutNumberResponse_optOutListArn :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #
The OptOutListArn that the phone number was removed from.
deleteOptedOutNumberResponse_optOutListName :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #
The OptOutListName that the phone number was removed from.
deleteOptedOutNumberResponse_optedOutNumber :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #
The phone number that was removed from the OptOutList.
deleteOptedOutNumberResponse_optedOutTimestamp :: Lens' DeleteOptedOutNumberResponse (Maybe UTCTime) Source #
The time that the number was removed at, in UNIX epoch time format.
deleteOptedOutNumberResponse_httpStatus :: Lens' DeleteOptedOutNumberResponse Int Source #
The response's http status code.
DeletePool
deletePool_poolId :: Lens' DeletePool Text Source #
The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
deletePoolResponse_createdTimestamp :: Lens' DeletePoolResponse (Maybe UTCTime) Source #
The time when the pool was created, in UNIX epoch time format.
deletePoolResponse_messageType :: Lens' DeletePoolResponse (Maybe MessageType) Source #
The message type that was associated with the deleted pool.
deletePoolResponse_optOutListName :: Lens' DeletePoolResponse (Maybe Text) Source #
The name of the OptOutList that was associated with the deleted pool.
deletePoolResponse_poolArn :: Lens' DeletePoolResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pool that was deleted.
deletePoolResponse_poolId :: Lens' DeletePoolResponse (Maybe Text) Source #
The PoolId of the pool that was deleted.
deletePoolResponse_selfManagedOptOutsEnabled :: Lens' DeletePoolResponse (Maybe Bool) Source #
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_sharedRoutesEnabled :: Lens' DeletePoolResponse (Maybe Bool) Source #
Indicates whether shared routes are enabled for the pool.
deletePoolResponse_status :: Lens' DeletePoolResponse (Maybe PoolStatus) Source #
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_twoWayChannelArn :: Lens' DeletePoolResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the TwoWayChannel.
deletePoolResponse_twoWayEnabled :: Lens' DeletePoolResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
deletePoolResponse_httpStatus :: Lens' DeletePoolResponse Int Source #
The response's http status code.
DeleteTextMessageSpendLimitOverride
deleteTextMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' DeleteTextMessageSpendLimitOverrideResponse (Maybe Natural) Source #
The current monthly limit, in US dollars.
deleteTextMessageSpendLimitOverrideResponse_httpStatus :: Lens' DeleteTextMessageSpendLimitOverrideResponse Int Source #
The response's http status code.
DeleteVoiceMessageSpendLimitOverride
deleteVoiceMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' DeleteVoiceMessageSpendLimitOverrideResponse (Maybe Natural) Source #
The current monthly limit, in US dollars.
deleteVoiceMessageSpendLimitOverrideResponse_httpStatus :: Lens' DeleteVoiceMessageSpendLimitOverrideResponse Int Source #
The response's http status code.
DescribeAccountAttributes
describeAccountAttributes_maxResults :: Lens' DescribeAccountAttributes (Maybe Natural) Source #
The maximum number of results to return per each request.
describeAccountAttributes_nextToken :: Lens' DescribeAccountAttributes (Maybe Text) Source #
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.
describeAccountAttributesResponse_accountAttributes :: Lens' DescribeAccountAttributesResponse (Maybe [AccountAttribute]) Source #
An array of AccountAttributes objects.
describeAccountAttributesResponse_nextToken :: Lens' DescribeAccountAttributesResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeAccountAttributesResponse_httpStatus :: Lens' DescribeAccountAttributesResponse Int Source #
The response's http status code.
DescribeAccountLimits
describeAccountLimits_maxResults :: Lens' DescribeAccountLimits (Maybe Natural) Source #
The maximum number of results to return per each request.
describeAccountLimits_nextToken :: Lens' DescribeAccountLimits (Maybe Text) Source #
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.
describeAccountLimitsResponse_accountLimits :: Lens' DescribeAccountLimitsResponse (Maybe [AccountLimit]) Source #
An array of AccountLimit objects that show the current spend limits.
describeAccountLimitsResponse_nextToken :: Lens' DescribeAccountLimitsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeAccountLimitsResponse_httpStatus :: Lens' DescribeAccountLimitsResponse Int Source #
The response's http status code.
DescribeConfigurationSets
describeConfigurationSets_configurationSetNames :: Lens' DescribeConfigurationSets (Maybe [Text]) Source #
An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
describeConfigurationSets_filters :: Lens' DescribeConfigurationSets (Maybe [ConfigurationSetFilter]) Source #
An array of filters to apply to the results that are returned.
describeConfigurationSets_maxResults :: Lens' DescribeConfigurationSets (Maybe Natural) Source #
The maximum number of results to return per each request.
describeConfigurationSets_nextToken :: Lens' DescribeConfigurationSets (Maybe Text) Source #
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.
describeConfigurationSetsResponse_configurationSets :: Lens' DescribeConfigurationSetsResponse (Maybe [ConfigurationSetInformation]) Source #
An array of ConfigurationSets objects.
describeConfigurationSetsResponse_nextToken :: Lens' DescribeConfigurationSetsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeConfigurationSetsResponse_httpStatus :: Lens' DescribeConfigurationSetsResponse Int Source #
The response's http status code.
DescribeKeywords
describeKeywords_filters :: Lens' DescribeKeywords (Maybe [KeywordFilter]) Source #
An array of keyword filters to filter the results.
describeKeywords_keywords :: Lens' DescribeKeywords (Maybe [Text]) Source #
An array of keywords to search for.
describeKeywords_maxResults :: Lens' DescribeKeywords (Maybe Natural) Source #
The maximum number of results to return per each request.
describeKeywords_nextToken :: Lens' DescribeKeywords (Maybe Text) Source #
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_originationIdentity :: Lens' DescribeKeywords Text Source #
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.
describeKeywordsResponse_keywords :: Lens' DescribeKeywordsResponse (Maybe [KeywordInformation]) Source #
An array of KeywordInformation objects that contain the results.
describeKeywordsResponse_nextToken :: Lens' DescribeKeywordsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeKeywordsResponse_originationIdentity :: Lens' DescribeKeywordsResponse (Maybe Text) Source #
The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
describeKeywordsResponse_originationIdentityArn :: Lens' DescribeKeywordsResponse (Maybe Text) Source #
The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
describeKeywordsResponse_httpStatus :: Lens' DescribeKeywordsResponse Int Source #
The response's http status code.
DescribeOptOutLists
describeOptOutLists_maxResults :: Lens' DescribeOptOutLists (Maybe Natural) Source #
The maximum number of results to return per each request.
describeOptOutLists_nextToken :: Lens' DescribeOptOutLists (Maybe Text) Source #
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.
describeOptOutLists_optOutListNames :: Lens' DescribeOptOutLists (Maybe [Text]) Source #
The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
describeOptOutListsResponse_nextToken :: Lens' DescribeOptOutListsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeOptOutListsResponse_optOutLists :: Lens' DescribeOptOutListsResponse (Maybe [OptOutListInformation]) Source #
An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
describeOptOutListsResponse_httpStatus :: Lens' DescribeOptOutListsResponse Int Source #
The response's http status code.
DescribeOptedOutNumbers
describeOptedOutNumbers_filters :: Lens' DescribeOptedOutNumbers (Maybe [OptedOutFilter]) Source #
An array of OptedOutFilter objects to filter the results on.
describeOptedOutNumbers_maxResults :: Lens' DescribeOptedOutNumbers (Maybe Natural) Source #
The maximum number of results to return per each request.
describeOptedOutNumbers_nextToken :: Lens' DescribeOptedOutNumbers (Maybe Text) Source #
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_optedOutNumbers :: Lens' DescribeOptedOutNumbers (Maybe [Text]) Source #
An array of phone numbers to search for in the OptOutList.
describeOptedOutNumbers_optOutListName :: Lens' DescribeOptedOutNumbers Text Source #
The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
describeOptedOutNumbersResponse_nextToken :: Lens' DescribeOptedOutNumbersResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeOptedOutNumbersResponse_optOutListArn :: Lens' DescribeOptedOutNumbersResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the OptOutList.
describeOptedOutNumbersResponse_optOutListName :: Lens' DescribeOptedOutNumbersResponse (Maybe Text) Source #
The name of the OptOutList.
describeOptedOutNumbersResponse_optedOutNumbers :: Lens' DescribeOptedOutNumbersResponse (Maybe [OptedOutNumberInformation]) Source #
An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
describeOptedOutNumbersResponse_httpStatus :: Lens' DescribeOptedOutNumbersResponse Int Source #
The response's http status code.
DescribePhoneNumbers
describePhoneNumbers_filters :: Lens' DescribePhoneNumbers (Maybe [PhoneNumberFilter]) Source #
An array of PhoneNumberFilter objects to filter the results.
describePhoneNumbers_maxResults :: Lens' DescribePhoneNumbers (Maybe Natural) Source #
The maximum number of results to return per each request.
describePhoneNumbers_nextToken :: Lens' DescribePhoneNumbers (Maybe Text) Source #
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.
describePhoneNumbers_phoneNumberIds :: Lens' DescribePhoneNumbers (Maybe [Text]) Source #
The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
describePhoneNumbersResponse_nextToken :: Lens' DescribePhoneNumbersResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describePhoneNumbersResponse_phoneNumbers :: Lens' DescribePhoneNumbersResponse (Maybe [PhoneNumberInformation]) Source #
An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
describePhoneNumbersResponse_httpStatus :: Lens' DescribePhoneNumbersResponse Int Source #
The response's http status code.
DescribePools
describePools_filters :: Lens' DescribePools (Maybe [PoolFilter]) Source #
An array of PoolFilter objects to filter the results.
describePools_maxResults :: Lens' DescribePools (Maybe Natural) Source #
The maximum number of results to return per each request.
describePools_nextToken :: Lens' DescribePools (Maybe Text) Source #
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.
describePools_poolIds :: Lens' DescribePools (Maybe [Text]) Source #
The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
describePoolsResponse_nextToken :: Lens' DescribePoolsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describePoolsResponse_pools :: Lens' DescribePoolsResponse (Maybe [PoolInformation]) Source #
An array of PoolInformation objects that contain the details for the requested pools.
describePoolsResponse_httpStatus :: Lens' DescribePoolsResponse Int Source #
The response's http status code.
DescribeSenderIds
describeSenderIds_filters :: Lens' DescribeSenderIds (Maybe [SenderIdFilter]) Source #
An array of SenderIdFilter objects to filter the results.
describeSenderIds_maxResults :: Lens' DescribeSenderIds (Maybe Natural) Source #
The maximum number of results to return per each request.
describeSenderIds_nextToken :: Lens' DescribeSenderIds (Maybe Text) Source #
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_senderIds :: Lens' DescribeSenderIds (Maybe [SenderIdAndCountry]) Source #
An array of SenderIdAndCountry objects to search for.
describeSenderIdsResponse_nextToken :: Lens' DescribeSenderIdsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeSenderIdsResponse_senderIds :: Lens' DescribeSenderIdsResponse (Maybe [SenderIdInformation]) Source #
An array of SernderIdInformation objects that contain the details for the requested SenderIds.
describeSenderIdsResponse_httpStatus :: Lens' DescribeSenderIdsResponse Int Source #
The response's http status code.
DescribeSpendLimits
describeSpendLimits_maxResults :: Lens' DescribeSpendLimits (Maybe Natural) Source #
The maximum number of results to return per each request.
describeSpendLimits_nextToken :: Lens' DescribeSpendLimits (Maybe Text) Source #
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.
describeSpendLimitsResponse_nextToken :: Lens' DescribeSpendLimitsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeSpendLimitsResponse_spendLimits :: Lens' DescribeSpendLimitsResponse (Maybe [SpendLimit]) Source #
An array of SpendLimit objects that contain the details for the requested spend limits.
describeSpendLimitsResponse_httpStatus :: Lens' DescribeSpendLimitsResponse Int Source #
The response's http status code.
DisassociateOriginationIdentity
disassociateOriginationIdentity_clientToken :: Lens' DisassociateOriginationIdentity (Maybe Text) Source #
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_poolId :: Lens' DisassociateOriginationIdentity Text Source #
The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
disassociateOriginationIdentity_originationIdentity :: Lens' DisassociateOriginationIdentity Text Source #
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_isoCountryCode :: Lens' DisassociateOriginationIdentity Text Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
disassociateOriginationIdentityResponse_isoCountryCode :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
disassociateOriginationIdentityResponse_originationIdentity :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #
The PhoneNumberId or SenderId of the origination identity.
disassociateOriginationIdentityResponse_originationIdentityArn :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #
The PhoneNumberArn or SenderIdArn of the origination identity.
disassociateOriginationIdentityResponse_poolArn :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pool.
disassociateOriginationIdentityResponse_poolId :: Lens' DisassociateOriginationIdentityResponse (Maybe Text) Source #
The PoolId of the pool no longer associated with the origination identity.
disassociateOriginationIdentityResponse_httpStatus :: Lens' DisassociateOriginationIdentityResponse Int Source #
The response's http status code.
ListPoolOriginationIdentities
listPoolOriginationIdentities_filters :: Lens' ListPoolOriginationIdentities (Maybe [PoolOriginationIdentitiesFilter]) Source #
An array of PoolOriginationIdentitiesFilter objects to filter the results..
listPoolOriginationIdentities_maxResults :: Lens' ListPoolOriginationIdentities (Maybe Natural) Source #
The maximum number of results to return per each request.
listPoolOriginationIdentities_nextToken :: Lens' ListPoolOriginationIdentities (Maybe Text) Source #
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_poolId :: Lens' ListPoolOriginationIdentities Text Source #
The unique identifier for the pool. This value can be either the PoolId or PoolArn.
listPoolOriginationIdentitiesResponse_nextToken :: Lens' ListPoolOriginationIdentitiesResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
listPoolOriginationIdentitiesResponse_originationIdentities :: Lens' ListPoolOriginationIdentitiesResponse (Maybe [OriginationIdentityMetadata]) Source #
An array of any OriginationIdentityMetadata objects.
listPoolOriginationIdentitiesResponse_poolArn :: Lens' ListPoolOriginationIdentitiesResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the pool.
listPoolOriginationIdentitiesResponse_poolId :: Lens' ListPoolOriginationIdentitiesResponse (Maybe Text) Source #
The unique PoolId of the pool.
listPoolOriginationIdentitiesResponse_httpStatus :: Lens' ListPoolOriginationIdentitiesResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the resource to query for.
listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
The ARN of the resource.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
An array of key and value pair tags that are associated with the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
PutKeyword
putKeyword_keywordAction :: Lens' PutKeyword (Maybe KeywordAction) Source #
The action to perform for the new keyword when it is received.
putKeyword_originationIdentity :: Lens' PutKeyword Text Source #
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_keyword :: Lens' PutKeyword Text Source #
The new keyword to add.
putKeyword_keywordMessage :: Lens' PutKeyword Text Source #
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.
putKeywordResponse_keyword :: Lens' PutKeywordResponse (Maybe Text) Source #
The keyword that was added.
putKeywordResponse_keywordAction :: Lens' PutKeywordResponse (Maybe KeywordAction) Source #
The action to perform when the keyword is used.
putKeywordResponse_keywordMessage :: Lens' PutKeywordResponse (Maybe Text) Source #
The message associated with the keyword.
putKeywordResponse_originationIdentity :: Lens' PutKeywordResponse (Maybe Text) Source #
The PhoneNumberId or PoolId that the keyword was associated with.
putKeywordResponse_originationIdentityArn :: Lens' PutKeywordResponse (Maybe Text) Source #
The PhoneNumberArn or PoolArn that the keyword was associated with.
putKeywordResponse_httpStatus :: Lens' PutKeywordResponse Int Source #
The response's http status code.
PutOptedOutNumber
putOptedOutNumber_optOutListName :: Lens' PutOptedOutNumber Text Source #
The OptOutListName or OptOutListArn to add the phone number to.
putOptedOutNumber_optedOutNumber :: Lens' PutOptedOutNumber Text Source #
The phone number to add to the OptOutList in E.164 format.
putOptedOutNumberResponse_endUserOptedOut :: Lens' PutOptedOutNumberResponse (Maybe Bool) Source #
This is true if it was the end user who requested their phone number be removed.
putOptedOutNumberResponse_optOutListArn :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #
The OptOutListArn that the phone number was removed from.
putOptedOutNumberResponse_optOutListName :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #
The OptOutListName that the phone number was removed from.
putOptedOutNumberResponse_optedOutNumber :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #
The phone number that was added to the OptOutList.
putOptedOutNumberResponse_optedOutTimestamp :: Lens' PutOptedOutNumberResponse (Maybe UTCTime) Source #
The time that the phone number was added to the OptOutList, in UNIX epoch time format.
putOptedOutNumberResponse_httpStatus :: Lens' PutOptedOutNumberResponse Int Source #
The response's http status code.
ReleasePhoneNumber
releasePhoneNumber_phoneNumberId :: Lens' ReleasePhoneNumber Text Source #
The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
releasePhoneNumberResponse_createdTimestamp :: Lens' ReleasePhoneNumberResponse (Maybe UTCTime) Source #
The time when the phone number was created, in UNIX epoch time format.
releasePhoneNumberResponse_isoCountryCode :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
releasePhoneNumberResponse_messageType :: Lens' ReleasePhoneNumberResponse (Maybe MessageType) Source #
The message type that was associated with the phone number.
releasePhoneNumberResponse_monthlyLeasingPrice :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #
The monthly price of the phone number, in US dollars.
releasePhoneNumberResponse_numberCapabilities :: Lens' ReleasePhoneNumberResponse (Maybe (NonEmpty NumberCapability)) Source #
Specifies if the number could be used for text messages, voice, or both.
releasePhoneNumberResponse_numberType :: Lens' ReleasePhoneNumberResponse (Maybe NumberType) Source #
The type of number that was released.
releasePhoneNumberResponse_optOutListName :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #
The name of the OptOutList that was associated with the phone number.
releasePhoneNumberResponse_phoneNumber :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #
The phone number that was released.
releasePhoneNumberResponse_phoneNumberArn :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #
The PhoneNumberArn of the phone number that was released.
releasePhoneNumberResponse_phoneNumberId :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #
The PhoneNumberId of the phone number that was released.
releasePhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' ReleasePhoneNumberResponse (Maybe Bool) Source #
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_status :: Lens' ReleasePhoneNumberResponse (Maybe NumberStatus) Source #
The current status of the request.
releasePhoneNumberResponse_twoWayChannelArn :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the TwoWayChannel.
releasePhoneNumberResponse_twoWayEnabled :: Lens' ReleasePhoneNumberResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
releasePhoneNumberResponse_httpStatus :: Lens' ReleasePhoneNumberResponse Int Source #
The response's http status code.
RequestPhoneNumber
requestPhoneNumber_clientToken :: Lens' RequestPhoneNumber (Maybe Text) Source #
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_deletionProtectionEnabled :: Lens' RequestPhoneNumber (Maybe Bool) Source #
By default this is set to false. When set to true the phone number can't be deleted.
requestPhoneNumber_optOutListName :: Lens' RequestPhoneNumber (Maybe Text) Source #
The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
requestPhoneNumber_poolId :: Lens' RequestPhoneNumber (Maybe Text) Source #
The pool to associated with the phone number. You can use the PoolId or PoolArn.
requestPhoneNumber_registrationId :: Lens' RequestPhoneNumber (Maybe Text) Source #
Use this field to attach your phone number for an external registration process.
requestPhoneNumber_tags :: Lens' RequestPhoneNumber (Maybe [Tag]) Source #
An array of tags (key and value pairs) associate with the requested phone number.
requestPhoneNumber_isoCountryCode :: Lens' RequestPhoneNumber Text Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
requestPhoneNumber_messageType :: Lens' RequestPhoneNumber MessageType Source #
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_numberCapabilities :: Lens' RequestPhoneNumber (NonEmpty NumberCapability) Source #
Indicates if the phone number will be used for text messages, voice messages, or both.
requestPhoneNumber_numberType :: Lens' RequestPhoneNumber RequestableNumberType Source #
The type of phone number to request.
requestPhoneNumberResponse_createdTimestamp :: Lens' RequestPhoneNumberResponse (Maybe UTCTime) Source #
The time when the phone number was created, in UNIX epoch time format.
requestPhoneNumberResponse_deletionProtectionEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool) Source #
By default this is set to false. When set to true the phone number can't be deleted.
requestPhoneNumberResponse_isoCountryCode :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
requestPhoneNumberResponse_messageType :: Lens' RequestPhoneNumberResponse (Maybe MessageType) Source #
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_monthlyLeasingPrice :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The monthly price, in US dollars, to lease the phone number.
requestPhoneNumberResponse_numberCapabilities :: Lens' RequestPhoneNumberResponse (Maybe (NonEmpty NumberCapability)) Source #
Indicates if the phone number will be used for text messages, voice messages or both.
requestPhoneNumberResponse_numberType :: Lens' RequestPhoneNumberResponse (Maybe RequestableNumberType) Source #
The type of number that was released.
requestPhoneNumberResponse_optOutListName :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The name of the OptOutList that is associated with the requested phone number.
requestPhoneNumberResponse_phoneNumber :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The new phone number that was requested.
requestPhoneNumberResponse_phoneNumberArn :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the requested phone number.
requestPhoneNumberResponse_phoneNumberId :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The unique identifier of the new phone number.
requestPhoneNumberResponse_poolId :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The unique identifier of the pool associated with the phone number
requestPhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool) Source #
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_status :: Lens' RequestPhoneNumberResponse (Maybe NumberStatus) Source #
The current status of the request.
requestPhoneNumberResponse_tags :: Lens' RequestPhoneNumberResponse (Maybe [Tag]) Source #
An array of key and value pair tags that are associated with the phone number.
requestPhoneNumberResponse_twoWayChannelArn :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #
The ARN used to identify the two way channel.
requestPhoneNumberResponse_twoWayEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
requestPhoneNumberResponse_httpStatus :: Lens' RequestPhoneNumberResponse Int Source #
The response's http status code.
SendTextMessage
sendTextMessage_configurationSetName :: Lens' SendTextMessage (Maybe Text) Source #
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
sendTextMessage_context :: Lens' SendTextMessage (Maybe (HashMap Text Text)) Source #
You can specify custom data in this field. If you do, that data is logged to the event destination.
sendTextMessage_destinationCountryParameters :: Lens' SendTextMessage (Maybe (HashMap DestinationCountryParameterKey Text)) Source #
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.
sendTextMessage_dryRun :: Lens' SendTextMessage (Maybe Bool) Source #
When set to true, the message is checked and validated, but isn't sent to the end recipient.
sendTextMessage_keyword :: Lens' SendTextMessage (Maybe Text) Source #
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.
sendTextMessage_maxPrice :: Lens' SendTextMessage (Maybe Text) Source #
The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
sendTextMessage_messageBody :: Lens' SendTextMessage (Maybe Text) Source #
The body of the text message.
sendTextMessage_messageType :: Lens' SendTextMessage (Maybe MessageType) Source #
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_originationIdentity :: Lens' SendTextMessage (Maybe Text) Source #
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
sendTextMessage_timeToLive :: Lens' SendTextMessage (Maybe Natural) Source #
How long the text message is valid for. By default this is 72 hours.
sendTextMessage_destinationPhoneNumber :: Lens' SendTextMessage Text Source #
The destination phone number in E.164 format.
sendTextMessageResponse_messageId :: Lens' SendTextMessageResponse (Maybe Text) Source #
The unique identifier for the message.
sendTextMessageResponse_httpStatus :: Lens' SendTextMessageResponse Int Source #
The response's http status code.
SendVoiceMessage
sendVoiceMessage_configurationSetName :: Lens' SendVoiceMessage (Maybe Text) Source #
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
sendVoiceMessage_context :: Lens' SendVoiceMessage (Maybe (HashMap Text Text)) Source #
You can specify custom data in this field. If you do, that data is logged to the event destination.
sendVoiceMessage_dryRun :: Lens' SendVoiceMessage (Maybe Bool) Source #
When set to true, the message is checked and validated, but isn't sent to the end recipient.
sendVoiceMessage_maxPricePerMinute :: Lens' SendVoiceMessage (Maybe Text) Source #
The maximum amount to spend per voice message, in US dollars.
sendVoiceMessage_messageBody :: Lens' SendVoiceMessage (Maybe Text) Source #
The text to convert to a voice message.
sendVoiceMessage_messageBodyTextType :: Lens' SendVoiceMessage (Maybe VoiceMessageBodyTextType) Source #
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.
sendVoiceMessage_timeToLive :: Lens' SendVoiceMessage (Maybe Natural) Source #
How long the voice message is valid for. By default this is 72 hours.
sendVoiceMessage_voiceId :: Lens' SendVoiceMessage (Maybe VoiceId) Source #
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
sendVoiceMessage_destinationPhoneNumber :: Lens' SendVoiceMessage Text Source #
The destination phone number in E.164 format.
sendVoiceMessage_originationIdentity :: Lens' SendVoiceMessage Text Source #
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
sendVoiceMessageResponse_messageId :: Lens' SendVoiceMessageResponse (Maybe Text) Source #
The unique identifier for the message.
sendVoiceMessageResponse_httpStatus :: Lens' SendVoiceMessageResponse Int Source #
The response's http status code.
SetDefaultMessageType
setDefaultMessageType_configurationSetName :: Lens' SetDefaultMessageType Text Source #
The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
setDefaultMessageType_messageType :: Lens' SetDefaultMessageType MessageType Source #
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.
setDefaultMessageTypeResponse_configurationSetArn :: Lens' SetDefaultMessageTypeResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the updated configuration set.
setDefaultMessageTypeResponse_configurationSetName :: Lens' SetDefaultMessageTypeResponse (Maybe Text) Source #
The name of the configuration set that was updated.
setDefaultMessageTypeResponse_messageType :: Lens' SetDefaultMessageTypeResponse (Maybe MessageType) Source #
The new default message type of the configuration set.
setDefaultMessageTypeResponse_httpStatus :: Lens' SetDefaultMessageTypeResponse Int Source #
The response's http status code.
SetDefaultSenderId
setDefaultSenderId_configurationSetName :: Lens' SetDefaultSenderId Text Source #
The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
setDefaultSenderId_senderId :: Lens' SetDefaultSenderId Text Source #
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'.
setDefaultSenderIdResponse_configurationSetArn :: Lens' SetDefaultSenderIdResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the updated configuration set.
setDefaultSenderIdResponse_configurationSetName :: Lens' SetDefaultSenderIdResponse (Maybe Text) Source #
The name of the configuration set that was updated.
setDefaultSenderIdResponse_senderId :: Lens' SetDefaultSenderIdResponse (Maybe Text) Source #
The default sender ID to set for the ConfigurationSet.
setDefaultSenderIdResponse_httpStatus :: Lens' SetDefaultSenderIdResponse Int Source #
The response's http status code.
SetTextMessageSpendLimitOverride
setTextMessageSpendLimitOverride_monthlyLimit :: Lens' SetTextMessageSpendLimitOverride Natural Source #
The new monthly limit to enforce on text messages.
setTextMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' SetTextMessageSpendLimitOverrideResponse (Maybe Natural) Source #
The current monthly limit to enforce on sending text messages.
setTextMessageSpendLimitOverrideResponse_httpStatus :: Lens' SetTextMessageSpendLimitOverrideResponse Int Source #
The response's http status code.
SetVoiceMessageSpendLimitOverride
setVoiceMessageSpendLimitOverride_monthlyLimit :: Lens' SetVoiceMessageSpendLimitOverride Natural Source #
The new monthly limit to enforce on voice messages.
setVoiceMessageSpendLimitOverrideResponse_monthlyLimit :: Lens' SetVoiceMessageSpendLimitOverrideResponse (Maybe Natural) Source #
The current monthly limit to enforce on sending voice messages.
setVoiceMessageSpendLimitOverrideResponse_httpStatus :: Lens' SetVoiceMessageSpendLimitOverrideResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the resource.
tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #
An array of key and value pair tags that are associated with the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the resource.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
An array of tag key values to unassociate with the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateEventDestination
updateEventDestination_cloudWatchLogsDestination :: Lens' UpdateEventDestination (Maybe CloudWatchLogsDestination) Source #
An object that contains information about an event destination that sends data to CloudWatch Logs.
updateEventDestination_enabled :: Lens' UpdateEventDestination (Maybe Bool) Source #
When set to true logging is enabled.
updateEventDestination_kinesisFirehoseDestination :: Lens' UpdateEventDestination (Maybe KinesisFirehoseDestination) Source #
An object that contains information about an event destination for logging to Kinesis Data Firehose.
updateEventDestination_matchingEventTypes :: Lens' UpdateEventDestination (Maybe (NonEmpty EventType)) Source #
An array of event types that determine which events to log.
updateEventDestination_snsDestination :: Lens' UpdateEventDestination (Maybe SnsDestination) Source #
An object that contains information about an event destination that sends data to Amazon SNS.
updateEventDestination_configurationSetName :: Lens' UpdateEventDestination Text Source #
The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
updateEventDestination_eventDestinationName :: Lens' UpdateEventDestination Text Source #
The name to use for the event destination.
updateEventDestinationResponse_configurationSetArn :: Lens' UpdateEventDestinationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
updateEventDestinationResponse_configurationSetName :: Lens' UpdateEventDestinationResponse (Maybe Text) Source #
The name of the configuration set.
updateEventDestinationResponse_eventDestination :: Lens' UpdateEventDestinationResponse (Maybe EventDestination) Source #
An EventDestination object containing the details of where events will be logged.
updateEventDestinationResponse_httpStatus :: Lens' UpdateEventDestinationResponse Int Source #
The response's http status code.
UpdatePhoneNumber
updatePhoneNumber_deletionProtectionEnabled :: Lens' UpdatePhoneNumber (Maybe Bool) Source #
By default this is set to false. When set to true the phone number can't be deleted.
updatePhoneNumber_optOutListName :: Lens' UpdatePhoneNumber (Maybe Text) Source #
The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
updatePhoneNumber_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumber (Maybe Bool) Source #
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_twoWayChannelArn :: Lens' UpdatePhoneNumber (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
updatePhoneNumber_twoWayEnabled :: Lens' UpdatePhoneNumber (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
updatePhoneNumber_phoneNumberId :: Lens' UpdatePhoneNumber Text Source #
The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
updatePhoneNumberResponse_createdTimestamp :: Lens' UpdatePhoneNumberResponse (Maybe UTCTime) Source #
The time when the phone number was created, in UNIX epoch time format.
updatePhoneNumberResponse_deletionProtectionEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool) Source #
When set to true the phone number can't be deleted.
updatePhoneNumberResponse_isoCountryCode :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
updatePhoneNumberResponse_messageType :: Lens' UpdatePhoneNumberResponse (Maybe MessageType) Source #
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_monthlyLeasingPrice :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The monthly leasing price of the phone number, in US dollars.
updatePhoneNumberResponse_numberCapabilities :: Lens' UpdatePhoneNumberResponse (Maybe (NonEmpty NumberCapability)) Source #
Specifies if the number could be used for text messages, voice or both.
updatePhoneNumberResponse_numberType :: Lens' UpdatePhoneNumberResponse (Maybe NumberType) Source #
The type of number that was requested.
updatePhoneNumberResponse_optOutListName :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The name of the OptOutList associated with the phone number.
updatePhoneNumberResponse_phoneNumber :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The phone number that was updated.
updatePhoneNumberResponse_phoneNumberArn :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the updated phone number.
updatePhoneNumberResponse_phoneNumberId :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The unique identifier of the phone number.
updatePhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool) Source #
This is true if self managed opt-out are enabled.
updatePhoneNumberResponse_status :: Lens' UpdatePhoneNumberResponse (Maybe NumberStatus) Source #
The current status of the request.
updatePhoneNumberResponse_twoWayChannelArn :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
updatePhoneNumberResponse_twoWayEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
updatePhoneNumberResponse_httpStatus :: Lens' UpdatePhoneNumberResponse Int Source #
The response's http status code.
UpdatePool
updatePool_deletionProtectionEnabled :: Lens' UpdatePool (Maybe Bool) Source #
When set to true the pool can't be deleted.
updatePool_optOutListName :: Lens' UpdatePool (Maybe Text) Source #
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
updatePool_selfManagedOptOutsEnabled :: Lens' UpdatePool (Maybe Bool) Source #
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_sharedRoutesEnabled :: Lens' UpdatePool (Maybe Bool) Source #
Indicates whether shared routes are enabled for the pool.
updatePool_twoWayChannelArn :: Lens' UpdatePool (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
updatePool_twoWayEnabled :: Lens' UpdatePool (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
updatePool_poolId :: Lens' UpdatePool Text Source #
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
updatePoolResponse_createdTimestamp :: Lens' UpdatePoolResponse (Maybe UTCTime) Source #
The time when the pool was created, in UNIX epoch time format.
updatePoolResponse_deletionProtectionEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #
When set to true the pool can't be deleted.
updatePoolResponse_messageType :: Lens' UpdatePoolResponse (Maybe MessageType) Source #
The type of message for the pool to use.
updatePoolResponse_optOutListName :: Lens' UpdatePoolResponse (Maybe Text) Source #
The name of the OptOutList associated with the pool.
updatePoolResponse_poolArn :: Lens' UpdatePoolResponse (Maybe Text) Source #
The ARN of the pool.
updatePoolResponse_poolId :: Lens' UpdatePoolResponse (Maybe Text) Source #
The unique identifier of the pool.
updatePoolResponse_selfManagedOptOutsEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #
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.
updatePoolResponse_sharedRoutesEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #
Indicates whether shared routes are enabled for the pool.
updatePoolResponse_status :: Lens' UpdatePoolResponse (Maybe PoolStatus) Source #
The current status of the pool update request.
updatePoolResponse_twoWayChannelArn :: Lens' UpdatePoolResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
updatePoolResponse_twoWayEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
updatePoolResponse_httpStatus :: Lens' UpdatePoolResponse Int Source #
The response's http status code.
Types
AccountAttribute
accountAttribute_name :: Lens' AccountAttribute AccountAttributeName Source #
The name of the account attribute.
accountAttribute_value :: Lens' AccountAttribute Text Source #
The value associated with the account attribute name.
AccountLimit
accountLimit_name :: Lens' AccountLimit AccountLimitName Source #
The name of the attribute to apply the account limit to.
accountLimit_used :: Lens' AccountLimit Integer Source #
The current amount that has been spent, in US dollars.
accountLimit_max :: Lens' AccountLimit Integer Source #
The Amazon Web Services set limit for that resource type, in US dollars.
CloudWatchLogsDestination
cloudWatchLogsDestination_iamRoleArn :: Lens' CloudWatchLogsDestination Text Source #
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.
cloudWatchLogsDestination_logGroupArn :: Lens' CloudWatchLogsDestination Text Source #
The name of the Amazon CloudWatch log group that you want to record events in.
ConfigurationSetFilter
configurationSetFilter_name :: Lens' ConfigurationSetFilter ConfigurationSetFilterName Source #
The name of the attribute to filter on.
configurationSetFilter_values :: Lens' ConfigurationSetFilter (NonEmpty Text) Source #
An array values to filter for.
ConfigurationSetInformation
configurationSetInformation_defaultMessageType :: Lens' ConfigurationSetInformation (Maybe MessageType) Source #
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.
configurationSetInformation_defaultSenderId :: Lens' ConfigurationSetInformation (Maybe Text) Source #
The default sender ID used by the ConfigurationSet.
configurationSetInformation_configurationSetArn :: Lens' ConfigurationSetInformation Text Source #
The Resource Name (ARN) of the ConfigurationSet.
configurationSetInformation_configurationSetName :: Lens' ConfigurationSetInformation Text Source #
The name of the ConfigurationSet.
configurationSetInformation_eventDestinations :: Lens' ConfigurationSetInformation [EventDestination] Source #
An array of EventDestination objects that describe any events to log and where to log them.
configurationSetInformation_createdTimestamp :: Lens' ConfigurationSetInformation UTCTime Source #
The time when the ConfigurationSet was created, in UNIX epoch time format.
EventDestination
eventDestination_cloudWatchLogsDestination :: Lens' EventDestination (Maybe CloudWatchLogsDestination) Source #
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) Source #
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination) Source #
An object that contains information about an event destination that sends logging events to Amazon SNS.
eventDestination_eventDestinationName :: Lens' EventDestination Text Source #
The name of the EventDestination.
eventDestination_enabled :: Lens' EventDestination Bool Source #
When set to true events will be logged.
eventDestination_matchingEventTypes :: Lens' EventDestination (NonEmpty EventType) Source #
An array of event types that determine which events to log.
KeywordFilter
keywordFilter_name :: Lens' KeywordFilter KeywordFilterName Source #
The name of the attribute to filter on.
keywordFilter_values :: Lens' KeywordFilter (NonEmpty Text) Source #
An array values to filter for.
KeywordInformation
keywordInformation_keyword :: Lens' KeywordInformation Text Source #
The keyword as a string.
keywordInformation_keywordMessage :: Lens' KeywordInformation Text Source #
A custom message that can be used with the keyword.
keywordInformation_keywordAction :: Lens' KeywordInformation KeywordAction Source #
The action to perform for the keyword.
KinesisFirehoseDestination
kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text Source #
The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text Source #
The Amazon Resource Name (ARN) of the delivery stream.
OptOutListInformation
optOutListInformation_optOutListArn :: Lens' OptOutListInformation Text Source #
The Amazon Resource Name (ARN) of the OptOutList.
optOutListInformation_optOutListName :: Lens' OptOutListInformation Text Source #
The name of the OptOutList.
optOutListInformation_createdTimestamp :: Lens' OptOutListInformation UTCTime Source #
The time when the OutOutList was created, in UNIX epoch time format.
OptedOutFilter
optedOutFilter_name :: Lens' OptedOutFilter OptedOutFilterName Source #
The name of the attribute to filter on.
optedOutFilter_values :: Lens' OptedOutFilter (NonEmpty Text) Source #
An array of values to filter for.
OptedOutNumberInformation
optedOutNumberInformation_optedOutNumber :: Lens' OptedOutNumberInformation Text Source #
The phone number that is opted out.
optedOutNumberInformation_optedOutTimestamp :: Lens' OptedOutNumberInformation UTCTime Source #
The time that the op tout occurred, in UNIX epoch time format.
optedOutNumberInformation_endUserOptedOut :: Lens' OptedOutNumberInformation Bool Source #
This is set to true if it was the end recipient that opted out.
OriginationIdentityMetadata
originationIdentityMetadata_originationIdentityArn :: Lens' OriginationIdentityMetadata Text Source #
The Amazon Resource Name (ARN) associated with the origination identity.
originationIdentityMetadata_originationIdentity :: Lens' OriginationIdentityMetadata Text Source #
The unique identifier of the origination identity.
originationIdentityMetadata_isoCountryCode :: Lens' OriginationIdentityMetadata Text Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
originationIdentityMetadata_numberCapabilities :: Lens' OriginationIdentityMetadata (NonEmpty NumberCapability) Source #
Describes if the origination identity can be used for text messages, voice calls or both.
PhoneNumberFilter
phoneNumberFilter_name :: Lens' PhoneNumberFilter PhoneNumberFilterName Source #
The name of the attribute to filter on.
phoneNumberFilter_values :: Lens' PhoneNumberFilter (NonEmpty Text) Source #
An array values to filter for.
PhoneNumberInformation
phoneNumberInformation_phoneNumberId :: Lens' PhoneNumberInformation (Maybe Text) Source #
The unique identifier for the phone number.
phoneNumberInformation_poolId :: Lens' PhoneNumberInformation (Maybe Text) Source #
The unique identifier of the pool associated with the phone number.
phoneNumberInformation_twoWayChannelArn :: Lens' PhoneNumberInformation (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
phoneNumberInformation_phoneNumberArn :: Lens' PhoneNumberInformation Text Source #
The Amazon Resource Name (ARN) associated with the phone number.
phoneNumberInformation_phoneNumber :: Lens' PhoneNumberInformation Text Source #
The phone number in E.164 format.
phoneNumberInformation_status :: Lens' PhoneNumberInformation NumberStatus Source #
The current status of the phone number.
phoneNumberInformation_isoCountryCode :: Lens' PhoneNumberInformation Text Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
phoneNumberInformation_messageType :: Lens' PhoneNumberInformation MessageType Source #
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.
phoneNumberInformation_numberCapabilities :: Lens' PhoneNumberInformation (NonEmpty NumberCapability) Source #
Describes if the origination identity can be used for text messages, voice calls or both.
phoneNumberInformation_numberType :: Lens' PhoneNumberInformation NumberType Source #
The type of phone number.
phoneNumberInformation_monthlyLeasingPrice :: Lens' PhoneNumberInformation Text Source #
The price, in US dollars, to lease the phone number.
phoneNumberInformation_twoWayEnabled :: Lens' PhoneNumberInformation Bool Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
phoneNumberInformation_selfManagedOptOutsEnabled :: Lens' PhoneNumberInformation Bool Source #
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
phoneNumberInformation_optOutListName :: Lens' PhoneNumberInformation Text Source #
The name of the OptOutList associated with the phone number.
phoneNumberInformation_deletionProtectionEnabled :: Lens' PhoneNumberInformation Bool Source #
When set to true the phone number can't be deleted.
phoneNumberInformation_createdTimestamp :: Lens' PhoneNumberInformation UTCTime Source #
The time when the phone number was created, in UNIX epoch time format.
PoolFilter
poolFilter_name :: Lens' PoolFilter PoolFilterName Source #
The name of the attribute to filter on.
poolFilter_values :: Lens' PoolFilter (NonEmpty Text) Source #
An array values to filter for.
PoolInformation
poolInformation_twoWayChannelArn :: Lens' PoolInformation (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
poolInformation_poolArn :: Lens' PoolInformation Text Source #
The Amazon Resource Name (ARN) for the pool.
poolInformation_poolId :: Lens' PoolInformation Text Source #
The unique identifier for the pool.
poolInformation_status :: Lens' PoolInformation PoolStatus Source #
The current status of the pool.
poolInformation_messageType :: Lens' PoolInformation MessageType Source #
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.
poolInformation_twoWayEnabled :: Lens' PoolInformation Bool Source #
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
poolInformation_selfManagedOptOutsEnabled :: Lens' PoolInformation Bool Source #
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
poolInformation_optOutListName :: Lens' PoolInformation Text Source #
The name of the OptOutList associated with the pool.
poolInformation_sharedRoutesEnabled :: Lens' PoolInformation Bool Source #
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.
poolInformation_deletionProtectionEnabled :: Lens' PoolInformation Bool Source #
When set to true the pool can't be deleted.
poolInformation_createdTimestamp :: Lens' PoolInformation UTCTime Source #
The time when the pool was created, in UNIX epoch time format.
PoolOriginationIdentitiesFilter
poolOriginationIdentitiesFilter_name :: Lens' PoolOriginationIdentitiesFilter PoolOriginationIdentitiesFilterName Source #
The name of the attribute to filter on.
poolOriginationIdentitiesFilter_values :: Lens' PoolOriginationIdentitiesFilter (NonEmpty Text) Source #
An array values to filter for.
SenderIdAndCountry
senderIdAndCountry_senderId :: Lens' SenderIdAndCountry Text Source #
The unique identifier of the sender.
senderIdAndCountry_isoCountryCode :: Lens' SenderIdAndCountry Text Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
SenderIdFilter
senderIdFilter_name :: Lens' SenderIdFilter SenderIdFilterName Source #
The name of the attribute to filter on.
senderIdFilter_values :: Lens' SenderIdFilter (NonEmpty Text) Source #
An array of values to filter for.
SenderIdInformation
senderIdInformation_senderIdArn :: Lens' SenderIdInformation Text Source #
The Amazon Resource Name (ARN) associated with the SenderId.
senderIdInformation_senderId :: Lens' SenderIdInformation Text Source #
The alphanumeric sender ID in a specific country that you'd like to describe.
senderIdInformation_isoCountryCode :: Lens' SenderIdInformation Text Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
senderIdInformation_messageTypes :: Lens' SenderIdInformation [MessageType] Source #
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.
senderIdInformation_monthlyLeasingPrice :: Lens' SenderIdInformation Text Source #
The monthly leasing price, in US dollars.
SnsDestination
snsDestination_topicArn :: Lens' SnsDestination Text Source #
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
SpendLimit
spendLimit_name :: Lens' SpendLimit SpendLimitName Source #
The name for the SpendLimit.
spendLimit_enforcedLimit :: Lens' SpendLimit Integer Source #
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.
spendLimit_maxLimit :: Lens' SpendLimit Integer Source #
The maximum amount of money that you are able to spend to send messages each month, in US dollars.
spendLimit_overridden :: Lens' SpendLimit Bool Source #
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.