aws-sdk-connect 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: '09ccde84ae14f0adbfc8cab292c229c79324061f'
4
+ data.tar.gz: 0da75fb1b977f5c72794d0f4c42e8edc638bf149
5
+ SHA512:
6
+ metadata.gz: 91af84f8186f713cc1a10e87b5fa745c24982712f4c352f49e37c4fd49674d077a009cebac725fd966e800e27a85ced9800a3ef7b604a29ca1edea02b07a7eb6
7
+ data.tar.gz: 55620a8051b2075289e75804393d32c2032252f0b1bbc82b2d107f8a075b6622774c6adf883545182e4d8f3548a69f0ad0bb4bbf0162e55625342f4b6f49e50e
@@ -0,0 +1,47 @@
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
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-connect/types'
12
+ require_relative 'aws-sdk-connect/client_api'
13
+ require_relative 'aws-sdk-connect/client'
14
+ require_relative 'aws-sdk-connect/errors'
15
+ require_relative 'aws-sdk-connect/resource'
16
+ require_relative 'aws-sdk-connect/customizations'
17
+
18
+ # This module provides support for Amazon Connect Service. This module is available in the
19
+ # `aws-sdk-connect` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon Connect Service all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::Connect::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::Connect
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,325 @@
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
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
22
+ require 'aws-sdk-core/plugins/signature_v4.rb'
23
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
24
+
25
+ Aws::Plugins::GlobalConfiguration.add_identifier(:connect)
26
+
27
+ module Aws::Connect
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :connect
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::RestJson)
52
+
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :stub_responses (false)
130
+ # Causes the client to return stubbed responses. By default
131
+ # fake responses are generated and returned. You can specify
132
+ # the response data to return or errors to raise by calling
133
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
134
+ #
135
+ # ** Please note ** When response stubbing is enabled, no HTTP
136
+ # requests are made, and retries are disabled.
137
+ #
138
+ # @option options [Boolean] :validate_params (true)
139
+ # When `true`, request parameters are validated before
140
+ # sending the request.
141
+ #
142
+ def initialize(*args)
143
+ super
144
+ end
145
+
146
+ # @!group API Operations
147
+
148
+ # The `StartOutboundVoiceContact` operation initiates a contact flow to
149
+ # place an outbound call to a customer.
150
+ #
151
+ # There is a throttling limit placed on usage of the API that includes a
152
+ # `RateLimit` of 2 per second, and a `BurstLimit` of 5 per second.
153
+ #
154
+ # If you are using an IAM account, it must have permissions to the
155
+ # `connect:StartOutboundVoiceContact` action.
156
+ #
157
+ # @option params [required, String] :destination_phone_number
158
+ # The phone number, in E.164 format, of the customer to call with the
159
+ # outbound contact.
160
+ #
161
+ # @option params [required, String] :contact_flow_id
162
+ # The identifier for the contact flow to execute for the outbound call.
163
+ # This is a GUID value only. Amazon Resource Name (ARN) values are not
164
+ # supported.
165
+ #
166
+ # To find the `ContactFlowId`, open the contact flow to use in the
167
+ # Amazon Connect contact flow designer. The ID for the contact flow is
168
+ # displayed in the address bar as part of the URL. For example, an
169
+ # address displayed when you open a contact flow is similar to the
170
+ # following:
171
+ # `https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181
172
+ # `. At the end of the URL, you see
173
+ # `contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181`. The
174
+ # `ContactFlowID` for this contact flow is `
175
+ # b0b8f2dd-ed1b-4c44-af36-ce189a178181 `. Make sure to include only the
176
+ # GUID after the "contact-flow/" in your requests.
177
+ #
178
+ # @option params [required, String] :instance_id
179
+ # The identifier for your Amazon Connect instance. To find the
180
+ # `InstanceId` value for your Amazon Connect instance, open the [Amazon
181
+ # Connect console][1]. Select the instance alias of the instance and
182
+ # view the instance ID in the **Overview** section. For example, the
183
+ # instance ID is the set of characters at the end of the instance ARN,
184
+ # after "instance/", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
185
+ #
186
+ #
187
+ #
188
+ # [1]: https://console.aws.amazon.com/connect/
189
+ #
190
+ # @option params [String] :client_token
191
+ # A unique, case-sensitive identifier that you provide to ensure the
192
+ # idempotency of the request. The token is valid for 7 days after
193
+ # creation. If a contact is already started, the contact ID is returned.
194
+ # If the contact is disconnected, a new contact is started.
195
+ #
196
+ # **A suitable default value is auto-generated.** You should normally
197
+ # not need to pass this option.**
198
+ #
199
+ # @option params [String] :source_phone_number
200
+ # The phone number, in E.164 format, associated with your Amazon Connect
201
+ # instance to use to place the outbound call.
202
+ #
203
+ # @option params [String] :queue_id
204
+ # The queue to which to add the call. If you specify a queue, the phone
205
+ # displayed for caller ID is the phone number defined for the queue. If
206
+ # you do not specify a queue, the queue used is the queue defined in the
207
+ # contact flow specified by `ContactFlowId`.
208
+ #
209
+ # To find the `QueueId`, open the queue to use in the Amazon Connect
210
+ # queue editor. The ID for the queue is displayed in the address bar as
211
+ # part of the URL. For example, the `QueueId` value is the set of
212
+ # characters at the end of the URL, after "queue/", such as
213
+ # `aeg40574-2d01-51c3-73d6-bf8624d2168c`.
214
+ #
215
+ # @option params [Hash<String,String>] :attributes
216
+ # Specify a custom key-value pair using an attribute map. The attributes
217
+ # are standard Amazon Connect attributes, and can be accessed in contact
218
+ # flows just like any other contact attributes.
219
+ #
220
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs.
221
+ # Attribute keys can include only alphanumeric, dash, and underscore
222
+ # characters.
223
+ #
224
+ # For example, to play a greeting when the customer answers the call,
225
+ # you can pass the customer name in attributes similar to the following:
226
+ #
227
+ # @return [Types::StartOutboundVoiceContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
228
+ #
229
+ # * {Types::StartOutboundVoiceContactResponse#contact_id #contact_id} => String
230
+ #
231
+ # @example Request syntax with placeholder values
232
+ #
233
+ # resp = client.start_outbound_voice_contact({
234
+ # destination_phone_number: "PhoneNumber", # required
235
+ # contact_flow_id: "ContactFlowId", # required
236
+ # instance_id: "InstanceId", # required
237
+ # client_token: "ClientToken",
238
+ # source_phone_number: "PhoneNumber",
239
+ # queue_id: "QueueId",
240
+ # attributes: {
241
+ # "AttributeName" => "AttributeValue",
242
+ # },
243
+ # })
244
+ #
245
+ # @example Response structure
246
+ #
247
+ # resp.contact_id #=> String
248
+ #
249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact AWS API Documentation
250
+ #
251
+ # @overload start_outbound_voice_contact(params = {})
252
+ # @param [Hash] params ({})
253
+ def start_outbound_voice_contact(params = {}, options = {})
254
+ req = build_request(:start_outbound_voice_contact, params)
255
+ req.send_request(options)
256
+ end
257
+
258
+ # Ends the contact initiated by the `StartOutboundVoiceContact`
259
+ # operation.
260
+ #
261
+ # If you are using an IAM account, it must have permissions to the
262
+ # `connect:StopContact` operation.
263
+ #
264
+ # @option params [required, String] :contact_id
265
+ # The unique identifier of the contact to end. This is the `ContactId`
266
+ # value returned from the `StartOutboundVoiceContact` operation.
267
+ #
268
+ # @option params [required, String] :instance_id
269
+ # The identifier of the Amazon Connect instance in which the contact is
270
+ # active.
271
+ #
272
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
273
+ #
274
+ # @example Request syntax with placeholder values
275
+ #
276
+ # resp = client.stop_contact({
277
+ # contact_id: "ContactId", # required
278
+ # instance_id: "InstanceId", # required
279
+ # })
280
+ #
281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact AWS API Documentation
282
+ #
283
+ # @overload stop_contact(params = {})
284
+ # @param [Hash] params ({})
285
+ def stop_contact(params = {}, options = {})
286
+ req = build_request(:stop_contact, params)
287
+ req.send_request(options)
288
+ end
289
+
290
+ # @!endgroup
291
+
292
+ # @param params ({})
293
+ # @api private
294
+ def build_request(operation_name, params = {})
295
+ handlers = @handlers.for(operation_name)
296
+ context = Seahorse::Client::RequestContext.new(
297
+ operation_name: operation_name,
298
+ operation: config.api.operation(operation_name),
299
+ client: self,
300
+ params: params,
301
+ config: config)
302
+ context[:gem_name] = 'aws-sdk-connect'
303
+ context[:gem_version] = '1.0.0'
304
+ Seahorse::Client::Request.new(handlers, context)
305
+ end
306
+
307
+ # @api private
308
+ # @deprecated
309
+ def waiter_names
310
+ []
311
+ end
312
+
313
+ class << self
314
+
315
+ # @api private
316
+ attr_reader :identifier
317
+
318
+ # @api private
319
+ def errors_module
320
+ Errors
321
+ end
322
+
323
+ end
324
+ end
325
+ end
@@ -0,0 +1,103 @@
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::Connect
9
+ # @api private
10
+ module ClientApi
11
+
12
+ include Seahorse::Model
13
+
14
+ AttributeName = Shapes::StringShape.new(name: 'AttributeName')
15
+ AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
16
+ Attributes = Shapes::MapShape.new(name: 'Attributes')
17
+ ClientToken = Shapes::StringShape.new(name: 'ClientToken')
18
+ ContactFlowId = Shapes::StringShape.new(name: 'ContactFlowId')
19
+ ContactId = Shapes::StringShape.new(name: 'ContactId')
20
+ ContactNotFoundException = Shapes::StructureShape.new(name: 'ContactNotFoundException')
21
+ DestinationNotAllowedException = Shapes::StructureShape.new(name: 'DestinationNotAllowedException')
22
+ InstanceId = Shapes::StringShape.new(name: 'InstanceId')
23
+ InternalServiceException = Shapes::StructureShape.new(name: 'InternalServiceException')
24
+ InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
25
+ InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
26
+ LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
27
+ Message = Shapes::StringShape.new(name: 'Message')
28
+ OutboundContactNotPermittedException = Shapes::StructureShape.new(name: 'OutboundContactNotPermittedException')
29
+ PhoneNumber = Shapes::StringShape.new(name: 'PhoneNumber')
30
+ QueueId = Shapes::StringShape.new(name: 'QueueId')
31
+ ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
32
+ StartOutboundVoiceContactRequest = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactRequest')
33
+ StartOutboundVoiceContactResponse = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactResponse')
34
+ StopContactRequest = Shapes::StructureShape.new(name: 'StopContactRequest')
35
+ StopContactResponse = Shapes::StructureShape.new(name: 'StopContactResponse')
36
+
37
+ Attributes.key = Shapes::ShapeRef.new(shape: AttributeName)
38
+ Attributes.value = Shapes::ShapeRef.new(shape: AttributeValue)
39
+
40
+ StartOutboundVoiceContactRequest.add_member(:destination_phone_number, Shapes::ShapeRef.new(shape: PhoneNumber, required: true, location_name: "DestinationPhoneNumber"))
41
+ StartOutboundVoiceContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId"))
42
+ StartOutboundVoiceContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
43
+ StartOutboundVoiceContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
44
+ StartOutboundVoiceContactRequest.add_member(:source_phone_number, Shapes::ShapeRef.new(shape: PhoneNumber, location_name: "SourcePhoneNumber"))
45
+ StartOutboundVoiceContactRequest.add_member(:queue_id, Shapes::ShapeRef.new(shape: QueueId, location_name: "QueueId"))
46
+ StartOutboundVoiceContactRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
47
+ StartOutboundVoiceContactRequest.struct_class = Types::StartOutboundVoiceContactRequest
48
+
49
+ StartOutboundVoiceContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
50
+ StartOutboundVoiceContactResponse.struct_class = Types::StartOutboundVoiceContactResponse
51
+
52
+ StopContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
53
+ StopContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
54
+ StopContactRequest.struct_class = Types::StopContactRequest
55
+
56
+ StopContactResponse.struct_class = Types::StopContactResponse
57
+
58
+
59
+ # @api private
60
+ API = Seahorse::Model::Api.new.tap do |api|
61
+
62
+ api.version = "2017-08-08"
63
+
64
+ api.metadata = {
65
+ "endpointPrefix" => "connect",
66
+ "jsonVersion" => "1.1",
67
+ "protocol" => "rest-json",
68
+ "serviceFullName" => "Amazon Connect Service",
69
+ "signatureVersion" => "v4",
70
+ "signingName" => "connect",
71
+ }
72
+
73
+ api.add_operation(:start_outbound_voice_contact, Seahorse::Model::Operation.new.tap do |o|
74
+ o.name = "StartOutboundVoiceContact"
75
+ o.http_method = "PUT"
76
+ o.http_request_uri = "/contact/outbound-voice"
77
+ o.input = Shapes::ShapeRef.new(shape: StartOutboundVoiceContactRequest)
78
+ o.output = Shapes::ShapeRef.new(shape: StartOutboundVoiceContactResponse)
79
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
80
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
81
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
82
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
83
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
84
+ o.errors << Shapes::ShapeRef.new(shape: DestinationNotAllowedException)
85
+ o.errors << Shapes::ShapeRef.new(shape: OutboundContactNotPermittedException)
86
+ end)
87
+
88
+ api.add_operation(:stop_contact, Seahorse::Model::Operation.new.tap do |o|
89
+ o.name = "StopContact"
90
+ o.http_method = "POST"
91
+ o.http_request_uri = "/contact/stop"
92
+ o.input = Shapes::ShapeRef.new(shape: StopContactRequest)
93
+ o.output = Shapes::ShapeRef.new(shape: StopContactResponse)
94
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
95
+ o.errors << Shapes::ShapeRef.new(shape: ContactNotFoundException)
96
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
97
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
98
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
99
+ end)
100
+ end
101
+
102
+ end
103
+ 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::Connect
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::Connect
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,161 @@
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::Connect
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass StartOutboundVoiceContactRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # destination_phone_number: "PhoneNumber", # required
16
+ # contact_flow_id: "ContactFlowId", # required
17
+ # instance_id: "InstanceId", # required
18
+ # client_token: "ClientToken",
19
+ # source_phone_number: "PhoneNumber",
20
+ # queue_id: "QueueId",
21
+ # attributes: {
22
+ # "AttributeName" => "AttributeValue",
23
+ # },
24
+ # }
25
+ #
26
+ # @!attribute [rw] destination_phone_number
27
+ # The phone number, in E.164 format, of the customer to call with the
28
+ # outbound contact.
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] contact_flow_id
32
+ # The identifier for the contact flow to execute for the outbound
33
+ # call. This is a GUID value only. Amazon Resource Name (ARN) values
34
+ # are not supported.
35
+ #
36
+ # To find the `ContactFlowId`, open the contact flow to use in the
37
+ # Amazon Connect contact flow designer. The ID for the contact flow is
38
+ # displayed in the address bar as part of the URL. For example, an
39
+ # address displayed when you open a contact flow is similar to the
40
+ # following:
41
+ # `https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181
42
+ # `. At the end of the URL, you see
43
+ # `contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181`. The
44
+ # `ContactFlowID` for this contact flow is `
45
+ # b0b8f2dd-ed1b-4c44-af36-ce189a178181 `. Make sure to include only
46
+ # the GUID after the "contact-flow/" in your requests.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] instance_id
50
+ # The identifier for your Amazon Connect instance. To find the
51
+ # `InstanceId` value for your Amazon Connect instance, open the
52
+ # [Amazon Connect console][1]. Select the instance alias of the
53
+ # instance and view the instance ID in the **Overview** section. For
54
+ # example, the instance ID is the set of characters at the end of the
55
+ # instance ARN, after "instance/", such as
56
+ # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
57
+ #
58
+ #
59
+ #
60
+ # [1]: https://console.aws.amazon.com/connect/
61
+ # @return [String]
62
+ #
63
+ # @!attribute [rw] client_token
64
+ # A unique, case-sensitive identifier that you provide to ensure the
65
+ # idempotency of the request. The token is valid for 7 days after
66
+ # creation. If a contact is already started, the contact ID is
67
+ # returned. If the contact is disconnected, a new contact is started.
68
+ #
69
+ # **A suitable default value is auto-generated.** You should normally
70
+ # not need to pass this option.
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] source_phone_number
74
+ # The phone number, in E.164 format, associated with your Amazon
75
+ # Connect instance to use to place the outbound call.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] queue_id
79
+ # The queue to which to add the call. If you specify a queue, the
80
+ # phone displayed for caller ID is the phone number defined for the
81
+ # queue. If you do not specify a queue, the queue used is the queue
82
+ # defined in the contact flow specified by `ContactFlowId`.
83
+ #
84
+ # To find the `QueueId`, open the queue to use in the Amazon Connect
85
+ # queue editor. The ID for the queue is displayed in the address bar
86
+ # as part of the URL. For example, the `QueueId` value is the set of
87
+ # characters at the end of the URL, after "queue/", such as
88
+ # `aeg40574-2d01-51c3-73d6-bf8624d2168c`.
89
+ # @return [String]
90
+ #
91
+ # @!attribute [rw] attributes
92
+ # Specify a custom key-value pair using an attribute map. The
93
+ # attributes are standard Amazon Connect attributes, and can be
94
+ # accessed in contact flows just like any other contact attributes.
95
+ #
96
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs.
97
+ # Attribute keys can include only alphanumeric, dash, and underscore
98
+ # characters.
99
+ #
100
+ # For example, to play a greeting when the customer answers the call,
101
+ # you can pass the customer name in attributes similar to the
102
+ # following:
103
+ # @return [Hash<String,String>]
104
+ #
105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactRequest AWS API Documentation
106
+ #
107
+ class StartOutboundVoiceContactRequest < Struct.new(
108
+ :destination_phone_number,
109
+ :contact_flow_id,
110
+ :instance_id,
111
+ :client_token,
112
+ :source_phone_number,
113
+ :queue_id,
114
+ :attributes)
115
+ include Aws::Structure
116
+ end
117
+
118
+ # @!attribute [rw] contact_id
119
+ # The unique identifier of this contact within your Amazon Connect
120
+ # instance.
121
+ # @return [String]
122
+ #
123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactResponse AWS API Documentation
124
+ #
125
+ class StartOutboundVoiceContactResponse < Struct.new(
126
+ :contact_id)
127
+ include Aws::Structure
128
+ end
129
+
130
+ # @note When making an API call, you may pass StopContactRequest
131
+ # data as a hash:
132
+ #
133
+ # {
134
+ # contact_id: "ContactId", # required
135
+ # instance_id: "InstanceId", # required
136
+ # }
137
+ #
138
+ # @!attribute [rw] contact_id
139
+ # The unique identifier of the contact to end. This is the `ContactId`
140
+ # value returned from the `StartOutboundVoiceContact` operation.
141
+ # @return [String]
142
+ #
143
+ # @!attribute [rw] instance_id
144
+ # The identifier of the Amazon Connect instance in which the contact
145
+ # is active.
146
+ # @return [String]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRequest AWS API Documentation
149
+ #
150
+ class StopContactRequest < Struct.new(
151
+ :contact_id,
152
+ :instance_id)
153
+ include Aws::Structure
154
+ end
155
+
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactResponse AWS API Documentation
157
+ #
158
+ class StopContactResponse < Aws::EmptyStructure; end
159
+
160
+ end
161
+ end
metadata ADDED
@@ -0,0 +1,82 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: aws-sdk-connect
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Amazon Web Services
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2018-03-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3'
27
+ - !ruby/object:Gem::Dependency
28
+ name: aws-sigv4
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.0'
41
+ description: Official AWS Ruby gem for Amazon Connect Service (Amazon Connect). This
42
+ gem is part of the AWS SDK for Ruby.
43
+ email:
44
+ - trevrowe@amazon.com
45
+ executables: []
46
+ extensions: []
47
+ extra_rdoc_files: []
48
+ files:
49
+ - lib/aws-sdk-connect.rb
50
+ - lib/aws-sdk-connect/client.rb
51
+ - lib/aws-sdk-connect/client_api.rb
52
+ - lib/aws-sdk-connect/customizations.rb
53
+ - lib/aws-sdk-connect/errors.rb
54
+ - lib/aws-sdk-connect/resource.rb
55
+ - lib/aws-sdk-connect/types.rb
56
+ homepage: http://github.com/aws/aws-sdk-ruby
57
+ licenses:
58
+ - Apache-2.0
59
+ metadata:
60
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-connect
61
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-connect/CHANGELOG.md
62
+ post_install_message:
63
+ rdoc_options: []
64
+ require_paths:
65
+ - lib
66
+ required_ruby_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ required_rubygems_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ requirements: []
77
+ rubyforge_project:
78
+ rubygems_version: 2.5.2.2
79
+ signing_key:
80
+ specification_version: 4
81
+ summary: AWS SDK for Ruby - Amazon Connect
82
+ test_files: []