aws-sdk-pinpointsmsvoice 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,253 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::PinpointSMSVoice
9
+ # @api private
10
+ module ClientApi
11
+
12
+ include Seahorse::Model
13
+
14
+ AlreadyExistsException = Shapes::StructureShape.new(name: 'AlreadyExistsException')
15
+ BadRequestException = Shapes::StructureShape.new(name: 'BadRequestException')
16
+ Boolean = Shapes::BooleanShape.new(name: 'Boolean')
17
+ CallInstructionsMessageType = Shapes::StructureShape.new(name: 'CallInstructionsMessageType')
18
+ CloudWatchLogsDestination = Shapes::StructureShape.new(name: 'CloudWatchLogsDestination')
19
+ CreateConfigurationSetEventDestinationRequest = Shapes::StructureShape.new(name: 'CreateConfigurationSetEventDestinationRequest')
20
+ CreateConfigurationSetEventDestinationResponse = Shapes::StructureShape.new(name: 'CreateConfigurationSetEventDestinationResponse')
21
+ CreateConfigurationSetRequest = Shapes::StructureShape.new(name: 'CreateConfigurationSetRequest')
22
+ CreateConfigurationSetResponse = Shapes::StructureShape.new(name: 'CreateConfigurationSetResponse')
23
+ DeleteConfigurationSetEventDestinationRequest = Shapes::StructureShape.new(name: 'DeleteConfigurationSetEventDestinationRequest')
24
+ DeleteConfigurationSetEventDestinationResponse = Shapes::StructureShape.new(name: 'DeleteConfigurationSetEventDestinationResponse')
25
+ DeleteConfigurationSetRequest = Shapes::StructureShape.new(name: 'DeleteConfigurationSetRequest')
26
+ DeleteConfigurationSetResponse = Shapes::StructureShape.new(name: 'DeleteConfigurationSetResponse')
27
+ EventDestination = Shapes::StructureShape.new(name: 'EventDestination')
28
+ EventDestinationDefinition = Shapes::StructureShape.new(name: 'EventDestinationDefinition')
29
+ EventDestinations = Shapes::ListShape.new(name: 'EventDestinations')
30
+ EventType = Shapes::StringShape.new(name: 'EventType')
31
+ EventTypes = Shapes::ListShape.new(name: 'EventTypes')
32
+ GetConfigurationSetEventDestinationsRequest = Shapes::StructureShape.new(name: 'GetConfigurationSetEventDestinationsRequest')
33
+ GetConfigurationSetEventDestinationsResponse = Shapes::StructureShape.new(name: 'GetConfigurationSetEventDestinationsResponse')
34
+ InternalServiceErrorException = Shapes::StructureShape.new(name: 'InternalServiceErrorException')
35
+ KinesisFirehoseDestination = Shapes::StructureShape.new(name: 'KinesisFirehoseDestination')
36
+ LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
37
+ NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
38
+ NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
39
+ PlainTextMessageType = Shapes::StructureShape.new(name: 'PlainTextMessageType')
40
+ SSMLMessageType = Shapes::StructureShape.new(name: 'SSMLMessageType')
41
+ SendVoiceMessageRequest = Shapes::StructureShape.new(name: 'SendVoiceMessageRequest')
42
+ SendVoiceMessageResponse = Shapes::StructureShape.new(name: 'SendVoiceMessageResponse')
43
+ String = Shapes::StringShape.new(name: 'String')
44
+ TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
45
+ UpdateConfigurationSetEventDestinationRequest = Shapes::StructureShape.new(name: 'UpdateConfigurationSetEventDestinationRequest')
46
+ UpdateConfigurationSetEventDestinationResponse = Shapes::StructureShape.new(name: 'UpdateConfigurationSetEventDestinationResponse')
47
+ VoiceMessageContent = Shapes::StructureShape.new(name: 'VoiceMessageContent')
48
+ WordCharactersWithDelimiters = Shapes::StringShape.new(name: 'WordCharactersWithDelimiters')
49
+ __boolean = Shapes::BooleanShape.new(name: '__boolean')
50
+ __double = Shapes::FloatShape.new(name: '__double')
51
+ __integer = Shapes::IntegerShape.new(name: '__integer')
52
+ __long = Shapes::IntegerShape.new(name: '__long')
53
+ __string = Shapes::StringShape.new(name: '__string')
54
+ __timestampIso8601 = Shapes::TimestampShape.new(name: '__timestampIso8601', timestampFormat: "iso8601")
55
+ __timestampUnix = Shapes::TimestampShape.new(name: '__timestampUnix', timestampFormat: "unixTimestamp")
56
+
57
+ CallInstructionsMessageType.add_member(:text, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Text"))
58
+ CallInstructionsMessageType.struct_class = Types::CallInstructionsMessageType
59
+
60
+ CloudWatchLogsDestination.add_member(:iam_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "IamRoleArn"))
61
+ CloudWatchLogsDestination.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: String, location_name: "LogGroupArn"))
62
+ CloudWatchLogsDestination.struct_class = Types::CloudWatchLogsDestination
63
+
64
+ CreateConfigurationSetEventDestinationRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "ConfigurationSetName"))
65
+ CreateConfigurationSetEventDestinationRequest.add_member(:event_destination, Shapes::ShapeRef.new(shape: EventDestinationDefinition, location_name: "EventDestination"))
66
+ CreateConfigurationSetEventDestinationRequest.add_member(:event_destination_name, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "EventDestinationName"))
67
+ CreateConfigurationSetEventDestinationRequest.struct_class = Types::CreateConfigurationSetEventDestinationRequest
68
+
69
+ CreateConfigurationSetEventDestinationResponse.struct_class = Types::CreateConfigurationSetEventDestinationResponse
70
+
71
+ CreateConfigurationSetRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: WordCharactersWithDelimiters, location_name: "ConfigurationSetName"))
72
+ CreateConfigurationSetRequest.struct_class = Types::CreateConfigurationSetRequest
73
+
74
+ CreateConfigurationSetResponse.struct_class = Types::CreateConfigurationSetResponse
75
+
76
+ DeleteConfigurationSetEventDestinationRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "ConfigurationSetName"))
77
+ DeleteConfigurationSetEventDestinationRequest.add_member(:event_destination_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "EventDestinationName"))
78
+ DeleteConfigurationSetEventDestinationRequest.struct_class = Types::DeleteConfigurationSetEventDestinationRequest
79
+
80
+ DeleteConfigurationSetEventDestinationResponse.struct_class = Types::DeleteConfigurationSetEventDestinationResponse
81
+
82
+ DeleteConfigurationSetRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "ConfigurationSetName"))
83
+ DeleteConfigurationSetRequest.struct_class = Types::DeleteConfigurationSetRequest
84
+
85
+ DeleteConfigurationSetResponse.struct_class = Types::DeleteConfigurationSetResponse
86
+
87
+ EventDestination.add_member(:cloud_watch_logs_destination, Shapes::ShapeRef.new(shape: CloudWatchLogsDestination, location_name: "CloudWatchLogsDestination"))
88
+ EventDestination.add_member(:enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "Enabled"))
89
+ EventDestination.add_member(:kinesis_firehose_destination, Shapes::ShapeRef.new(shape: KinesisFirehoseDestination, location_name: "KinesisFirehoseDestination"))
90
+ EventDestination.add_member(:matching_event_types, Shapes::ShapeRef.new(shape: EventTypes, location_name: "MatchingEventTypes"))
91
+ EventDestination.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
92
+ EventDestination.struct_class = Types::EventDestination
93
+
94
+ EventDestinationDefinition.add_member(:cloud_watch_logs_destination, Shapes::ShapeRef.new(shape: CloudWatchLogsDestination, location_name: "CloudWatchLogsDestination"))
95
+ EventDestinationDefinition.add_member(:enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "Enabled"))
96
+ EventDestinationDefinition.add_member(:kinesis_firehose_destination, Shapes::ShapeRef.new(shape: KinesisFirehoseDestination, location_name: "KinesisFirehoseDestination"))
97
+ EventDestinationDefinition.add_member(:matching_event_types, Shapes::ShapeRef.new(shape: EventTypes, location_name: "MatchingEventTypes"))
98
+ EventDestinationDefinition.struct_class = Types::EventDestinationDefinition
99
+
100
+ EventDestinations.member = Shapes::ShapeRef.new(shape: EventDestination)
101
+
102
+ EventTypes.member = Shapes::ShapeRef.new(shape: EventType)
103
+
104
+ GetConfigurationSetEventDestinationsRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "ConfigurationSetName"))
105
+ GetConfigurationSetEventDestinationsRequest.struct_class = Types::GetConfigurationSetEventDestinationsRequest
106
+
107
+ GetConfigurationSetEventDestinationsResponse.add_member(:event_destinations, Shapes::ShapeRef.new(shape: EventDestinations, location_name: "EventDestinations"))
108
+ GetConfigurationSetEventDestinationsResponse.struct_class = Types::GetConfigurationSetEventDestinationsResponse
109
+
110
+ KinesisFirehoseDestination.add_member(:delivery_stream_arn, Shapes::ShapeRef.new(shape: String, location_name: "DeliveryStreamArn"))
111
+ KinesisFirehoseDestination.add_member(:iam_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "IamRoleArn"))
112
+ KinesisFirehoseDestination.struct_class = Types::KinesisFirehoseDestination
113
+
114
+ PlainTextMessageType.add_member(:language_code, Shapes::ShapeRef.new(shape: String, location_name: "LanguageCode"))
115
+ PlainTextMessageType.add_member(:text, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Text"))
116
+ PlainTextMessageType.add_member(:voice_id, Shapes::ShapeRef.new(shape: String, location_name: "VoiceId"))
117
+ PlainTextMessageType.struct_class = Types::PlainTextMessageType
118
+
119
+ SSMLMessageType.add_member(:language_code, Shapes::ShapeRef.new(shape: String, location_name: "LanguageCode"))
120
+ SSMLMessageType.add_member(:text, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Text"))
121
+ SSMLMessageType.add_member(:voice_id, Shapes::ShapeRef.new(shape: String, location_name: "VoiceId"))
122
+ SSMLMessageType.struct_class = Types::SSMLMessageType
123
+
124
+ SendVoiceMessageRequest.add_member(:caller_id, Shapes::ShapeRef.new(shape: String, location_name: "CallerId"))
125
+ SendVoiceMessageRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: WordCharactersWithDelimiters, location_name: "ConfigurationSetName"))
126
+ SendVoiceMessageRequest.add_member(:content, Shapes::ShapeRef.new(shape: VoiceMessageContent, location_name: "Content"))
127
+ SendVoiceMessageRequest.add_member(:destination_phone_number, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "DestinationPhoneNumber"))
128
+ SendVoiceMessageRequest.add_member(:origination_phone_number, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "OriginationPhoneNumber"))
129
+ SendVoiceMessageRequest.struct_class = Types::SendVoiceMessageRequest
130
+
131
+ SendVoiceMessageResponse.add_member(:message_id, Shapes::ShapeRef.new(shape: String, location_name: "MessageId"))
132
+ SendVoiceMessageResponse.struct_class = Types::SendVoiceMessageResponse
133
+
134
+ UpdateConfigurationSetEventDestinationRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "ConfigurationSetName"))
135
+ UpdateConfigurationSetEventDestinationRequest.add_member(:event_destination, Shapes::ShapeRef.new(shape: EventDestinationDefinition, location_name: "EventDestination"))
136
+ UpdateConfigurationSetEventDestinationRequest.add_member(:event_destination_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "EventDestinationName"))
137
+ UpdateConfigurationSetEventDestinationRequest.struct_class = Types::UpdateConfigurationSetEventDestinationRequest
138
+
139
+ UpdateConfigurationSetEventDestinationResponse.struct_class = Types::UpdateConfigurationSetEventDestinationResponse
140
+
141
+ VoiceMessageContent.add_member(:call_instructions_message, Shapes::ShapeRef.new(shape: CallInstructionsMessageType, location_name: "CallInstructionsMessage"))
142
+ VoiceMessageContent.add_member(:plain_text_message, Shapes::ShapeRef.new(shape: PlainTextMessageType, location_name: "PlainTextMessage"))
143
+ VoiceMessageContent.add_member(:ssml_message, Shapes::ShapeRef.new(shape: SSMLMessageType, location_name: "SSMLMessage"))
144
+ VoiceMessageContent.struct_class = Types::VoiceMessageContent
145
+
146
+
147
+ # @api private
148
+ API = Seahorse::Model::Api.new.tap do |api|
149
+
150
+ api.version = "2018-09-05"
151
+
152
+ api.metadata = {
153
+ "apiVersion" => "2018-09-05",
154
+ "endpointPrefix" => "sms-voice.pinpoint",
155
+ "jsonVersion" => "1.1",
156
+ "protocol" => "rest-json",
157
+ "serviceAbbreviation" => "Pinpoint SMS Voice",
158
+ "serviceFullName" => "Amazon Pinpoint SMS and Voice Service",
159
+ "serviceId" => "Pinpoint SMS Voice",
160
+ "signatureVersion" => "v4",
161
+ "signingName" => "sms-voice",
162
+ "uid" => "pinpoint-sms-voice-2018-09-05",
163
+ }
164
+
165
+ api.add_operation(:create_configuration_set, Seahorse::Model::Operation.new.tap do |o|
166
+ o.name = "CreateConfigurationSet"
167
+ o.http_method = "POST"
168
+ o.http_request_uri = "/v1/sms-voice/configuration-sets"
169
+ o.input = Shapes::ShapeRef.new(shape: CreateConfigurationSetRequest)
170
+ o.output = Shapes::ShapeRef.new(shape: CreateConfigurationSetResponse)
171
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
172
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
173
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
174
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
175
+ o.errors << Shapes::ShapeRef.new(shape: AlreadyExistsException)
176
+ end)
177
+
178
+ api.add_operation(:create_configuration_set_event_destination, Seahorse::Model::Operation.new.tap do |o|
179
+ o.name = "CreateConfigurationSetEventDestination"
180
+ o.http_method = "POST"
181
+ o.http_request_uri = "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations"
182
+ o.input = Shapes::ShapeRef.new(shape: CreateConfigurationSetEventDestinationRequest)
183
+ o.output = Shapes::ShapeRef.new(shape: CreateConfigurationSetEventDestinationResponse)
184
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
185
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
186
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
187
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
188
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
189
+ o.errors << Shapes::ShapeRef.new(shape: AlreadyExistsException)
190
+ end)
191
+
192
+ api.add_operation(:delete_configuration_set, Seahorse::Model::Operation.new.tap do |o|
193
+ o.name = "DeleteConfigurationSet"
194
+ o.http_method = "DELETE"
195
+ o.http_request_uri = "/v1/sms-voice/configuration-sets/{ConfigurationSetName}"
196
+ o.input = Shapes::ShapeRef.new(shape: DeleteConfigurationSetRequest)
197
+ o.output = Shapes::ShapeRef.new(shape: DeleteConfigurationSetResponse)
198
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
199
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
200
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
201
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
202
+ end)
203
+
204
+ api.add_operation(:delete_configuration_set_event_destination, Seahorse::Model::Operation.new.tap do |o|
205
+ o.name = "DeleteConfigurationSetEventDestination"
206
+ o.http_method = "DELETE"
207
+ o.http_request_uri = "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}"
208
+ o.input = Shapes::ShapeRef.new(shape: DeleteConfigurationSetEventDestinationRequest)
209
+ o.output = Shapes::ShapeRef.new(shape: DeleteConfigurationSetEventDestinationResponse)
210
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
211
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
212
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
213
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
214
+ end)
215
+
216
+ api.add_operation(:get_configuration_set_event_destinations, Seahorse::Model::Operation.new.tap do |o|
217
+ o.name = "GetConfigurationSetEventDestinations"
218
+ o.http_method = "GET"
219
+ o.http_request_uri = "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations"
220
+ o.input = Shapes::ShapeRef.new(shape: GetConfigurationSetEventDestinationsRequest)
221
+ o.output = Shapes::ShapeRef.new(shape: GetConfigurationSetEventDestinationsResponse)
222
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
223
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
224
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
225
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
226
+ end)
227
+
228
+ api.add_operation(:send_voice_message, Seahorse::Model::Operation.new.tap do |o|
229
+ o.name = "SendVoiceMessage"
230
+ o.http_method = "POST"
231
+ o.http_request_uri = "/v1/sms-voice/voice/message"
232
+ o.input = Shapes::ShapeRef.new(shape: SendVoiceMessageRequest)
233
+ o.output = Shapes::ShapeRef.new(shape: SendVoiceMessageResponse)
234
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
235
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
236
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
237
+ end)
238
+
239
+ api.add_operation(:update_configuration_set_event_destination, Seahorse::Model::Operation.new.tap do |o|
240
+ o.name = "UpdateConfigurationSetEventDestination"
241
+ o.http_method = "PUT"
242
+ o.http_request_uri = "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}"
243
+ o.input = Shapes::ShapeRef.new(shape: UpdateConfigurationSetEventDestinationRequest)
244
+ o.output = Shapes::ShapeRef.new(shape: UpdateConfigurationSetEventDestinationResponse)
245
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
246
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
247
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
248
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
249
+ end)
250
+ end
251
+
252
+ end
253
+ end
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::PinpointSMSVoice
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::PinpointSMSVoice
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,581 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::PinpointSMSVoice
9
+ module Types
10
+
11
+ # An object that defines a message that contains text formatted using
12
+ # Amazon Pinpoint Voice Instructions markup.
13
+ #
14
+ # @note When making an API call, you may pass CallInstructionsMessageType
15
+ # data as a hash:
16
+ #
17
+ # {
18
+ # text: "NonEmptyString",
19
+ # }
20
+ #
21
+ # @!attribute [rw] text
22
+ # The language to use when delivering the message. For a complete list
23
+ # of supported languages, see the Amazon Polly Developer Guide.
24
+ # @return [String]
25
+ #
26
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CallInstructionsMessageType AWS API Documentation
27
+ #
28
+ class CallInstructionsMessageType < Struct.new(
29
+ :text)
30
+ include Aws::Structure
31
+ end
32
+
33
+ # An object that contains information about a event destination that
34
+ # sends data to Amazon CloudWatch Logs.
35
+ #
36
+ # @note When making an API call, you may pass CloudWatchLogsDestination
37
+ # data as a hash:
38
+ #
39
+ # {
40
+ # iam_role_arn: "String",
41
+ # log_group_arn: "String",
42
+ # }
43
+ #
44
+ # @!attribute [rw] iam_role_arn
45
+ # The Amazon Resource Name (ARN) of an Amazon Identity and Access
46
+ # Management (IAM) role that is able to write event data to an Amazon
47
+ # CloudWatch destination.
48
+ # @return [String]
49
+ #
50
+ # @!attribute [rw] log_group_arn
51
+ # The name of the Amazon CloudWatch Log Group that you want to record
52
+ # events in.
53
+ # @return [String]
54
+ #
55
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CloudWatchLogsDestination AWS API Documentation
56
+ #
57
+ class CloudWatchLogsDestination < Struct.new(
58
+ :iam_role_arn,
59
+ :log_group_arn)
60
+ include Aws::Structure
61
+ end
62
+
63
+ # Create a new event destination in a configuration set.
64
+ #
65
+ # @note When making an API call, you may pass CreateConfigurationSetEventDestinationRequest
66
+ # data as a hash:
67
+ #
68
+ # {
69
+ # configuration_set_name: "__string", # required
70
+ # event_destination: {
71
+ # cloud_watch_logs_destination: {
72
+ # iam_role_arn: "String",
73
+ # log_group_arn: "String",
74
+ # },
75
+ # enabled: false,
76
+ # kinesis_firehose_destination: {
77
+ # delivery_stream_arn: "String",
78
+ # iam_role_arn: "String",
79
+ # },
80
+ # matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
81
+ # },
82
+ # event_destination_name: "NonEmptyString",
83
+ # }
84
+ #
85
+ # @!attribute [rw] configuration_set_name
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] event_destination
89
+ # An object that defines a single event destination.
90
+ # @return [Types::EventDestinationDefinition]
91
+ #
92
+ # @!attribute [rw] event_destination_name
93
+ # A name that identifies the event destination.
94
+ # @return [String]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestinationRequest AWS API Documentation
97
+ #
98
+ class CreateConfigurationSetEventDestinationRequest < Struct.new(
99
+ :configuration_set_name,
100
+ :event_destination,
101
+ :event_destination_name)
102
+ include Aws::Structure
103
+ end
104
+
105
+ # An empty object that indicates that the event destination was created
106
+ # successfully.
107
+ #
108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestinationResponse AWS API Documentation
109
+ #
110
+ class CreateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
111
+
112
+ # A request to create a new configuration set.
113
+ #
114
+ # @note When making an API call, you may pass CreateConfigurationSetRequest
115
+ # data as a hash:
116
+ #
117
+ # {
118
+ # configuration_set_name: "WordCharactersWithDelimiters",
119
+ # }
120
+ #
121
+ # @!attribute [rw] configuration_set_name
122
+ # The name that you want to give the configuration set.
123
+ # @return [String]
124
+ #
125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetRequest AWS API Documentation
126
+ #
127
+ class CreateConfigurationSetRequest < Struct.new(
128
+ :configuration_set_name)
129
+ include Aws::Structure
130
+ end
131
+
132
+ # An empty object that indicates that the configuration set was
133
+ # successfully created.
134
+ #
135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetResponse AWS API Documentation
136
+ #
137
+ class CreateConfigurationSetResponse < Aws::EmptyStructure; end
138
+
139
+ # @note When making an API call, you may pass DeleteConfigurationSetEventDestinationRequest
140
+ # data as a hash:
141
+ #
142
+ # {
143
+ # configuration_set_name: "__string", # required
144
+ # event_destination_name: "__string", # required
145
+ # }
146
+ #
147
+ # @!attribute [rw] configuration_set_name
148
+ # @return [String]
149
+ #
150
+ # @!attribute [rw] event_destination_name
151
+ # @return [String]
152
+ #
153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestinationRequest AWS API Documentation
154
+ #
155
+ class DeleteConfigurationSetEventDestinationRequest < Struct.new(
156
+ :configuration_set_name,
157
+ :event_destination_name)
158
+ include Aws::Structure
159
+ end
160
+
161
+ # An empty object that indicates that the event destination was deleted
162
+ # successfully.
163
+ #
164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestinationResponse AWS API Documentation
165
+ #
166
+ class DeleteConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
167
+
168
+ # @note When making an API call, you may pass DeleteConfigurationSetRequest
169
+ # data as a hash:
170
+ #
171
+ # {
172
+ # configuration_set_name: "__string", # required
173
+ # }
174
+ #
175
+ # @!attribute [rw] configuration_set_name
176
+ # @return [String]
177
+ #
178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetRequest AWS API Documentation
179
+ #
180
+ class DeleteConfigurationSetRequest < Struct.new(
181
+ :configuration_set_name)
182
+ include Aws::Structure
183
+ end
184
+
185
+ # An empty object that indicates that the configuration set was deleted
186
+ # successfully.
187
+ #
188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetResponse AWS API Documentation
189
+ #
190
+ class DeleteConfigurationSetResponse < Aws::EmptyStructure; end
191
+
192
+ # An object that defines an event destination.
193
+ #
194
+ # @!attribute [rw] cloud_watch_logs_destination
195
+ # An object that contains information about a event destination that
196
+ # sends data to Amazon CloudWatch Logs.
197
+ # @return [Types::CloudWatchLogsDestination]
198
+ #
199
+ # @!attribute [rw] enabled
200
+ # Indicates whether or not the event destination is enabled. If the
201
+ # event destination is enabled, then Amazon Pinpoint sends response
202
+ # data to the specified event destination.
203
+ # @return [Boolean]
204
+ #
205
+ # @!attribute [rw] kinesis_firehose_destination
206
+ # An object that contains information about a event destination that
207
+ # sends data to Amazon Kinesis Data Firehose.
208
+ # @return [Types::KinesisFirehoseDestination]
209
+ #
210
+ # @!attribute [rw] matching_event_types
211
+ # An array of EventDestination objects. Each EventDestination object
212
+ # includes ARNs and other information that define an event
213
+ # destination.
214
+ # @return [Array<String>]
215
+ #
216
+ # @!attribute [rw] name
217
+ # A name that identifies the event destination configuration.
218
+ # @return [String]
219
+ #
220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/EventDestination AWS API Documentation
221
+ #
222
+ class EventDestination < Struct.new(
223
+ :cloud_watch_logs_destination,
224
+ :enabled,
225
+ :kinesis_firehose_destination,
226
+ :matching_event_types,
227
+ :name)
228
+ include Aws::Structure
229
+ end
230
+
231
+ # An object that defines a single event destination.
232
+ #
233
+ # @note When making an API call, you may pass EventDestinationDefinition
234
+ # data as a hash:
235
+ #
236
+ # {
237
+ # cloud_watch_logs_destination: {
238
+ # iam_role_arn: "String",
239
+ # log_group_arn: "String",
240
+ # },
241
+ # enabled: false,
242
+ # kinesis_firehose_destination: {
243
+ # delivery_stream_arn: "String",
244
+ # iam_role_arn: "String",
245
+ # },
246
+ # matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
247
+ # }
248
+ #
249
+ # @!attribute [rw] cloud_watch_logs_destination
250
+ # An object that contains information about a event destination that
251
+ # sends data to Amazon CloudWatch Logs.
252
+ # @return [Types::CloudWatchLogsDestination]
253
+ #
254
+ # @!attribute [rw] enabled
255
+ # Indicates whether or not the event destination is enabled. If the
256
+ # event destination is enabled, then Amazon Pinpoint sends response
257
+ # data to the specified event destination.
258
+ # @return [Boolean]
259
+ #
260
+ # @!attribute [rw] kinesis_firehose_destination
261
+ # An object that contains information about a event destination that
262
+ # sends data to Amazon Kinesis Data Firehose.
263
+ # @return [Types::KinesisFirehoseDestination]
264
+ #
265
+ # @!attribute [rw] matching_event_types
266
+ # An array of EventDestination objects. Each EventDestination object
267
+ # includes ARNs and other information that define an event
268
+ # destination.
269
+ # @return [Array<String>]
270
+ #
271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/EventDestinationDefinition AWS API Documentation
272
+ #
273
+ class EventDestinationDefinition < Struct.new(
274
+ :cloud_watch_logs_destination,
275
+ :enabled,
276
+ :kinesis_firehose_destination,
277
+ :matching_event_types)
278
+ include Aws::Structure
279
+ end
280
+
281
+ # @note When making an API call, you may pass GetConfigurationSetEventDestinationsRequest
282
+ # data as a hash:
283
+ #
284
+ # {
285
+ # configuration_set_name: "__string", # required
286
+ # }
287
+ #
288
+ # @!attribute [rw] configuration_set_name
289
+ # @return [String]
290
+ #
291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinationsRequest AWS API Documentation
292
+ #
293
+ class GetConfigurationSetEventDestinationsRequest < Struct.new(
294
+ :configuration_set_name)
295
+ include Aws::Structure
296
+ end
297
+
298
+ # An object that contains information about an event destination.
299
+ #
300
+ # @!attribute [rw] event_destinations
301
+ # An array of EventDestination objects. Each EventDestination object
302
+ # includes ARNs and other information that define an event
303
+ # destination.
304
+ # @return [Array<Types::EventDestination>]
305
+ #
306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinationsResponse AWS API Documentation
307
+ #
308
+ class GetConfigurationSetEventDestinationsResponse < Struct.new(
309
+ :event_destinations)
310
+ include Aws::Structure
311
+ end
312
+
313
+ # An object that contains information about a event destination that
314
+ # sends data to Amazon Kinesis Data Firehose.
315
+ #
316
+ # @note When making an API call, you may pass KinesisFirehoseDestination
317
+ # data as a hash:
318
+ #
319
+ # {
320
+ # delivery_stream_arn: "String",
321
+ # iam_role_arn: "String",
322
+ # }
323
+ #
324
+ # @!attribute [rw] delivery_stream_arn
325
+ # The Amazon Resource Name (ARN) of an IAM role that can write data to
326
+ # an Amazon Kinesis Data Firehose stream.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] iam_role_arn
330
+ # The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose
331
+ # destination that you want to use in the event destination.
332
+ # @return [String]
333
+ #
334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/KinesisFirehoseDestination AWS API Documentation
335
+ #
336
+ class KinesisFirehoseDestination < Struct.new(
337
+ :delivery_stream_arn,
338
+ :iam_role_arn)
339
+ include Aws::Structure
340
+ end
341
+
342
+ # An object that defines a message that contains unformatted text.
343
+ #
344
+ # @note When making an API call, you may pass PlainTextMessageType
345
+ # data as a hash:
346
+ #
347
+ # {
348
+ # language_code: "String",
349
+ # text: "NonEmptyString",
350
+ # voice_id: "String",
351
+ # }
352
+ #
353
+ # @!attribute [rw] language_code
354
+ # The language to use when delivering the message. For a complete list
355
+ # of supported languages, see the Amazon Polly Developer Guide.
356
+ # @return [String]
357
+ #
358
+ # @!attribute [rw] text
359
+ # The plain (not SSML-formatted) text to deliver to the recipient.
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] voice_id
363
+ # @return [String]
364
+ #
365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/PlainTextMessageType AWS API Documentation
366
+ #
367
+ class PlainTextMessageType < Struct.new(
368
+ :language_code,
369
+ :text,
370
+ :voice_id)
371
+ include Aws::Structure
372
+ end
373
+
374
+ # An object that defines a message that contains SSML-formatted text.
375
+ #
376
+ # @note When making an API call, you may pass SSMLMessageType
377
+ # data as a hash:
378
+ #
379
+ # {
380
+ # language_code: "String",
381
+ # text: "NonEmptyString",
382
+ # voice_id: "String",
383
+ # }
384
+ #
385
+ # @!attribute [rw] language_code
386
+ # The language to use when delivering the message. For a complete list
387
+ # of supported languages, see the Amazon Polly Developer Guide.
388
+ # @return [String]
389
+ #
390
+ # @!attribute [rw] text
391
+ # The SSML-formatted text to deliver to the recipient.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] voice_id
395
+ # The name of the voice that you want to use to deliver the message.
396
+ # For a complete list of supported voices, see the Amazon Polly
397
+ # Developer Guide.
398
+ # @return [String]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SSMLMessageType AWS API Documentation
401
+ #
402
+ class SSMLMessageType < Struct.new(
403
+ :language_code,
404
+ :text,
405
+ :voice_id)
406
+ include Aws::Structure
407
+ end
408
+
409
+ # A request to create and send a new voice message.
410
+ #
411
+ # @note When making an API call, you may pass SendVoiceMessageRequest
412
+ # data as a hash:
413
+ #
414
+ # {
415
+ # caller_id: "String",
416
+ # configuration_set_name: "WordCharactersWithDelimiters",
417
+ # content: {
418
+ # call_instructions_message: {
419
+ # text: "NonEmptyString",
420
+ # },
421
+ # plain_text_message: {
422
+ # language_code: "String",
423
+ # text: "NonEmptyString",
424
+ # voice_id: "String",
425
+ # },
426
+ # ssml_message: {
427
+ # language_code: "String",
428
+ # text: "NonEmptyString",
429
+ # voice_id: "String",
430
+ # },
431
+ # },
432
+ # destination_phone_number: "NonEmptyString",
433
+ # origination_phone_number: "NonEmptyString",
434
+ # }
435
+ #
436
+ # @!attribute [rw] caller_id
437
+ # The phone number that appears on recipients' devices when they
438
+ # receive the message.
439
+ # @return [String]
440
+ #
441
+ # @!attribute [rw] configuration_set_name
442
+ # The name of the configuration set that you want to use to send the
443
+ # message.
444
+ # @return [String]
445
+ #
446
+ # @!attribute [rw] content
447
+ # An object that contains a voice message and information about the
448
+ # recipient that you want to send it to.
449
+ # @return [Types::VoiceMessageContent]
450
+ #
451
+ # @!attribute [rw] destination_phone_number
452
+ # The phone number that you want to send the voice message to.
453
+ # @return [String]
454
+ #
455
+ # @!attribute [rw] origination_phone_number
456
+ # The phone number that Amazon Pinpoint should use to send the voice
457
+ # message. This isn't necessarily the phone number that appears on
458
+ # recipients' devices when they receive the message, because you can
459
+ # specify a CallerId parameter in the request.
460
+ # @return [String]
461
+ #
462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessageRequest AWS API Documentation
463
+ #
464
+ class SendVoiceMessageRequest < Struct.new(
465
+ :caller_id,
466
+ :configuration_set_name,
467
+ :content,
468
+ :destination_phone_number,
469
+ :origination_phone_number)
470
+ include Aws::Structure
471
+ end
472
+
473
+ # An object that that contains the Message ID of a Voice message that
474
+ # was sent successfully.
475
+ #
476
+ # @!attribute [rw] message_id
477
+ # A unique identifier for the voice message.
478
+ # @return [String]
479
+ #
480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessageResponse AWS API Documentation
481
+ #
482
+ class SendVoiceMessageResponse < Struct.new(
483
+ :message_id)
484
+ include Aws::Structure
485
+ end
486
+
487
+ # An object that defines a request to update an existing event
488
+ # destination.
489
+ #
490
+ # @note When making an API call, you may pass UpdateConfigurationSetEventDestinationRequest
491
+ # data as a hash:
492
+ #
493
+ # {
494
+ # configuration_set_name: "__string", # required
495
+ # event_destination: {
496
+ # cloud_watch_logs_destination: {
497
+ # iam_role_arn: "String",
498
+ # log_group_arn: "String",
499
+ # },
500
+ # enabled: false,
501
+ # kinesis_firehose_destination: {
502
+ # delivery_stream_arn: "String",
503
+ # iam_role_arn: "String",
504
+ # },
505
+ # matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
506
+ # },
507
+ # event_destination_name: "__string", # required
508
+ # }
509
+ #
510
+ # @!attribute [rw] configuration_set_name
511
+ # @return [String]
512
+ #
513
+ # @!attribute [rw] event_destination
514
+ # An object that defines a single event destination.
515
+ # @return [Types::EventDestinationDefinition]
516
+ #
517
+ # @!attribute [rw] event_destination_name
518
+ # @return [String]
519
+ #
520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestinationRequest AWS API Documentation
521
+ #
522
+ class UpdateConfigurationSetEventDestinationRequest < Struct.new(
523
+ :configuration_set_name,
524
+ :event_destination,
525
+ :event_destination_name)
526
+ include Aws::Structure
527
+ end
528
+
529
+ # An empty object that indicates that the event destination was updated
530
+ # successfully.
531
+ #
532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestinationResponse AWS API Documentation
533
+ #
534
+ class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
535
+
536
+ # An object that contains a voice message and information about the
537
+ # recipient that you want to send it to.
538
+ #
539
+ # @note When making an API call, you may pass VoiceMessageContent
540
+ # data as a hash:
541
+ #
542
+ # {
543
+ # call_instructions_message: {
544
+ # text: "NonEmptyString",
545
+ # },
546
+ # plain_text_message: {
547
+ # language_code: "String",
548
+ # text: "NonEmptyString",
549
+ # voice_id: "String",
550
+ # },
551
+ # ssml_message: {
552
+ # language_code: "String",
553
+ # text: "NonEmptyString",
554
+ # voice_id: "String",
555
+ # },
556
+ # }
557
+ #
558
+ # @!attribute [rw] call_instructions_message
559
+ # An object that defines a message that contains text formatted using
560
+ # Amazon Pinpoint Voice Instructions markup.
561
+ # @return [Types::CallInstructionsMessageType]
562
+ #
563
+ # @!attribute [rw] plain_text_message
564
+ # An object that defines a message that contains unformatted text.
565
+ # @return [Types::PlainTextMessageType]
566
+ #
567
+ # @!attribute [rw] ssml_message
568
+ # An object that defines a message that contains SSML-formatted text.
569
+ # @return [Types::SSMLMessageType]
570
+ #
571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/VoiceMessageContent AWS API Documentation
572
+ #
573
+ class VoiceMessageContent < Struct.new(
574
+ :call_instructions_message,
575
+ :plain_text_message,
576
+ :ssml_message)
577
+ include Aws::Structure
578
+ end
579
+
580
+ end
581
+ end