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.SendVoiceMessage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.

Synopsis

data SendVoiceMessage = SendVoiceMessage' {
- configurationSetName :: Maybe Text
- context :: Maybe (HashMap Text Text)
- dryRun :: Maybe Bool
- maxPricePerMinute :: Maybe Text
- messageBody :: Maybe Text
- messageBodyTextType :: Maybe VoiceMessageBodyTextType
- timeToLive :: Maybe Natural
- voiceId :: Maybe VoiceId
- destinationPhoneNumber :: Text
- originationIdentity :: Text
}
newSendVoiceMessage :: Text -> Text -> SendVoiceMessage
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
data SendVoiceMessageResponse = SendVoiceMessageResponse' {
- messageId :: Maybe Text
- httpStatus :: Int
}
newSendVoiceMessageResponse :: Int -> SendVoiceMessageResponse
sendVoiceMessageResponse_messageId :: Lens' SendVoiceMessageResponse (Maybe Text)
sendVoiceMessageResponse_httpStatus :: Lens' SendVoiceMessageResponse Int

Creating a Request

data SendVoiceMessage Source #

See: newSendVoiceMessage smart constructor.

Constructors

SendVoiceMessage'

Fields

configurationSetName :: Maybe Text
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
context :: Maybe (HashMap Text Text)
You can specify custom data in this field. If you do, that data is logged to the event destination.
dryRun :: Maybe Bool
When set to true, the message is checked and validated, but isn't sent to the end recipient.
maxPricePerMinute :: Maybe Text
The maximum amount to spend per voice message, in US dollars.
messageBody :: Maybe Text
The text to convert to a voice message.
messageBodyTextType :: Maybe VoiceMessageBodyTextType
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.
timeToLive :: Maybe Natural
How long the voice message is valid for. By default this is 72 hours.
voiceId :: Maybe VoiceId
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
destinationPhoneNumber :: Text
The destination phone number in E.164 format.
originationIdentity :: Text
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

Instances

Instances details

