| 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.PinpointSMSVoice.Types
Description
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
- 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' {}
- newCallInstructionsMessageType :: CallInstructionsMessageType
- callInstructionsMessageType_text :: Lens' CallInstructionsMessageType (Maybe Text)
- data CloudWatchLogsDestination = CloudWatchLogsDestination' {
- iamRoleArn :: Maybe Text
- logGroupArn :: Maybe Text
- newCloudWatchLogsDestination :: CloudWatchLogsDestination
- cloudWatchLogsDestination_iamRoleArn :: Lens' CloudWatchLogsDestination (Maybe Text)
- cloudWatchLogsDestination_logGroupArn :: Lens' CloudWatchLogsDestination (Maybe Text)
- data EventDestination = EventDestination' {}
- newEventDestination :: EventDestination
- eventDestination_cloudWatchLogsDestination :: Lens' EventDestination (Maybe CloudWatchLogsDestination)
- eventDestination_enabled :: Lens' EventDestination (Maybe Bool)
- eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination)
- eventDestination_matchingEventTypes :: Lens' EventDestination (Maybe [EventType])
- eventDestination_name :: Lens' EventDestination (Maybe Text)
- eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination)
- data EventDestinationDefinition = EventDestinationDefinition' {}
- newEventDestinationDefinition :: EventDestinationDefinition
- eventDestinationDefinition_cloudWatchLogsDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchLogsDestination)
- eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool)
- eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination)
- eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType])
- eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination)
- data KinesisFirehoseDestination = KinesisFirehoseDestination' {}
- newKinesisFirehoseDestination :: KinesisFirehoseDestination
- kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination (Maybe Text)
- kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination (Maybe Text)
- data PlainTextMessageType = PlainTextMessageType' {}
- newPlainTextMessageType :: PlainTextMessageType
- plainTextMessageType_languageCode :: Lens' PlainTextMessageType (Maybe Text)
- plainTextMessageType_text :: Lens' PlainTextMessageType (Maybe Text)
- plainTextMessageType_voiceId :: Lens' PlainTextMessageType (Maybe Text)
- data SSMLMessageType = SSMLMessageType' {}
- newSSMLMessageType :: SSMLMessageType
- sSMLMessageType_languageCode :: Lens' SSMLMessageType (Maybe Text)
- sSMLMessageType_text :: Lens' SSMLMessageType (Maybe Text)
- sSMLMessageType_voiceId :: Lens' SSMLMessageType (Maybe Text)
- data SnsDestination = SnsDestination' {}
- newSnsDestination :: SnsDestination
- snsDestination_topicArn :: Lens' SnsDestination (Maybe Text)
- data VoiceMessageContent = VoiceMessageContent' {}
- newVoiceMessageContent :: VoiceMessageContent
- voiceMessageContent_callInstructionsMessage :: Lens' VoiceMessageContent (Maybe CallInstructionsMessageType)
- voiceMessageContent_plainTextMessage :: Lens' VoiceMessageContent (Maybe PlainTextMessageType)
- voiceMessageContent_sSMLMessage :: Lens' VoiceMessageContent (Maybe SSMLMessageType)
Service Configuration
defaultService :: Service Source #
API version 2018-09-05 of the Amazon Pinpoint SMS and Voice Service SDK configuration.
Errors
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource specified in your request already exists.
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input you provided is invalid.
_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 :: AsError a => Fold a ServiceError Source #
There are too many instances of the specified resource type.
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resource you attempted to access doesn't exist.
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
You've issued too many requests to the resource. Wait a few minutes, and then try again.
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' | |
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.
callInstructionsMessageType_text :: Lens' CallInstructionsMessageType (Maybe Text) Source #
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' | |
Fields
| |
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.
cloudWatchLogsDestination_iamRoleArn :: Lens' CloudWatchLogsDestination (Maybe 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 (Maybe Text) Source #
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' | |
Fields
| |
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.
eventDestination_cloudWatchLogsDestination :: Lens' EventDestination (Maybe CloudWatchLogsDestination) Source #
Undocumented member.
eventDestination_enabled :: Lens' EventDestination (Maybe Bool) Source #
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.
eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) Source #
Undocumented member.
eventDestination_matchingEventTypes :: Lens' EventDestination (Maybe [EventType]) Source #
Undocumented member.
eventDestination_name :: Lens' EventDestination (Maybe Text) Source #
A name that identifies the event destination configuration.
eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination) Source #
Undocumented member.
EventDestinationDefinition
data EventDestinationDefinition Source #
An object that defines a single event destination.
See: newEventDestinationDefinition smart constructor.
Constructors
| EventDestinationDefinition' | |
Fields
| |
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.
eventDestinationDefinition_cloudWatchLogsDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchLogsDestination) Source #
Undocumented member.
eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool) Source #
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.
eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination) Source #
Undocumented member.
eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType]) Source #
Undocumented member.
eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination) Source #
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' | |
Fields
| |
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.
kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination (Maybe Text) Source #
The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.
kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination (Maybe Text) Source #
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.
Constructors
| PlainTextMessageType' | |
Fields
| |
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.
plainTextMessageType_languageCode :: Lens' PlainTextMessageType (Maybe Text) Source #
The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.
plainTextMessageType_text :: Lens' PlainTextMessageType (Maybe Text) Source #
The plain (not SSML-formatted) text to deliver to the recipient.
plainTextMessageType_voiceId :: Lens' PlainTextMessageType (Maybe Text) Source #
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.
Constructors
| SSMLMessageType' | |
Fields
| |
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.
sSMLMessageType_languageCode :: Lens' SSMLMessageType (Maybe Text) Source #
The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.
sSMLMessageType_text :: Lens' SSMLMessageType (Maybe Text) Source #
The SSML-formatted text to deliver to the recipient.
sSMLMessageType_voiceId :: Lens' SSMLMessageType (Maybe Text) Source #
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' | |
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.
snsDestination_topicArn :: Lens' SnsDestination (Maybe Text) Source #
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' | |
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.
voiceMessageContent_callInstructionsMessage :: Lens' VoiceMessageContent (Maybe CallInstructionsMessageType) Source #
Undocumented member.
voiceMessageContent_plainTextMessage :: Lens' VoiceMessageContent (Maybe PlainTextMessageType) Source #
Undocumented member.
voiceMessageContent_sSMLMessage :: Lens' VoiceMessageContent (Maybe SSMLMessageType) Source #
Undocumented member.