| 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.SmsVoice
Description
Derived from API version 2018-09-05 of the AWS service descriptions, licensed under Apache 2.0.
Pinpoint SMS and Voice Messaging public facing APIs
Synopsis
- defaultService :: Service
- _AlreadyExistsException :: AsError a => Fold a ServiceError
- _BadRequestException :: AsError a => Fold a ServiceError
- _InternalServiceErrorException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- data CreateConfigurationSet = CreateConfigurationSet' (Maybe Text)
- newCreateConfigurationSet :: CreateConfigurationSet
- data CreateConfigurationSetResponse = CreateConfigurationSetResponse' Int
- newCreateConfigurationSetResponse :: Int -> CreateConfigurationSetResponse
- data CreateConfigurationSetEventDestination = CreateConfigurationSetEventDestination' (Maybe EventDestinationDefinition) (Maybe Text) Text
- newCreateConfigurationSetEventDestination :: Text -> CreateConfigurationSetEventDestination
- data CreateConfigurationSetEventDestinationResponse = CreateConfigurationSetEventDestinationResponse' Int
- newCreateConfigurationSetEventDestinationResponse :: Int -> CreateConfigurationSetEventDestinationResponse
- data DeleteConfigurationSet = DeleteConfigurationSet' Text
- newDeleteConfigurationSet :: Text -> DeleteConfigurationSet
- data DeleteConfigurationSetResponse = DeleteConfigurationSetResponse' Int
- newDeleteConfigurationSetResponse :: Int -> DeleteConfigurationSetResponse
- data DeleteConfigurationSetEventDestination = DeleteConfigurationSetEventDestination' Text Text
- newDeleteConfigurationSetEventDestination :: Text -> Text -> DeleteConfigurationSetEventDestination
- data DeleteConfigurationSetEventDestinationResponse = DeleteConfigurationSetEventDestinationResponse' Int
- newDeleteConfigurationSetEventDestinationResponse :: Int -> DeleteConfigurationSetEventDestinationResponse
- data GetConfigurationSetEventDestinations = GetConfigurationSetEventDestinations' Text
- newGetConfigurationSetEventDestinations :: Text -> GetConfigurationSetEventDestinations
- data GetConfigurationSetEventDestinationsResponse = GetConfigurationSetEventDestinationsResponse' (Maybe [EventDestination]) Int
- newGetConfigurationSetEventDestinationsResponse :: Int -> GetConfigurationSetEventDestinationsResponse
- data ListConfigurationSets = ListConfigurationSets' (Maybe Text) (Maybe Text)
- newListConfigurationSets :: ListConfigurationSets
- data ListConfigurationSetsResponse = ListConfigurationSetsResponse' (Maybe [Text]) (Maybe Text) Int
- newListConfigurationSetsResponse :: Int -> ListConfigurationSetsResponse
- data SendVoiceMessage = SendVoiceMessage' (Maybe Text) (Maybe Text) (Maybe VoiceMessageContent) (Maybe Text) (Maybe Text)
- newSendVoiceMessage :: SendVoiceMessage
- data SendVoiceMessageResponse = SendVoiceMessageResponse' (Maybe Text) Int
- newSendVoiceMessageResponse :: Int -> SendVoiceMessageResponse
- data UpdateConfigurationSetEventDestination = UpdateConfigurationSetEventDestination' (Maybe EventDestinationDefinition) Text Text
- newUpdateConfigurationSetEventDestination :: Text -> Text -> UpdateConfigurationSetEventDestination
- data UpdateConfigurationSetEventDestinationResponse = UpdateConfigurationSetEventDestinationResponse' Int
- newUpdateConfigurationSetEventDestinationResponse :: Int -> UpdateConfigurationSetEventDestinationResponse
- newtype EventType where
- EventType' { }
- pattern EventType_ANSWERED :: EventType
- pattern EventType_BUSY :: EventType
- pattern EventType_COMPLETED_CALL :: EventType
- pattern EventType_FAILED :: EventType
- pattern EventType_INITIATED_CALL :: EventType
- pattern EventType_NO_ANSWER :: EventType
- pattern EventType_RINGING :: EventType
- data CallInstructionsMessageType = CallInstructionsMessageType' (Maybe Text)
- newCallInstructionsMessageType :: CallInstructionsMessageType
- data CloudWatchLogsDestination = CloudWatchLogsDestination' (Maybe Text) (Maybe Text)
- newCloudWatchLogsDestination :: CloudWatchLogsDestination
- data EventDestination = EventDestination' (Maybe CloudWatchLogsDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe [EventType]) (Maybe Text) (Maybe SnsDestination)
- newEventDestination :: EventDestination
- data EventDestinationDefinition = EventDestinationDefinition' (Maybe CloudWatchLogsDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe [EventType]) (Maybe SnsDestination)
- newEventDestinationDefinition :: EventDestinationDefinition
- data KinesisFirehoseDestination = KinesisFirehoseDestination' (Maybe Text) (Maybe Text)
- newKinesisFirehoseDestination :: KinesisFirehoseDestination
- data PlainTextMessageType = PlainTextMessageType' (Maybe Text) (Maybe Text) (Maybe Text)
- newPlainTextMessageType :: PlainTextMessageType
- data SSMLMessageType = SSMLMessageType' (Maybe Text) (Maybe Text) (Maybe Text)
- newSSMLMessageType :: SSMLMessageType
- data SnsDestination = SnsDestination' (Maybe Text)
- newSnsDestination :: SnsDestination
- data VoiceMessageContent = VoiceMessageContent' (Maybe CallInstructionsMessageType) (Maybe PlainTextMessageType) (Maybe SSMLMessageType)
- newVoiceMessageContent :: VoiceMessageContent
Service Configuration
defaultService :: Service Source #
API version 2018-09-05 of the Amazon Pinpoint SMS and Voice Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SmsVoice.
AlreadyExistsException
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource specified in your request already exists.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input you provided is invalid.
InternalServiceErrorException
_InternalServiceErrorException :: 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.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
There are too many instances of the specified resource type.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resource you attempted to access doesn't exist.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
You've issued too many requests to the resource. Wait a few minutes, and then try again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateConfigurationSet
data CreateConfigurationSet Source #
A request to create a new configuration set.
See: newCreateConfigurationSet smart constructor.
Constructors
| CreateConfigurationSet' (Maybe Text) |
Instances
newCreateConfigurationSet :: CreateConfigurationSet Source #
Create a value of CreateConfigurationSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationSetName:CreateConfigurationSet', createConfigurationSet_configurationSetName - The name that you want to give the configuration set.
data CreateConfigurationSetResponse Source #
An empty object that indicates that the configuration set was successfully created.
See: newCreateConfigurationSetResponse smart constructor.
Constructors
| CreateConfigurationSetResponse' Int |
Instances
newCreateConfigurationSetResponse Source #
Create a value of CreateConfigurationSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateConfigurationSetResponse', createConfigurationSetResponse_httpStatus - The response's http status code.
CreateConfigurationSetEventDestination
data CreateConfigurationSetEventDestination Source #
Create a new event destination in a configuration set.
See: newCreateConfigurationSetEventDestination smart constructor.
Constructors
| CreateConfigurationSetEventDestination' (Maybe EventDestinationDefinition) (Maybe Text) Text |
Instances
newCreateConfigurationSetEventDestination Source #
Arguments
| :: Text |
|
| -> CreateConfigurationSetEventDestination |
Create a value of CreateConfigurationSetEventDestination 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:eventDestination:CreateConfigurationSetEventDestination', createConfigurationSetEventDestination_eventDestination - Undocumented member.
$sel:eventDestinationName:CreateConfigurationSetEventDestination', createConfigurationSetEventDestination_eventDestinationName - A name that identifies the event destination.
$sel:configurationSetName:CreateConfigurationSetEventDestination', createConfigurationSetEventDestination_configurationSetName - ConfigurationSetName
data CreateConfigurationSetEventDestinationResponse Source #
An empty object that indicates that the event destination was created successfully.
See: newCreateConfigurationSetEventDestinationResponse smart constructor.
Constructors
| CreateConfigurationSetEventDestinationResponse' Int |
Instances
newCreateConfigurationSetEventDestinationResponse Source #
Arguments
| :: Int |
|
| -> CreateConfigurationSetEventDestinationResponse |
Create a value of CreateConfigurationSetEventDestinationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateConfigurationSetEventDestinationResponse', createConfigurationSetEventDestinationResponse_httpStatus - The response's http status code.
DeleteConfigurationSet
data DeleteConfigurationSet Source #
See: newDeleteConfigurationSet smart constructor.
Constructors
| DeleteConfigurationSet' Text |
Instances
newDeleteConfigurationSet Source #
Create a value of DeleteConfigurationSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationSetName:DeleteConfigurationSet', deleteConfigurationSet_configurationSetName - ConfigurationSetName
data DeleteConfigurationSetResponse Source #
An empty object that indicates that the configuration set was deleted successfully.
See: newDeleteConfigurationSetResponse smart constructor.
Constructors
| DeleteConfigurationSetResponse' Int |
Instances
newDeleteConfigurationSetResponse Source #
Create a value of DeleteConfigurationSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteConfigurationSetResponse', deleteConfigurationSetResponse_httpStatus - The response's http status code.
DeleteConfigurationSetEventDestination
data DeleteConfigurationSetEventDestination Source #
See: newDeleteConfigurationSetEventDestination smart constructor.
Constructors
| DeleteConfigurationSetEventDestination' Text Text |
Instances
newDeleteConfigurationSetEventDestination Source #
Arguments
| :: Text |
|
| -> Text |
|
| -> DeleteConfigurationSetEventDestination |
Create a value of DeleteConfigurationSetEventDestination 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:eventDestinationName:DeleteConfigurationSetEventDestination', deleteConfigurationSetEventDestination_eventDestinationName - EventDestinationName
$sel:configurationSetName:DeleteConfigurationSetEventDestination', deleteConfigurationSetEventDestination_configurationSetName - ConfigurationSetName
data DeleteConfigurationSetEventDestinationResponse Source #
An empty object that indicates that the event destination was deleted successfully.
See: newDeleteConfigurationSetEventDestinationResponse smart constructor.
Constructors
| DeleteConfigurationSetEventDestinationResponse' Int |
Instances
newDeleteConfigurationSetEventDestinationResponse Source #
Arguments
| :: Int |
|
| -> DeleteConfigurationSetEventDestinationResponse |
Create a value of DeleteConfigurationSetEventDestinationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteConfigurationSetEventDestinationResponse', deleteConfigurationSetEventDestinationResponse_httpStatus - The response's http status code.
GetConfigurationSetEventDestinations
data GetConfigurationSetEventDestinations Source #
See: newGetConfigurationSetEventDestinations smart constructor.
Constructors
| GetConfigurationSetEventDestinations' Text |
Instances
newGetConfigurationSetEventDestinations Source #
Arguments
| :: Text |
|
| -> GetConfigurationSetEventDestinations |
Create a value of GetConfigurationSetEventDestinations 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:configurationSetName:GetConfigurationSetEventDestinations', getConfigurationSetEventDestinations_configurationSetName - ConfigurationSetName
data GetConfigurationSetEventDestinationsResponse Source #
An object that contains information about an event destination.
See: newGetConfigurationSetEventDestinationsResponse smart constructor.
Constructors
| GetConfigurationSetEventDestinationsResponse' (Maybe [EventDestination]) Int |
Instances
newGetConfigurationSetEventDestinationsResponse Source #
Arguments
| :: Int |
|
| -> GetConfigurationSetEventDestinationsResponse |
Create a value of GetConfigurationSetEventDestinationsResponse 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:eventDestinations:GetConfigurationSetEventDestinationsResponse', getConfigurationSetEventDestinationsResponse_eventDestinations - Undocumented member.
$sel:httpStatus:GetConfigurationSetEventDestinationsResponse', getConfigurationSetEventDestinationsResponse_httpStatus - The response's http status code.
ListConfigurationSets
data ListConfigurationSets Source #
See: newListConfigurationSets smart constructor.
Constructors
| ListConfigurationSets' (Maybe Text) (Maybe Text) |
Instances
newListConfigurationSets :: ListConfigurationSets Source #
Create a value of ListConfigurationSets 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:
ListConfigurationSets, listConfigurationSets_nextToken - A token returned from a previous call to the API that indicates the
position in the list of results.
$sel:pageSize:ListConfigurationSets', listConfigurationSets_pageSize - Used to specify the number of items that should be returned in the
response.
data ListConfigurationSetsResponse Source #
An object that contains information about the configuration sets for your account in the current region.
See: newListConfigurationSetsResponse smart constructor.
Instances
newListConfigurationSetsResponse Source #
Create a value of ListConfigurationSetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationSets:ListConfigurationSetsResponse', listConfigurationSetsResponse_configurationSets - An object that contains a list of configuration sets for your account in
the current region.
ListConfigurationSets, listConfigurationSetsResponse_nextToken - A token returned from a previous call to ListConfigurationSets to
indicate the position in the list of configuration sets.
$sel:httpStatus:ListConfigurationSetsResponse', listConfigurationSetsResponse_httpStatus - The response's http status code.
SendVoiceMessage
data SendVoiceMessage Source #
SendVoiceMessageRequest
See: newSendVoiceMessage smart constructor.
Constructors
| SendVoiceMessage' (Maybe Text) (Maybe Text) (Maybe VoiceMessageContent) (Maybe Text) (Maybe Text) |
Instances
newSendVoiceMessage :: SendVoiceMessage Source #
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:
$sel:callerId:SendVoiceMessage', sendVoiceMessage_callerId - The phone number that appears on recipients' devices when they receive
the message.
$sel:configurationSetName:SendVoiceMessage', sendVoiceMessage_configurationSetName - The name of the configuration set that you want to use to send the
message.
$sel:content:SendVoiceMessage', sendVoiceMessage_content - Undocumented member.
$sel:destinationPhoneNumber:SendVoiceMessage', sendVoiceMessage_destinationPhoneNumber - The phone number that you want to send the voice message to.
$sel:originationPhoneNumber:SendVoiceMessage', sendVoiceMessage_originationPhoneNumber - The phone number that Amazon Pinpoint should use to send the voice
message. This isn't necessarily the phone number that appears on
recipients' devices when they receive the message, because you can
specify a CallerId parameter in the request.
data SendVoiceMessageResponse Source #
An object that that contains the Message ID of a Voice message that was sent successfully.
See: newSendVoiceMessageResponse smart constructor.
Constructors
| SendVoiceMessageResponse' (Maybe Text) Int |
Instances
newSendVoiceMessageResponse Source #
Create a value of SendVoiceMessageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageId:SendVoiceMessageResponse', sendVoiceMessageResponse_messageId - A unique identifier for the voice message.
$sel:httpStatus:SendVoiceMessageResponse', sendVoiceMessageResponse_httpStatus - The response's http status code.
UpdateConfigurationSetEventDestination
data UpdateConfigurationSetEventDestination Source #
UpdateConfigurationSetEventDestinationRequest
See: newUpdateConfigurationSetEventDestination smart constructor.
Instances
newUpdateConfigurationSetEventDestination Source #
Arguments
| :: Text |
|
| -> Text |
|
| -> UpdateConfigurationSetEventDestination |
Create a value of UpdateConfigurationSetEventDestination 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:eventDestination:UpdateConfigurationSetEventDestination', updateConfigurationSetEventDestination_eventDestination - Undocumented member.
$sel:eventDestinationName:UpdateConfigurationSetEventDestination', updateConfigurationSetEventDestination_eventDestinationName - EventDestinationName
$sel:configurationSetName:UpdateConfigurationSetEventDestination', updateConfigurationSetEventDestination_configurationSetName - ConfigurationSetName
data UpdateConfigurationSetEventDestinationResponse Source #
An empty object that indicates that the event destination was updated successfully.
See: newUpdateConfigurationSetEventDestinationResponse smart constructor.
Constructors
| UpdateConfigurationSetEventDestinationResponse' Int |
Instances
newUpdateConfigurationSetEventDestinationResponse Source #
Arguments
| :: Int |
|
| -> UpdateConfigurationSetEventDestinationResponse |
Create a value of UpdateConfigurationSetEventDestinationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateConfigurationSetEventDestinationResponse', updateConfigurationSetEventDestinationResponse_httpStatus - The response's http status code.
Types
EventType
The types of events that are sent to the event destination.
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_ANSWERED :: EventType | |
| pattern EventType_BUSY :: EventType | |
| pattern EventType_COMPLETED_CALL :: EventType | |
| pattern EventType_FAILED :: EventType | |
| pattern EventType_INITIATED_CALL :: EventType | |
| pattern EventType_NO_ANSWER :: EventType | |
| pattern EventType_RINGING :: EventType |
Instances
CallInstructionsMessageType
data CallInstructionsMessageType Source #
An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup.
See: newCallInstructionsMessageType smart constructor.
Constructors
| CallInstructionsMessageType' (Maybe Text) |
Instances
newCallInstructionsMessageType :: CallInstructionsMessageType Source #
Create a value of CallInstructionsMessageType 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:text:CallInstructionsMessageType', callInstructionsMessageType_text - The language to use when delivering the message. For a complete list of
supported languages, see the Amazon Polly Developer Guide.
CloudWatchLogsDestination
data CloudWatchLogsDestination Source #
An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.
See: newCloudWatchLogsDestination smart constructor.
Constructors
| CloudWatchLogsDestination' (Maybe Text) (Maybe Text) |
Instances
newCloudWatchLogsDestination :: CloudWatchLogsDestination Source #
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.
EventDestination
data EventDestination Source #
An object that defines an event destination.
See: newEventDestination smart constructor.
Constructors
| EventDestination' (Maybe CloudWatchLogsDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe [EventType]) (Maybe Text) (Maybe SnsDestination) |
Instances
newEventDestination :: EventDestination Source #
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 - Undocumented member.
$sel:enabled:EventDestination', eventDestination_enabled - Indicates whether or not the event destination is enabled. If the event
destination is enabled, then Amazon Pinpoint sends response data to the
specified event destination.
$sel:kinesisFirehoseDestination:EventDestination', eventDestination_kinesisFirehoseDestination - Undocumented member.
$sel:matchingEventTypes:EventDestination', eventDestination_matchingEventTypes - Undocumented member.
$sel:name:EventDestination', eventDestination_name - A name that identifies the event destination configuration.
$sel:snsDestination:EventDestination', eventDestination_snsDestination - Undocumented member.
EventDestinationDefinition
data EventDestinationDefinition Source #
An object that defines a single event destination.
See: newEventDestinationDefinition smart constructor.
Constructors
| EventDestinationDefinition' (Maybe CloudWatchLogsDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe [EventType]) (Maybe SnsDestination) |
Instances
newEventDestinationDefinition :: EventDestinationDefinition Source #
Create a value of EventDestinationDefinition 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:EventDestinationDefinition', eventDestinationDefinition_cloudWatchLogsDestination - Undocumented member.
$sel:enabled:EventDestinationDefinition', eventDestinationDefinition_enabled - Indicates whether or not the event destination is enabled. If the event
destination is enabled, then Amazon Pinpoint sends response data to the
specified event destination.
$sel:kinesisFirehoseDestination:EventDestinationDefinition', eventDestinationDefinition_kinesisFirehoseDestination - Undocumented member.
$sel:matchingEventTypes:EventDestinationDefinition', eventDestinationDefinition_matchingEventTypes - Undocumented member.
$sel:snsDestination:EventDestinationDefinition', eventDestinationDefinition_snsDestination - Undocumented member.
KinesisFirehoseDestination
data KinesisFirehoseDestination Source #
An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
See: newKinesisFirehoseDestination smart constructor.
Constructors
| KinesisFirehoseDestination' (Maybe Text) (Maybe Text) |
Instances
newKinesisFirehoseDestination :: KinesisFirehoseDestination Source #
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:deliveryStreamArn:KinesisFirehoseDestination', kinesisFirehoseDestination_deliveryStreamArn - The Amazon Resource Name (ARN) of an IAM role that can write data to an
Amazon Kinesis Data Firehose stream.
$sel:iamRoleArn:KinesisFirehoseDestination', kinesisFirehoseDestination_iamRoleArn - The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose
destination that you want to use in the event destination.
PlainTextMessageType
data PlainTextMessageType Source #
An object that defines a message that contains unformatted text.
See: newPlainTextMessageType smart constructor.
Instances
newPlainTextMessageType :: PlainTextMessageType Source #
Create a value of PlainTextMessageType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:PlainTextMessageType', plainTextMessageType_languageCode - The language to use when delivering the message. For a complete list of
supported languages, see the Amazon Polly Developer Guide.
$sel:text:PlainTextMessageType', plainTextMessageType_text - The plain (not SSML-formatted) text to deliver to the recipient.
$sel:voiceId:PlainTextMessageType', plainTextMessageType_voiceId - The name of the voice that you want to use to deliver the message. For a
complete list of supported voices, see the Amazon Polly Developer Guide.
SSMLMessageType
data SSMLMessageType Source #
An object that defines a message that contains SSML-formatted text.
See: newSSMLMessageType smart constructor.
Instances
newSSMLMessageType :: SSMLMessageType Source #
Create a value of SSMLMessageType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:SSMLMessageType', sSMLMessageType_languageCode - The language to use when delivering the message. For a complete list of
supported languages, see the Amazon Polly Developer Guide.
$sel:text:SSMLMessageType', sSMLMessageType_text - The SSML-formatted text to deliver to the recipient.
$sel:voiceId:SSMLMessageType', sSMLMessageType_voiceId - The name of the voice that you want to use to deliver the message. For a
complete list of supported voices, see the Amazon Polly Developer Guide.
SnsDestination
data SnsDestination Source #
An object that contains information about an event destination that sends data to Amazon SNS.
See: newSnsDestination smart constructor.
Constructors
| SnsDestination' (Maybe Text) |
Instances
newSnsDestination :: SnsDestination Source #
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.
VoiceMessageContent
data VoiceMessageContent Source #
An object that contains a voice message and information about the recipient that you want to send it to.
See: newVoiceMessageContent smart constructor.
Constructors
| VoiceMessageContent' (Maybe CallInstructionsMessageType) (Maybe PlainTextMessageType) (Maybe SSMLMessageType) |
Instances
newVoiceMessageContent :: VoiceMessageContent Source #
Create a value of VoiceMessageContent 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:callInstructionsMessage:VoiceMessageContent', voiceMessageContent_callInstructionsMessage - Undocumented member.
$sel:plainTextMessage:VoiceMessageContent', voiceMessageContent_plainTextMessage - Undocumented member.
$sel:sSMLMessage:VoiceMessageContent', voiceMessageContent_sSMLMessage - Undocumented member.