| 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 |
Amazonka.PinpointSmsVoiceV2.Types
Contents
- Service Configuration
- Errors
- AccountAttributeName
- AccountLimitName
- ConfigurationSetFilterName
- DestinationCountryParameterKey
- EventType
- KeywordAction
- KeywordFilterName
- MessageType
- NumberCapability
- NumberStatus
- NumberType
- OptedOutFilterName
- PhoneNumberFilterName
- PoolFilterName
- PoolOriginationIdentitiesFilterName
- PoolStatus
- RequestableNumberType
- SenderIdFilterName
- SpendLimitName
- VoiceId
- VoiceMessageBodyTextType
- AccountAttribute
- AccountLimit
- CloudWatchLogsDestination
- ConfigurationSetFilter
- ConfigurationSetInformation
- EventDestination
- KeywordFilter
- KeywordInformation
- KinesisFirehoseDestination
- OptOutListInformation
- OptedOutFilter
- OptedOutNumberInformation
- OriginationIdentityMetadata
- PhoneNumberFilter
- PhoneNumberInformation
- PoolFilter
- PoolInformation
- PoolOriginationIdentitiesFilter
- SenderIdAndCountry
- SenderIdFilter
- SenderIdInformation
- SnsDestination
- SpendLimit
- Tag
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype AccountAttributeName where
- newtype AccountLimitName where
- AccountLimitName' { }
- pattern AccountLimitName_CONFIGURATION_SETS :: AccountLimitName
- pattern AccountLimitName_OPT_OUT_LISTS :: AccountLimitName
- pattern AccountLimitName_PHONE_NUMBERS :: AccountLimitName
- pattern AccountLimitName_POOLS :: AccountLimitName
- newtype ConfigurationSetFilterName where
- ConfigurationSetFilterName' { }
- pattern ConfigurationSetFilterName_Default_message_type :: ConfigurationSetFilterName
- pattern ConfigurationSetFilterName_Default_sender_id :: ConfigurationSetFilterName
- pattern ConfigurationSetFilterName_Event_destination_name :: ConfigurationSetFilterName
- pattern ConfigurationSetFilterName_Matching_event_types :: ConfigurationSetFilterName
- newtype DestinationCountryParameterKey where
- newtype EventType where
- EventType' { }
- pattern EventType_ALL :: EventType
- pattern EventType_TEXT_ALL :: EventType
- pattern EventType_TEXT_BLOCKED :: EventType
- pattern EventType_TEXT_CARRIER_BLOCKED :: EventType
- pattern EventType_TEXT_CARRIER_UNREACHABLE :: EventType
- pattern EventType_TEXT_DELIVERED :: EventType
- pattern EventType_TEXT_INVALID :: EventType
- pattern EventType_TEXT_INVALID_MESSAGE :: EventType
- pattern EventType_TEXT_PENDING :: EventType
- pattern EventType_TEXT_QUEUED :: EventType
- pattern EventType_TEXT_SENT :: EventType
- pattern EventType_TEXT_SPAM :: EventType
- pattern EventType_TEXT_SUCCESSFUL :: EventType
- pattern EventType_TEXT_TTL_EXPIRED :: EventType
- pattern EventType_TEXT_UNKNOWN :: EventType
- pattern EventType_TEXT_UNREACHABLE :: EventType
- pattern EventType_VOICE_ALL :: EventType
- pattern EventType_VOICE_ANSWERED :: EventType
- pattern EventType_VOICE_BUSY :: EventType
- pattern EventType_VOICE_COMPLETED :: EventType
- pattern EventType_VOICE_FAILED :: EventType
- pattern EventType_VOICE_INITIATED :: EventType
- pattern EventType_VOICE_NO_ANSWER :: EventType
- pattern EventType_VOICE_RINGING :: EventType
- pattern EventType_VOICE_TTL_EXPIRED :: EventType
- newtype KeywordAction where
- KeywordAction' { }
- pattern KeywordAction_AUTOMATIC_RESPONSE :: KeywordAction
- pattern KeywordAction_OPT_IN :: KeywordAction
- pattern KeywordAction_OPT_OUT :: KeywordAction
- newtype KeywordFilterName where
- newtype MessageType where
- MessageType' { }
- pattern MessageType_PROMOTIONAL :: MessageType
- pattern MessageType_TRANSACTIONAL :: MessageType
- newtype NumberCapability where
- NumberCapability' { }
- pattern NumberCapability_SMS :: NumberCapability
- pattern NumberCapability_VOICE :: NumberCapability
- newtype NumberStatus where
- NumberStatus' { }
- pattern NumberStatus_ACTIVE :: NumberStatus
- pattern NumberStatus_ASSOCIATING :: NumberStatus
- pattern NumberStatus_DELETED :: NumberStatus
- pattern NumberStatus_DISASSOCIATING :: NumberStatus
- pattern NumberStatus_PENDING :: NumberStatus
- newtype NumberType where
- NumberType' { }
- pattern NumberType_LONG_CODE :: NumberType
- pattern NumberType_SHORT_CODE :: NumberType
- pattern NumberType_TEN_DLC :: NumberType
- pattern NumberType_TOLL_FREE :: NumberType
- newtype OptedOutFilterName where
- newtype PhoneNumberFilterName where
- PhoneNumberFilterName' { }
- pattern PhoneNumberFilterName_Deletion_protection_enabled :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Iso_country_code :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Message_type :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Number_capability :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Number_type :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Opt_out_list_name :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Self_managed_opt_outs_enabled :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Status :: PhoneNumberFilterName
- pattern PhoneNumberFilterName_Two_way_enabled :: PhoneNumberFilterName
- newtype PoolFilterName where
- PoolFilterName' { }
- pattern PoolFilterName_Deletion_protection_enabled :: PoolFilterName
- pattern PoolFilterName_Message_type :: PoolFilterName
- pattern PoolFilterName_Opt_out_list_name :: PoolFilterName
- pattern PoolFilterName_Self_managed_opt_outs_enabled :: PoolFilterName
- pattern PoolFilterName_Shared_routes_enabled :: PoolFilterName
- pattern PoolFilterName_Status :: PoolFilterName
- pattern PoolFilterName_Two_way_enabled :: PoolFilterName
- newtype PoolOriginationIdentitiesFilterName where
- newtype PoolStatus where
- PoolStatus' { }
- pattern PoolStatus_ACTIVE :: PoolStatus
- pattern PoolStatus_CREATING :: PoolStatus
- pattern PoolStatus_DELETING :: PoolStatus
- newtype RequestableNumberType where
- newtype SenderIdFilterName where
- newtype SpendLimitName where
- newtype VoiceId where
- VoiceId' {
- fromVoiceId :: Text
- pattern VoiceId_AMY :: VoiceId
- pattern VoiceId_ASTRID :: VoiceId
- pattern VoiceId_BIANCA :: VoiceId
- pattern VoiceId_BRIAN :: VoiceId
- pattern VoiceId_CAMILA :: VoiceId
- pattern VoiceId_CARLA :: VoiceId
- pattern VoiceId_CARMEN :: VoiceId
- pattern VoiceId_CELINE :: VoiceId
- pattern VoiceId_CHANTAL :: VoiceId
- pattern VoiceId_CONCHITA :: VoiceId
- pattern VoiceId_CRISTIANO :: VoiceId
- pattern VoiceId_DORA :: VoiceId
- pattern VoiceId_EMMA :: VoiceId
- pattern VoiceId_ENRIQUE :: VoiceId
- pattern VoiceId_EWA :: VoiceId
- pattern VoiceId_FILIZ :: VoiceId
- pattern VoiceId_GERAINT :: VoiceId
- pattern VoiceId_GIORGIO :: VoiceId
- pattern VoiceId_GWYNETH :: VoiceId
- pattern VoiceId_HANS :: VoiceId
- pattern VoiceId_INES :: VoiceId
- pattern VoiceId_IVY :: VoiceId
- pattern VoiceId_JACEK :: VoiceId
- pattern VoiceId_JAN :: VoiceId
- pattern VoiceId_JOANNA :: VoiceId
- pattern VoiceId_JOEY :: VoiceId
- pattern VoiceId_JUSTIN :: VoiceId
- pattern VoiceId_KARL :: VoiceId
- pattern VoiceId_KENDRA :: VoiceId
- pattern VoiceId_KIMBERLY :: VoiceId
- pattern VoiceId_LEA :: VoiceId
- pattern VoiceId_LIV :: VoiceId
- pattern VoiceId_LOTTE :: VoiceId
- pattern VoiceId_LUCIA :: VoiceId
- pattern VoiceId_LUPE :: VoiceId
- pattern VoiceId_MADS :: VoiceId
- pattern VoiceId_MAJA :: VoiceId
- pattern VoiceId_MARLENE :: VoiceId
- pattern VoiceId_MATHIEU :: VoiceId
- pattern VoiceId_MATTHEW :: VoiceId
- pattern VoiceId_MAXIM :: VoiceId
- pattern VoiceId_MIA :: VoiceId
- pattern VoiceId_MIGUEL :: VoiceId
- pattern VoiceId_MIZUKI :: VoiceId
- pattern VoiceId_NAJA :: VoiceId
- pattern VoiceId_NICOLE :: VoiceId
- pattern VoiceId_PENELOPE :: VoiceId
- pattern VoiceId_RAVEENA :: VoiceId
- pattern VoiceId_RICARDO :: VoiceId
- pattern VoiceId_RUBEN :: VoiceId
- pattern VoiceId_RUSSELL :: VoiceId
- pattern VoiceId_SALLI :: VoiceId
- pattern VoiceId_SEOYEON :: VoiceId
- pattern VoiceId_TAKUMI :: VoiceId
- pattern VoiceId_TATYANA :: VoiceId
- pattern VoiceId_VICKI :: VoiceId
- pattern VoiceId_VITORIA :: VoiceId
- pattern VoiceId_ZEINA :: VoiceId
- pattern VoiceId_ZHIYU :: VoiceId
- VoiceId' {
- newtype VoiceMessageBodyTextType where
- data AccountAttribute = AccountAttribute' {}
- newAccountAttribute :: AccountAttributeName -> Text -> AccountAttribute
- accountAttribute_name :: Lens' AccountAttribute AccountAttributeName
- accountAttribute_value :: Lens' AccountAttribute Text
- data AccountLimit = AccountLimit' {}
- newAccountLimit :: AccountLimitName -> Integer -> Integer -> AccountLimit
- accountLimit_name :: Lens' AccountLimit AccountLimitName
- accountLimit_used :: Lens' AccountLimit Integer
- accountLimit_max :: Lens' AccountLimit Integer
- data CloudWatchLogsDestination = CloudWatchLogsDestination' {
- iamRoleArn :: Text
- logGroupArn :: Text
- newCloudWatchLogsDestination :: Text -> Text -> CloudWatchLogsDestination
- cloudWatchLogsDestination_iamRoleArn :: Lens' CloudWatchLogsDestination Text
- cloudWatchLogsDestination_logGroupArn :: Lens' CloudWatchLogsDestination Text
- data ConfigurationSetFilter = ConfigurationSetFilter' {}
- newConfigurationSetFilter :: ConfigurationSetFilterName -> NonEmpty Text -> ConfigurationSetFilter
- configurationSetFilter_name :: Lens' ConfigurationSetFilter ConfigurationSetFilterName
- configurationSetFilter_values :: Lens' ConfigurationSetFilter (NonEmpty Text)
- data ConfigurationSetInformation = ConfigurationSetInformation' {}
- newConfigurationSetInformation :: Text -> Text -> UTCTime -> ConfigurationSetInformation
- 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
- data EventDestination = EventDestination' {}
- newEventDestination :: Text -> Bool -> NonEmpty EventType -> EventDestination
- 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)
- data KeywordFilter = KeywordFilter' {}
- newKeywordFilter :: KeywordFilterName -> NonEmpty Text -> KeywordFilter
- keywordFilter_name :: Lens' KeywordFilter KeywordFilterName
- keywordFilter_values :: Lens' KeywordFilter (NonEmpty Text)
- data KeywordInformation = KeywordInformation' {}
- newKeywordInformation :: Text -> Text -> KeywordAction -> KeywordInformation
- keywordInformation_keyword :: Lens' KeywordInformation Text
- keywordInformation_keywordMessage :: Lens' KeywordInformation Text
- keywordInformation_keywordAction :: Lens' KeywordInformation KeywordAction
- data KinesisFirehoseDestination = KinesisFirehoseDestination' {}
- newKinesisFirehoseDestination :: Text -> Text -> KinesisFirehoseDestination
- kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text
- kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text
- data OptOutListInformation = OptOutListInformation' {}
- newOptOutListInformation :: Text -> Text -> UTCTime -> OptOutListInformation
- optOutListInformation_optOutListArn :: Lens' OptOutListInformation Text
- optOutListInformation_optOutListName :: Lens' OptOutListInformation Text
- optOutListInformation_createdTimestamp :: Lens' OptOutListInformation UTCTime
- data OptedOutFilter = OptedOutFilter' {}
- newOptedOutFilter :: OptedOutFilterName -> NonEmpty Text -> OptedOutFilter
- optedOutFilter_name :: Lens' OptedOutFilter OptedOutFilterName
- optedOutFilter_values :: Lens' OptedOutFilter (NonEmpty Text)
- data OptedOutNumberInformation = OptedOutNumberInformation' {}
- newOptedOutNumberInformation :: Text -> UTCTime -> Bool -> OptedOutNumberInformation
- optedOutNumberInformation_optedOutNumber :: Lens' OptedOutNumberInformation Text
- optedOutNumberInformation_optedOutTimestamp :: Lens' OptedOutNumberInformation UTCTime
- optedOutNumberInformation_endUserOptedOut :: Lens' OptedOutNumberInformation Bool
- data OriginationIdentityMetadata = OriginationIdentityMetadata' {}
- newOriginationIdentityMetadata :: Text -> Text -> Text -> NonEmpty NumberCapability -> OriginationIdentityMetadata
- originationIdentityMetadata_originationIdentityArn :: Lens' OriginationIdentityMetadata Text
- originationIdentityMetadata_originationIdentity :: Lens' OriginationIdentityMetadata Text
- originationIdentityMetadata_isoCountryCode :: Lens' OriginationIdentityMetadata Text
- originationIdentityMetadata_numberCapabilities :: Lens' OriginationIdentityMetadata (NonEmpty NumberCapability)
- data PhoneNumberFilter = PhoneNumberFilter' {}
- newPhoneNumberFilter :: PhoneNumberFilterName -> NonEmpty Text -> PhoneNumberFilter
- phoneNumberFilter_name :: Lens' PhoneNumberFilter PhoneNumberFilterName
- phoneNumberFilter_values :: Lens' PhoneNumberFilter (NonEmpty Text)
- data PhoneNumberInformation = PhoneNumberInformation' {
- phoneNumberId :: Maybe Text
- poolId :: Maybe Text
- twoWayChannelArn :: Maybe Text
- phoneNumberArn :: Text
- phoneNumber :: Text
- status :: NumberStatus
- isoCountryCode :: Text
- messageType :: MessageType
- numberCapabilities :: NonEmpty NumberCapability
- numberType :: NumberType
- monthlyLeasingPrice :: Text
- twoWayEnabled :: Bool
- selfManagedOptOutsEnabled :: Bool
- optOutListName :: Text
- deletionProtectionEnabled :: Bool
- createdTimestamp :: POSIX
- newPhoneNumberInformation :: Text -> Text -> NumberStatus -> Text -> MessageType -> NonEmpty NumberCapability -> NumberType -> Text -> Bool -> Bool -> Text -> Bool -> UTCTime -> PhoneNumberInformation
- 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
- data PoolFilter = PoolFilter' {
- name :: PoolFilterName
- values :: NonEmpty Text
- newPoolFilter :: PoolFilterName -> NonEmpty Text -> PoolFilter
- poolFilter_name :: Lens' PoolFilter PoolFilterName
- poolFilter_values :: Lens' PoolFilter (NonEmpty Text)
- data PoolInformation = PoolInformation' {}
- newPoolInformation :: Text -> Text -> PoolStatus -> MessageType -> Bool -> Bool -> Text -> Bool -> Bool -> UTCTime -> PoolInformation
- 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
- data PoolOriginationIdentitiesFilter = PoolOriginationIdentitiesFilter' {}
- newPoolOriginationIdentitiesFilter :: PoolOriginationIdentitiesFilterName -> NonEmpty Text -> PoolOriginationIdentitiesFilter
- poolOriginationIdentitiesFilter_name :: Lens' PoolOriginationIdentitiesFilter PoolOriginationIdentitiesFilterName
- poolOriginationIdentitiesFilter_values :: Lens' PoolOriginationIdentitiesFilter (NonEmpty Text)
- data SenderIdAndCountry = SenderIdAndCountry' {
- senderId :: Text
- isoCountryCode :: Text
- newSenderIdAndCountry :: Text -> Text -> SenderIdAndCountry
- senderIdAndCountry_senderId :: Lens' SenderIdAndCountry Text
- senderIdAndCountry_isoCountryCode :: Lens' SenderIdAndCountry Text
- data SenderIdFilter = SenderIdFilter' {}
- newSenderIdFilter :: SenderIdFilterName -> NonEmpty Text -> SenderIdFilter
- senderIdFilter_name :: Lens' SenderIdFilter SenderIdFilterName
- senderIdFilter_values :: Lens' SenderIdFilter (NonEmpty Text)
- data SenderIdInformation = SenderIdInformation' {}
- newSenderIdInformation :: Text -> Text -> Text -> Text -> SenderIdInformation
- 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
- data SnsDestination = SnsDestination' {}
- newSnsDestination :: Text -> SnsDestination
- snsDestination_topicArn :: Lens' SnsDestination Text
- data SpendLimit = SpendLimit' {}
- newSpendLimit :: SpendLimitName -> Integer -> Integer -> Bool -> SpendLimit
- spendLimit_name :: Lens' SpendLimit SpendLimitName
- spendLimit_enforcedLimit :: Lens' SpendLimit Integer
- spendLimit_maxLimit :: Lens' SpendLimit Integer
- spendLimit_overridden :: Lens' SpendLimit Bool
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2022-03-31 of the Amazon Pinpoint SMS Voice V2 SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The request was denied because you don't have sufficient permissions to access the resource.
_ConflictException :: AsError a => Fold a ServiceError Source #
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A requested resource couldn't be found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota to be exceeded.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
An error that occurred because too many requests were sent during a certain amount of time.
_ValidationException :: AsError a => Fold a ServiceError Source #
A validation exception for a field.
AccountAttributeName
newtype AccountAttributeName Source #
Constructors
| AccountAttributeName' | |
Fields | |
Bundled Patterns
| pattern AccountAttributeName_ACCOUNT_TIER :: AccountAttributeName |
Instances
AccountLimitName
newtype AccountLimitName Source #
Constructors
| AccountLimitName' | |
Fields | |
Bundled Patterns
| pattern AccountLimitName_CONFIGURATION_SETS :: AccountLimitName | |
| pattern AccountLimitName_OPT_OUT_LISTS :: AccountLimitName | |
| pattern AccountLimitName_PHONE_NUMBERS :: AccountLimitName | |
| pattern AccountLimitName_POOLS :: AccountLimitName |
Instances
ConfigurationSetFilterName
newtype ConfigurationSetFilterName Source #
Constructors
| ConfigurationSetFilterName' | |
Fields | |
Bundled Patterns
Instances
DestinationCountryParameterKey
newtype DestinationCountryParameterKey Source #
Constructors
| DestinationCountryParameterKey' | |
Fields | |
Bundled Patterns
| pattern DestinationCountryParameterKey_IN_ENTITY_ID :: DestinationCountryParameterKey | |
| pattern DestinationCountryParameterKey_IN_TEMPLATE_ID :: DestinationCountryParameterKey |
Instances
EventType
Constructors
| EventType' | |
Fields | |
Bundled Patterns
Instances
KeywordAction
newtype KeywordAction Source #
Constructors
| KeywordAction' | |
Fields | |
Bundled Patterns
| pattern KeywordAction_AUTOMATIC_RESPONSE :: KeywordAction | |
| pattern KeywordAction_OPT_IN :: KeywordAction | |
| pattern KeywordAction_OPT_OUT :: KeywordAction |
Instances
KeywordFilterName
newtype KeywordFilterName Source #
Constructors
| KeywordFilterName' | |
Fields | |
Bundled Patterns
| pattern KeywordFilterName_Keyword_action :: KeywordFilterName |
Instances
MessageType
newtype MessageType Source #
Constructors
| MessageType' | |
Fields | |
Bundled Patterns
| pattern MessageType_PROMOTIONAL :: MessageType | |
| pattern MessageType_TRANSACTIONAL :: MessageType |
Instances
NumberCapability
newtype NumberCapability Source #
Constructors
| NumberCapability' | |
Fields | |
Bundled Patterns
| pattern NumberCapability_SMS :: NumberCapability | |
| pattern NumberCapability_VOICE :: NumberCapability |
Instances
NumberStatus
newtype NumberStatus Source #
Constructors
| NumberStatus' | |
Fields | |
Bundled Patterns
| pattern NumberStatus_ACTIVE :: NumberStatus | |
| pattern NumberStatus_ASSOCIATING :: NumberStatus | |
| pattern NumberStatus_DELETED :: NumberStatus | |
| pattern NumberStatus_DISASSOCIATING :: NumberStatus | |
| pattern NumberStatus_PENDING :: NumberStatus |
Instances
NumberType
newtype NumberType Source #
Constructors
| NumberType' | |
Fields | |
Bundled Patterns
| pattern NumberType_LONG_CODE :: NumberType | |
| pattern NumberType_SHORT_CODE :: NumberType | |
| pattern NumberType_TEN_DLC :: NumberType | |
| pattern NumberType_TOLL_FREE :: NumberType |
Instances
OptedOutFilterName
newtype OptedOutFilterName Source #
Constructors
| OptedOutFilterName' | |
Fields | |
Bundled Patterns
| pattern OptedOutFilterName_End_user_opted_out :: OptedOutFilterName |
Instances
PhoneNumberFilterName
newtype PhoneNumberFilterName Source #
Constructors
| PhoneNumberFilterName' | |
Fields | |
Bundled Patterns
Instances
PoolFilterName
newtype PoolFilterName Source #
Constructors
| PoolFilterName' | |
Fields | |
Bundled Patterns
| pattern PoolFilterName_Deletion_protection_enabled :: PoolFilterName | |
| pattern PoolFilterName_Message_type :: PoolFilterName | |
| pattern PoolFilterName_Opt_out_list_name :: PoolFilterName | |
| pattern PoolFilterName_Self_managed_opt_outs_enabled :: PoolFilterName | |
| pattern PoolFilterName_Shared_routes_enabled :: PoolFilterName | |
| pattern PoolFilterName_Status :: PoolFilterName | |
| pattern PoolFilterName_Two_way_enabled :: PoolFilterName |
Instances
PoolOriginationIdentitiesFilterName
newtype PoolOriginationIdentitiesFilterName Source #
Constructors
| PoolOriginationIdentitiesFilterName' | |
Bundled Patterns
Instances
PoolStatus
newtype PoolStatus Source #
Constructors
| PoolStatus' | |
Fields | |
Bundled Patterns
| pattern PoolStatus_ACTIVE :: PoolStatus | |
| pattern PoolStatus_CREATING :: PoolStatus | |
| pattern PoolStatus_DELETING :: PoolStatus |
Instances
RequestableNumberType
newtype RequestableNumberType Source #
Constructors
| RequestableNumberType' | |
Fields | |
Bundled Patterns
| pattern RequestableNumberType_LONG_CODE :: RequestableNumberType | |
| pattern RequestableNumberType_TEN_DLC :: RequestableNumberType | |
| pattern RequestableNumberType_TOLL_FREE :: RequestableNumberType |
Instances
SenderIdFilterName
newtype SenderIdFilterName Source #
Constructors
| SenderIdFilterName' | |
Fields | |
Bundled Patterns
| pattern SenderIdFilterName_Iso_country_code :: SenderIdFilterName | |
| pattern SenderIdFilterName_Message_type :: SenderIdFilterName | |
| pattern SenderIdFilterName_Sender_id :: SenderIdFilterName |
Instances
SpendLimitName
newtype SpendLimitName Source #
Constructors
| SpendLimitName' | |
Fields | |
Bundled Patterns
| pattern SpendLimitName_TEXT_MESSAGE_MONTHLY_SPEND_LIMIT :: SpendLimitName | |
| pattern SpendLimitName_VOICE_MESSAGE_MONTHLY_SPEND_LIMIT :: SpendLimitName |
Instances
VoiceId
Constructors
| VoiceId' | |
Fields
| |
Bundled Patterns
Instances
VoiceMessageBodyTextType
newtype VoiceMessageBodyTextType Source #
Constructors
| VoiceMessageBodyTextType' | |
Fields | |
Bundled Patterns
| pattern VoiceMessageBodyTextType_SSML :: VoiceMessageBodyTextType | |
| pattern VoiceMessageBodyTextType_TEXT :: VoiceMessageBodyTextType |
Instances
AccountAttribute
data AccountAttribute Source #
Displays the attributes associated with a single Amazon Web Services account.
See: newAccountAttribute smart constructor.
Constructors
| AccountAttribute' | |
Fields
| |
Instances
Arguments
| :: AccountAttributeName | |
| -> Text | |
| -> AccountAttribute |
Create a value of AccountAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AccountAttribute', accountAttribute_name - The name of the account attribute.
$sel:value:AccountAttribute', accountAttribute_value - The value associated with the account attribute name.
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
data AccountLimit Source #
The current resource quotas associated with an Amazon Web Services account.
See: newAccountLimit smart constructor.
Constructors
| AccountLimit' | |
Instances
Arguments
| :: AccountLimitName | |
| -> Integer | |
| -> Integer | |
| -> AccountLimit |
Create a value of AccountLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AccountLimit', accountLimit_name - The name of the attribute to apply the account limit to.
$sel:used:AccountLimit', accountLimit_used - The current amount that has been spent, in US dollars.
$sel:max:AccountLimit', accountLimit_max - The Amazon Web Services set limit for that resource type, in US dollars.
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
data CloudWatchLogsDestination Source #
Contains the destination configuration to use when publishing message sending events.
See: newCloudWatchLogsDestination smart constructor.
Constructors
| CloudWatchLogsDestination' | |
Fields
| |
Instances
newCloudWatchLogsDestination Source #
Arguments
| :: Text | |
| -> Text | |
| -> CloudWatchLogsDestination |
Create a value of CloudWatchLogsDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamRoleArn:CloudWatchLogsDestination', cloudWatchLogsDestination_iamRoleArn - The Amazon Resource Name (ARN) of an Amazon Identity and Access
Management (IAM) role that is able to write event data to an Amazon
CloudWatch destination.
$sel:logGroupArn:CloudWatchLogsDestination', cloudWatchLogsDestination_logGroupArn - The name of the Amazon CloudWatch log group that you want to record
events in.
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
data ConfigurationSetFilter Source #
The information for configuration sets that meet a specified criteria.
See: newConfigurationSetFilter smart constructor.
Constructors
| ConfigurationSetFilter' | |
Fields
| |
Instances
newConfigurationSetFilter Source #
Arguments
| :: ConfigurationSetFilterName | |
| -> NonEmpty Text | |
| -> ConfigurationSetFilter |
Create a value of ConfigurationSetFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ConfigurationSetFilter', configurationSetFilter_name - The name of the attribute to filter on.
$sel:values:ConfigurationSetFilter', configurationSetFilter_values - An array values to filter for.
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
data ConfigurationSetInformation Source #
Information related to a given configuration set in your Amazon Web Services account.
See: newConfigurationSetInformation smart constructor.
Constructors
| ConfigurationSetInformation' | |
Fields
| |
Instances
newConfigurationSetInformation Source #
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ConfigurationSetInformation |
Create a value of ConfigurationSetInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultMessageType:ConfigurationSetInformation', configurationSetInformation_defaultMessageType - The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:defaultSenderId:ConfigurationSetInformation', configurationSetInformation_defaultSenderId - The default sender ID used by the ConfigurationSet.
$sel:configurationSetArn:ConfigurationSetInformation', configurationSetInformation_configurationSetArn - The Resource Name (ARN) of the ConfigurationSet.
$sel:configurationSetName:ConfigurationSetInformation', configurationSetInformation_configurationSetName - The name of the ConfigurationSet.
$sel:eventDestinations:ConfigurationSetInformation', configurationSetInformation_eventDestinations - An array of EventDestination objects that describe any events to log and
where to log them.
$sel:createdTimestamp:ConfigurationSetInformation', configurationSetInformation_createdTimestamp - The time when the ConfigurationSet was created, in
UNIX epoch time format.
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
data EventDestination Source #
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.
See: newEventDestination smart constructor.
Constructors
| EventDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Bool | |
| -> NonEmpty EventType | |
| -> EventDestination |
Create a value of EventDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogsDestination:EventDestination', eventDestination_cloudWatchLogsDestination - An object that contains information about an event destination that
sends logging events to Amazon CloudWatch logs.
$sel:kinesisFirehoseDestination:EventDestination', eventDestination_kinesisFirehoseDestination - An object that contains information about an event destination for
logging to Amazon Kinesis Data Firehose.
$sel:snsDestination:EventDestination', eventDestination_snsDestination - An object that contains information about an event destination that
sends logging events to Amazon SNS.
$sel:eventDestinationName:EventDestination', eventDestination_eventDestinationName - The name of the EventDestination.
$sel:enabled:EventDestination', eventDestination_enabled - When set to true events will be logged.
$sel:matchingEventTypes:EventDestination', eventDestination_matchingEventTypes - An array of event types that determine which events to log.
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
data KeywordFilter Source #
The information for keywords that meet a specified criteria.
See: newKeywordFilter smart constructor.
Constructors
| KeywordFilter' | |
Fields
| |
Instances
Arguments
| :: KeywordFilterName | |
| -> NonEmpty Text | |
| -> KeywordFilter |
Create a value of KeywordFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:KeywordFilter', keywordFilter_name - The name of the attribute to filter on.
$sel:values:KeywordFilter', keywordFilter_values - An array values to filter for.
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
data KeywordInformation Source #
The information for all keywords in a pool.
See: newKeywordInformation smart constructor.
Constructors
| KeywordInformation' | |
Fields
| |
Instances
newKeywordInformation Source #
Arguments
| :: Text | |
| -> Text | |
| -> KeywordAction | |
| -> KeywordInformation |
Create a value of KeywordInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyword:KeywordInformation', keywordInformation_keyword - The keyword as a string.
$sel:keywordMessage:KeywordInformation', keywordInformation_keywordMessage - A custom message that can be used with the keyword.
$sel:keywordAction:KeywordInformation', keywordInformation_keywordAction - The action to perform for the keyword.
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
data KinesisFirehoseDestination Source #
Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event destination.
Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.
See: newKinesisFirehoseDestination smart constructor.
Constructors
| KinesisFirehoseDestination' | |
Fields
| |
Instances
newKinesisFirehoseDestination Source #
Arguments
| :: Text | |
| -> Text | |
| -> KinesisFirehoseDestination |
Create a value of KinesisFirehoseDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamRoleArn:KinesisFirehoseDestination', kinesisFirehoseDestination_iamRoleArn - The ARN of an Amazon Identity and Access Management (IAM) role that is
able to write event data to an Amazon Firehose destination.
$sel:deliveryStreamArn:KinesisFirehoseDestination', kinesisFirehoseDestination_deliveryStreamArn - The Amazon Resource Name (ARN) of the delivery stream.
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
data OptOutListInformation Source #
The information for all OptOutList in an Amazon Web Services account.
See: newOptOutListInformation smart constructor.
Constructors
| OptOutListInformation' | |
Fields
| |
Instances
newOptOutListInformation Source #
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> OptOutListInformation |
Create a value of OptOutListInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optOutListArn:OptOutListInformation', optOutListInformation_optOutListArn - The Amazon Resource Name (ARN) of the OptOutList.
$sel:optOutListName:OptOutListInformation', optOutListInformation_optOutListName - The name of the OptOutList.
$sel:createdTimestamp:OptOutListInformation', optOutListInformation_createdTimestamp - The time when the OutOutList was created, in
UNIX epoch time format.
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
data OptedOutFilter Source #
The information for opted out numbers that meet a specified criteria.
See: newOptedOutFilter smart constructor.
Constructors
| OptedOutFilter' | |
Fields
| |
Instances
Arguments
| :: OptedOutFilterName | |
| -> NonEmpty Text | |
| -> OptedOutFilter |
Create a value of OptedOutFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:OptedOutFilter', optedOutFilter_name - The name of the attribute to filter on.
$sel:values:OptedOutFilter', optedOutFilter_values - An array of values to filter for.
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
data OptedOutNumberInformation Source #
The information for an opted out number in an Amazon Web Services account.
See: newOptedOutNumberInformation smart constructor.
Constructors
| OptedOutNumberInformation' | |
Fields
| |
Instances
newOptedOutNumberInformation Source #
Arguments
| :: Text | |
| -> UTCTime | |
| -> Bool | |
| -> OptedOutNumberInformation |
Create a value of OptedOutNumberInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optedOutNumber:OptedOutNumberInformation', optedOutNumberInformation_optedOutNumber - The phone number that is opted out.
$sel:optedOutTimestamp:OptedOutNumberInformation', optedOutNumberInformation_optedOutTimestamp - The time that the op tout occurred, in
UNIX epoch time format.
$sel:endUserOptedOut:OptedOutNumberInformation', optedOutNumberInformation_endUserOptedOut - This is set to true if it was the end recipient that opted out.
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
data OriginationIdentityMetadata Source #
The metadata for an origination identity associated with a pool.
See: newOriginationIdentityMetadata smart constructor.
Constructors
| OriginationIdentityMetadata' | |
Fields
| |
Instances
newOriginationIdentityMetadata Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> NonEmpty NumberCapability | |
| -> OriginationIdentityMetadata |
Create a value of OriginationIdentityMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:originationIdentityArn:OriginationIdentityMetadata', originationIdentityMetadata_originationIdentityArn - The Amazon Resource Name (ARN) associated with the origination identity.
$sel:originationIdentity:OriginationIdentityMetadata', originationIdentityMetadata_originationIdentity - The unique identifier of the origination identity.
$sel:isoCountryCode:OriginationIdentityMetadata', originationIdentityMetadata_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
$sel:numberCapabilities:OriginationIdentityMetadata', originationIdentityMetadata_numberCapabilities - Describes if the origination identity can be used for text messages,
voice calls or both.
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
data PhoneNumberFilter Source #
The information for a phone number that meets a specified criteria.
See: newPhoneNumberFilter smart constructor.
Constructors
| PhoneNumberFilter' | |
Fields
| |
Instances
Arguments
| :: PhoneNumberFilterName | |
| -> NonEmpty Text | |
| -> PhoneNumberFilter |
Create a value of PhoneNumberFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:PhoneNumberFilter', phoneNumberFilter_name - The name of the attribute to filter on.
$sel:values:PhoneNumberFilter', phoneNumberFilter_values - An array values to filter for.
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
data PhoneNumberInformation Source #
The information for a phone number in an Amazon Web Services account.
See: newPhoneNumberInformation smart constructor.
Constructors
| PhoneNumberInformation' | |
Fields
| |
Instances
newPhoneNumberInformation Source #
Arguments
| :: Text | |
| -> Text | |
| -> NumberStatus | |
| -> Text | |
| -> MessageType | |
| -> NonEmpty NumberCapability | |
| -> NumberType | |
| -> Text | |
| -> Bool | |
| -> Bool | |
| -> Text | |
| -> Bool | |
| -> UTCTime | |
| -> PhoneNumberInformation |
Create a value of PhoneNumberInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:phoneNumberId:PhoneNumberInformation', phoneNumberInformation_phoneNumberId - The unique identifier for the phone number.
$sel:poolId:PhoneNumberInformation', phoneNumberInformation_poolId - The unique identifier of the pool associated with the phone number.
$sel:twoWayChannelArn:PhoneNumberInformation', phoneNumberInformation_twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.
$sel:phoneNumberArn:PhoneNumberInformation', phoneNumberInformation_phoneNumberArn - The Amazon Resource Name (ARN) associated with the phone number.
$sel:phoneNumber:PhoneNumberInformation', phoneNumberInformation_phoneNumber - The phone number in E.164 format.
$sel:status:PhoneNumberInformation', phoneNumberInformation_status - The current status of the phone number.
$sel:isoCountryCode:PhoneNumberInformation', phoneNumberInformation_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
$sel:messageType:PhoneNumberInformation', phoneNumberInformation_messageType - The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:numberCapabilities:PhoneNumberInformation', phoneNumberInformation_numberCapabilities - Describes if the origination identity can be used for text messages,
voice calls or both.
$sel:numberType:PhoneNumberInformation', phoneNumberInformation_numberType - The type of phone number.
$sel:monthlyLeasingPrice:PhoneNumberInformation', phoneNumberInformation_monthlyLeasingPrice - The price, in US dollars, to lease the phone number.
$sel:twoWayEnabled:PhoneNumberInformation', phoneNumberInformation_twoWayEnabled - By default this is set to false. When set to true you can receive
incoming text messages from your end recipients using the
TwoWayChannelArn.
$sel:selfManagedOptOutsEnabled:PhoneNumberInformation', phoneNumberInformation_selfManagedOptOutsEnabled - When set to false an end recipient sends a message that begins with HELP
or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
replies with a customizable message and adds the end recipient to the
OptOutList. When set to true you're responsible for responding to HELP
and STOP requests. You're also responsible for tracking and honoring
opt-out request. For more information see
Self-managed opt-outs
$sel:optOutListName:PhoneNumberInformation', phoneNumberInformation_optOutListName - The name of the OptOutList associated with the phone number.
$sel:deletionProtectionEnabled:PhoneNumberInformation', phoneNumberInformation_deletionProtectionEnabled - When set to true the phone number can't be deleted.
$sel:createdTimestamp:PhoneNumberInformation', phoneNumberInformation_createdTimestamp - The time when the phone number was created, in
UNIX epoch time format.
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
data PoolFilter Source #
The information for a pool that meets a specified criteria.
See: newPoolFilter smart constructor.
Constructors
| PoolFilter' | |
Fields
| |
Instances
Create a value of PoolFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:PoolFilter', poolFilter_name - The name of the attribute to filter on.
$sel:values:PoolFilter', poolFilter_values - An array values to filter for.
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
data PoolInformation Source #
The information for a pool in an Amazon Web Services account.
See: newPoolInformation smart constructor.
Constructors
| PoolInformation' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PoolStatus | |
| -> MessageType | |
| -> Bool | |
| -> Bool | |
| -> Text | |
| -> Bool | |
| -> Bool | |
| -> UTCTime | |
| -> PoolInformation |
Create a value of PoolInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:twoWayChannelArn:PoolInformation', poolInformation_twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.
$sel:poolArn:PoolInformation', poolInformation_poolArn - The Amazon Resource Name (ARN) for the pool.
$sel:poolId:PoolInformation', poolInformation_poolId - The unique identifier for the pool.
$sel:status:PoolInformation', poolInformation_status - The current status of the pool.
$sel:messageType:PoolInformation', poolInformation_messageType - The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:twoWayEnabled:PoolInformation', poolInformation_twoWayEnabled - When set to true you can receive incoming text messages from your end
recipients using the TwoWayChannelArn.
$sel:selfManagedOptOutsEnabled:PoolInformation', poolInformation_selfManagedOptOutsEnabled - When set to false, an end recipient sends a message that begins with
HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
automatically replies with a customizable message and adds the end
recipient to the OptOutList. When set to true you're responsible for
responding to HELP and STOP requests. You're also responsible for
tracking and honoring opt-out requests. For more information see
Self-managed opt-outs
$sel:optOutListName:PoolInformation', poolInformation_optOutListName - The name of the OptOutList associated with the pool.
$sel:sharedRoutesEnabled:PoolInformation', poolInformation_sharedRoutesEnabled - Allows you to enable shared routes on your pool.
By default, this is set to False. If you set this value to True,
your messages are sent using phone numbers or sender IDs (depending on
the country) that are shared with other Amazon Pinpoint users. In some
countries, such as the United States, senders aren't allowed to use
shared routes and must use a dedicated phone number or short code.
$sel:deletionProtectionEnabled:PoolInformation', poolInformation_deletionProtectionEnabled - When set to true the pool can't be deleted.
$sel:createdTimestamp:PoolInformation', poolInformation_createdTimestamp - The time when the pool was created, in
UNIX epoch time format.
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
data PoolOriginationIdentitiesFilter Source #
Information about origination identities associated with a pool that meets a specified criteria.
See: newPoolOriginationIdentitiesFilter smart constructor.
Constructors
| PoolOriginationIdentitiesFilter' | |
Fields
| |
Instances
newPoolOriginationIdentitiesFilter Source #
Create a value of PoolOriginationIdentitiesFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:PoolOriginationIdentitiesFilter', poolOriginationIdentitiesFilter_name - The name of the attribute to filter on.
$sel:values:PoolOriginationIdentitiesFilter', poolOriginationIdentitiesFilter_values - An array values to filter for.
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
data SenderIdAndCountry Source #
The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.
See: newSenderIdAndCountry smart constructor.
Constructors
| SenderIdAndCountry' | |
Fields
| |
Instances
newSenderIdAndCountry Source #
Arguments
| :: Text | |
| -> Text | |
| -> SenderIdAndCountry |
Create a value of SenderIdAndCountry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:senderId:SenderIdAndCountry', senderIdAndCountry_senderId - The unique identifier of the sender.
$sel:isoCountryCode:SenderIdAndCountry', senderIdAndCountry_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
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
data SenderIdFilter Source #
The information for a sender ID that meets a specified criteria.
See: newSenderIdFilter smart constructor.
Constructors
| SenderIdFilter' | |
Fields
| |
Instances
Arguments
| :: SenderIdFilterName | |
| -> NonEmpty Text | |
| -> SenderIdFilter |
Create a value of SenderIdFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SenderIdFilter', senderIdFilter_name - The name of the attribute to filter on.
$sel:values:SenderIdFilter', senderIdFilter_values - An array of values to filter for.
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
data SenderIdInformation Source #
The information for all SenderIds in an Amazon Web Services account.
See: newSenderIdInformation smart constructor.
Constructors
| SenderIdInformation' | |
Fields
| |
Instances
newSenderIdInformation Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> SenderIdInformation |
Create a value of SenderIdInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:senderIdArn:SenderIdInformation', senderIdInformation_senderIdArn - The Amazon Resource Name (ARN) associated with the SenderId.
$sel:senderId:SenderIdInformation', senderIdInformation_senderId - The alphanumeric sender ID in a specific country that you'd like to
describe.
$sel:isoCountryCode:SenderIdInformation', senderIdInformation_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
$sel:messageTypes:SenderIdInformation', senderIdInformation_messageTypes - The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
$sel:monthlyLeasingPrice:SenderIdInformation', senderIdInformation_monthlyLeasingPrice - The monthly leasing price, in US dollars.
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
data SnsDestination Source #
An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
See: newSnsDestination smart constructor.
Constructors
| SnsDestination' | |
Instances
Arguments
| :: Text | |
| -> SnsDestination |
Create a value of SnsDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicArn:SnsDestination', snsDestination_topicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to
publish events to.
snsDestination_topicArn :: Lens' SnsDestination Text Source #
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
SpendLimit
data SpendLimit Source #
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
See: newSpendLimit smart constructor.
Constructors
| SpendLimit' | |
Fields
| |
Instances
Arguments
| :: SpendLimitName | |
| -> Integer | |
| -> Integer | |
| -> Bool | |
| -> SpendLimit |
Create a value of SpendLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SpendLimit', spendLimit_name - The name for the SpendLimit.
$sel:enforcedLimit:SpendLimit', spendLimit_enforcedLimit - The maximum amount of money, in US dollars, that you want to be able to
spend sending messages each month. This value has to be less than or
equal to the amount in MaxLimit. To use this custom limit,
Overridden must be set to true.
$sel:maxLimit:SpendLimit', spendLimit_maxLimit - The maximum amount of money that you are able to spend to send messages
each month, in US dollars.
$sel:overridden:SpendLimit', spendLimit_overridden - When set to True, the value that has been specified in the
EnforcedLimit is used to determine the maximum amount in US dollars
that can be spent to send messages each month, in US dollars.
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.
Tag
The list of tags to be added to the specified topic.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.PinpointSmsVoiceV2.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.PinpointSmsVoiceV2.Types.Tag" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key identifier, or name, of the tag.
$sel:value:Tag', tag_value - The string value associated with the key of the tag.