ToJSON SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods toJSON :: SendVoiceMessage -> Value # toEncoding :: SendVoiceMessage -> Encoding # toJSONList :: [SendVoiceMessage] -> Value # toEncodingList :: [SendVoiceMessage] -> Encoding #
ToHeaders SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods toHeaders :: SendVoiceMessage -> [Header] #
ToPath SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods toPath :: SendVoiceMessage -> ByteString #
ToQuery SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods toQuery :: SendVoiceMessage -> QueryString #
AWSRequest SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Associated Types type AWSResponse SendVoiceMessage # Methods request :: (Service -> Service) -> SendVoiceMessage -> Request SendVoiceMessage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendVoiceMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendVoiceMessage))) #
Generic SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Associated Types type Rep SendVoiceMessage :: Type -> Type # Methods from :: SendVoiceMessage -> Rep SendVoiceMessage x # to :: Rep SendVoiceMessage x -> SendVoiceMessage #
Read SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods readsPrec :: Int -> ReadS SendVoiceMessage # readList :: ReadS [SendVoiceMessage] # readPrec :: ReadPrec SendVoiceMessage # readListPrec :: ReadPrec [SendVoiceMessage] #
Show SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods showsPrec :: Int -> SendVoiceMessage -> ShowS # show :: SendVoiceMessage -> String # showList :: [SendVoiceMessage] -> ShowS #
NFData SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods rnf :: SendVoiceMessage -> () #
Eq SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods (==) :: SendVoiceMessage -> SendVoiceMessage -> Bool # (/=) :: SendVoiceMessage -> SendVoiceMessage -> Bool #
Hashable SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods hashWithSalt :: Int -> SendVoiceMessage -> Int # hash :: SendVoiceMessage -> Int #
type AWSResponse SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage type AWSResponse SendVoiceMessage = SendVoiceMessageResponse
type Rep SendVoiceMessage Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage type Rep SendVoiceMessage = D1 ('MetaData "SendVoiceMessage" "Amazonka.PinpointSmsVoiceV2.SendVoiceMessage" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "SendVoiceMessage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "maxPricePerMinute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "messageBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "messageBodyTextType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceMessageBodyTextType)) :: S1 ('MetaSel ('Just "timeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceId)) :: (S1 ('MetaSel ('Just "destinationPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "originationIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSendVoiceMessage Source #

Arguments

:: Text	`$sel:destinationPhoneNumber:SendVoiceMessage'`
-> Text	`SendVoiceMessage`
-> SendVoiceMessage

Create a value of SendVoiceMessage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SendVoiceMessage, sendVoiceMessage_configurationSetName - The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

$sel:context:SendVoiceMessage', sendVoiceMessage_context - You can specify custom data in this field. If you do, that data is logged to the event destination.

$sel:dryRun:SendVoiceMessage', sendVoiceMessage_dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient.

$sel:maxPricePerMinute:SendVoiceMessage', sendVoiceMessage_maxPricePerMinute - The maximum amount to spend per voice message, in US dollars.

$sel:messageBody:SendVoiceMessage', sendVoiceMessage_messageBody - The text to convert to a voice message.

$sel:messageBodyTextType:SendVoiceMessage', sendVoiceMessage_messageBodyTextType - Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

TEXT: This is the default value. When used the maximum character limit is 3000.
SSML: When used the maximum character limit is 6000 including SSML tagging.

$sel:timeToLive:SendVoiceMessage', sendVoiceMessage_timeToLive - How long the voice message is valid for. By default this is 72 hours.

$sel:voiceId:SendVoiceMessage', sendVoiceMessage_voiceId - The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

$sel:destinationPhoneNumber:SendVoiceMessage', sendVoiceMessage_destinationPhoneNumber - The destination phone number in E.164 format.

SendVoiceMessage, sendVoiceMessage_originationIdentity - The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

Request Lenses

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.

Destructuring the Response

data SendVoiceMessageResponse Source #

See: newSendVoiceMessageResponse smart constructor.

Constructors

SendVoiceMessageResponse'
Fields messageId :: Maybe Text The unique identifier for the message. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Associated Types type Rep SendVoiceMessageResponse :: Type -> Type # Methods from :: SendVoiceMessageResponse -> Rep SendVoiceMessageResponse x # to :: Rep SendVoiceMessageResponse x -> SendVoiceMessageResponse #
Read SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods readsPrec :: Int -> ReadS SendVoiceMessageResponse # readList :: ReadS [SendVoiceMessageResponse] # readPrec :: ReadPrec SendVoiceMessageResponse # readListPrec :: ReadPrec [SendVoiceMessageResponse] #
Show SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods showsPrec :: Int -> SendVoiceMessageResponse -> ShowS # show :: SendVoiceMessageResponse -> String # showList :: [SendVoiceMessageResponse] -> ShowS #
NFData SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods rnf :: SendVoiceMessageResponse -> () #
Eq SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage Methods (==) :: SendVoiceMessageResponse -> SendVoiceMessageResponse -> Bool # (/=) :: SendVoiceMessageResponse -> SendVoiceMessageResponse -> Bool #
type Rep SendVoiceMessageResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.SendVoiceMessage type Rep SendVoiceMessageResponse = D1 ('MetaData "SendVoiceMessageResponse" "Amazonka.PinpointSmsVoiceV2.SendVoiceMessage" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "SendVoiceMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendVoiceMessageResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendVoiceMessageResponse'`
-> SendVoiceMessageResponse

Create a value of SendVoiceMessageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:messageId:SendVoiceMessageResponse', sendVoiceMessageResponse_messageId - The unique identifier for the message.

$sel:httpStatus:SendVoiceMessageResponse', sendVoiceMessageResponse_httpStatus - The response's http status code.

Response Lenses

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.