aws-sdk-connect 1.9.0 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 60c6b98784bcedc373073f5ab6fa90958d37bd09
4
- data.tar.gz: e8b3b8634a04c2f655c16368d1604baeeef257e5
3
+ metadata.gz: ad1d4e9b7eb1fc7a8b806261524479e87aacd5c7
4
+ data.tar.gz: 6e7d5f579d9e358f27fd3598255aec7933862db8
5
5
  SHA512:
6
- metadata.gz: 572e3e7bdc7e0a0ccd5dcaf37e725df7baf232311cf7b3860d2d360630d8da8f50019c25061599c899ac6f350e1409cb82256d14b2aa1d799a0314ea36b3275a
7
- data.tar.gz: 52bb5febf207b628a1e272fed4ba4b5dc16fcbb971792e085d17347fac00baef938a28e73e1257401a15022c88bd485b0b8ad1f6f43426cb1eef56efd2c8c26f
6
+ metadata.gz: 2416e4b2bdb4ab466b34d5074c82d2a09cd3f8ff77bc36bc2d5f8cdcd1fb7d78221eddf610d051e82f733a85ceae776a98852b3fae875e3bd345b0065437cb05
7
+ data.tar.gz: fdaa6ce06b7f7706e1a168badecab394a3e3be92c2db73b8d16ecdcfd79780d1999db21f1b9dbe92302d9c0e34b2c84148ecef9936e024b8a8467c29225ab886
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-connect/customizations'
42
42
  # @service
43
43
  module Aws::Connect
44
44
 
45
- GEM_VERSION = '1.9.0'
45
+ GEM_VERSION = '1.10.0'
46
46
 
47
47
  end
@@ -208,7 +208,10 @@ module Aws::Connect
208
208
  # Creates a new user account in your Amazon Connect instance.
209
209
  #
210
210
  # @option params [required, String] :username
211
- # The user name in Amazon Connect for the account to create.
211
+ # The user name in Amazon Connect for the account to create. If you are
212
+ # using SAML for identity management in your Amazon Connect, the value
213
+ # for `Username` can include up to 64 characters from
214
+ # \[a-zA-Z0-9\_-.\\@\]+.
212
215
  #
213
216
  # @option params [String] :password
214
217
  # The password for the user account to create. This is required if you
@@ -222,7 +225,8 @@ module Aws::Connect
222
225
  #
223
226
  # @option params [required, Types::UserPhoneConfig] :phone_config
224
227
  # Specifies the phone settings for the user, including
225
- # AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
228
+ # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
229
+ # `PhoneType`.
226
230
  #
227
231
  # @option params [String] :directory_user_id
228
232
  # The unique identifier for the user account in the directory service
@@ -230,8 +234,8 @@ module Aws::Connect
230
234
  # access the existing directory, you can use the `DirectoryUserId` to
231
235
  # authenticate users. If you include the parameter, it is assumed that
232
236
  # Amazon Connect cannot access the directory. If the parameter is not
233
- # included, the UserIdentityInfo is used to authenticate users from your
234
- # existing directory.
237
+ # included, the `UserIdentityInfo` is used to authenticate users from
238
+ # your existing directory.
235
239
  #
236
240
  # This parameter is required if you are using an existing directory for
237
241
  # identity management in Amazon Connect when Amazon Connect cannot
@@ -493,6 +497,41 @@ module Aws::Connect
493
497
  req.send_request(options)
494
498
  end
495
499
 
500
+ # Retrieves the contact attributes associated with a contact.
501
+ #
502
+ # @option params [required, String] :instance_id
503
+ # The instance ID for the instance from which to retrieve contact
504
+ # attributes.
505
+ #
506
+ # @option params [required, String] :initial_contact_id
507
+ # The ID for the initial contact in Amazon Connect associated with the
508
+ # attributes to update.
509
+ #
510
+ # @return [Types::GetContactAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
511
+ #
512
+ # * {Types::GetContactAttributesResponse#attributes #attributes} => Hash<String,String>
513
+ #
514
+ # @example Request syntax with placeholder values
515
+ #
516
+ # resp = client.get_contact_attributes({
517
+ # instance_id: "InstanceId", # required
518
+ # initial_contact_id: "ContactId", # required
519
+ # })
520
+ #
521
+ # @example Response structure
522
+ #
523
+ # resp.attributes #=> Hash
524
+ # resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes AWS API Documentation
527
+ #
528
+ # @overload get_contact_attributes(params = {})
529
+ # @param [Hash] params ({})
530
+ def get_contact_attributes(params = {}, options = {})
531
+ req = build_request(:get_contact_attributes, params)
532
+ req.send_request(options)
533
+ end
534
+
496
535
  # The `GetCurrentMetricData` operation retrieves current metric data
497
536
  # from your Amazon Connect instance.
498
537
  #
@@ -537,7 +576,8 @@ module Aws::Connect
537
576
  # @option params [required, Array<Types::CurrentMetric>] :current_metrics
538
577
  # A list of `CurrentMetric` objects for the metrics to retrieve. Each
539
578
  # `CurrentMetric` includes a name of a metric to retrieve and the unit
540
- # to use for it.
579
+ # to use for it. You must list each metric to retrieve data for in the
580
+ # request.
541
581
  #
542
582
  # The following metrics are available:
543
583
  #
@@ -746,8 +786,9 @@ module Aws::Connect
746
786
  # A `HistoricalMetric` object contains: `HistoricalMetricName`,
747
787
  # `Statistic`, `Threshold`, and `Unit`.
748
788
  #
749
- # For each historical metric you include in the request, you must
750
- # include a `Unit` and a `Statistic`.
789
+ # You must list each metric to retrieve data for in the request. For
790
+ # each historical metric you include in the request, you must include a
791
+ # `Unit` and a `Statistic`.
751
792
  #
752
793
  # The following historical metrics are available:
753
794
  #
@@ -1183,6 +1224,9 @@ module Aws::Connect
1183
1224
  # If you are using an IAM account, it must have permission to the
1184
1225
  # `connect:StartOutboundVoiceContact` action.
1185
1226
  #
1227
+ # There is a 60 second dialing timeout for this operation. If the call
1228
+ # is not connected after 60 seconds, the call fails.
1229
+ #
1186
1230
  # @option params [required, String] :destination_phone_number
1187
1231
  # The phone number of the customer in E.164 format.
1188
1232
  #
@@ -1234,9 +1278,9 @@ module Aws::Connect
1234
1278
  # are standard Amazon Connect attributes, and can be accessed in contact
1235
1279
  # flows just like any other contact attributes.
1236
1280
  #
1237
- # There can be up to 32,768 UTF-8 bytes across all key-value pairs.
1238
- # Attribute keys can include only alphanumeric, dash, and underscore
1239
- # characters.
1281
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1282
+ # contact. Attribute keys can include only alphanumeric, dash, and
1283
+ # underscore characters.
1240
1284
  #
1241
1285
  # For example, if you want play a greeting when the customer answers the
1242
1286
  # call, you can pass the customer name in attributes similar to the
@@ -1350,7 +1394,13 @@ module Aws::Connect
1350
1394
  # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1351
1395
  #
1352
1396
  # @option params [required, Hash<String,String>] :attributes
1353
- # The key-value pairs for the attribute to update.
1397
+ # Specify a custom key-value pair using an attribute map. The attributes
1398
+ # are standard Amazon Connect attributes, and can be accessed in contact
1399
+ # flows just like any other contact attributes.
1400
+ #
1401
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1402
+ # contact. Attribute keys can include only alphanumeric, dash, and
1403
+ # underscore characters.
1354
1404
  #
1355
1405
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1356
1406
  #
@@ -1580,7 +1630,7 @@ module Aws::Connect
1580
1630
  params: params,
1581
1631
  config: config)
1582
1632
  context[:gem_name] = 'aws-sdk-connect'
1583
- context[:gem_version] = '1.9.0'
1633
+ context[:gem_version] = '1.10.0'
1584
1634
  Seahorse::Client::Request.new(handlers, context)
1585
1635
  end
1586
1636
 
@@ -50,6 +50,8 @@ module Aws::Connect
50
50
  DuplicateResourceException = Shapes::StructureShape.new(name: 'DuplicateResourceException')
51
51
  Email = Shapes::StringShape.new(name: 'Email')
52
52
  Filters = Shapes::StructureShape.new(name: 'Filters')
53
+ GetContactAttributesRequest = Shapes::StructureShape.new(name: 'GetContactAttributesRequest')
54
+ GetContactAttributesResponse = Shapes::StructureShape.new(name: 'GetContactAttributesResponse')
53
55
  GetCurrentMetricDataRequest = Shapes::StructureShape.new(name: 'GetCurrentMetricDataRequest')
54
56
  GetCurrentMetricDataResponse = Shapes::StructureShape.new(name: 'GetCurrentMetricDataResponse')
55
57
  GetFederationTokenRequest = Shapes::StructureShape.new(name: 'GetFederationTokenRequest')
@@ -212,6 +214,13 @@ module Aws::Connect
212
214
  Filters.add_member(:channels, Shapes::ShapeRef.new(shape: Channels, location_name: "Channels"))
213
215
  Filters.struct_class = Types::Filters
214
216
 
217
+ GetContactAttributesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
218
+ GetContactAttributesRequest.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location: "uri", location_name: "InitialContactId"))
219
+ GetContactAttributesRequest.struct_class = Types::GetContactAttributesRequest
220
+
221
+ GetContactAttributesResponse.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
222
+ GetContactAttributesResponse.struct_class = Types::GetContactAttributesResponse
223
+
215
224
  GetCurrentMetricDataRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
216
225
  GetCurrentMetricDataRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, required: true, location_name: "Filters"))
217
226
  GetCurrentMetricDataRequest.add_member(:groupings, Shapes::ShapeRef.new(shape: Groupings, location_name: "Groupings"))
@@ -527,6 +536,17 @@ module Aws::Connect
527
536
  o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
528
537
  end)
529
538
 
539
+ api.add_operation(:get_contact_attributes, Seahorse::Model::Operation.new.tap do |o|
540
+ o.name = "GetContactAttributes"
541
+ o.http_method = "GET"
542
+ o.http_request_uri = "/contact/attributes/{InstanceId}/{InitialContactId}"
543
+ o.input = Shapes::ShapeRef.new(shape: GetContactAttributesRequest)
544
+ o.output = Shapes::ShapeRef.new(shape: GetContactAttributesResponse)
545
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
546
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
547
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
548
+ end)
549
+
530
550
  api.add_operation(:get_current_metric_data, Seahorse::Model::Operation.new.tap do |o|
531
551
  o.name = "GetCurrentMetricData"
532
552
  o.http_method = "POST"
@@ -33,7 +33,10 @@ module Aws::Connect
33
33
  # }
34
34
  #
35
35
  # @!attribute [rw] username
36
- # The user name in Amazon Connect for the account to create.
36
+ # The user name in Amazon Connect for the account to create. If you
37
+ # are using SAML for identity management in your Amazon Connect, the
38
+ # value for `Username` can include up to 64 characters from
39
+ # \[a-zA-Z0-9\_-.\\@\]+.
37
40
  # @return [String]
38
41
  #
39
42
  # @!attribute [rw] password
@@ -50,8 +53,8 @@ module Aws::Connect
50
53
  #
51
54
  # @!attribute [rw] phone_config
52
55
  # Specifies the phone settings for the user, including
53
- # AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and
54
- # PhoneType.
56
+ # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
57
+ # `PhoneType`.
55
58
  # @return [Types::UserPhoneConfig]
56
59
  #
57
60
  # @!attribute [rw] directory_user_id
@@ -60,7 +63,7 @@ module Aws::Connect
60
63
  # to access the existing directory, you can use the `DirectoryUserId`
61
64
  # to authenticate users. If you include the parameter, it is assumed
62
65
  # that Amazon Connect cannot access the directory. If the parameter is
63
- # not included, the UserIdentityInfo is used to authenticate users
66
+ # not included, the `UserIdentityInfo` is used to authenticate users
64
67
  # from your existing directory.
65
68
  #
66
69
  # This parameter is required if you are using an existing directory
@@ -417,6 +420,43 @@ module Aws::Connect
417
420
  include Aws::Structure
418
421
  end
419
422
 
423
+ # @note When making an API call, you may pass GetContactAttributesRequest
424
+ # data as a hash:
425
+ #
426
+ # {
427
+ # instance_id: "InstanceId", # required
428
+ # initial_contact_id: "ContactId", # required
429
+ # }
430
+ #
431
+ # @!attribute [rw] instance_id
432
+ # The instance ID for the instance from which to retrieve contact
433
+ # attributes.
434
+ # @return [String]
435
+ #
436
+ # @!attribute [rw] initial_contact_id
437
+ # The ID for the initial contact in Amazon Connect associated with the
438
+ # attributes to update.
439
+ # @return [String]
440
+ #
441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributesRequest AWS API Documentation
442
+ #
443
+ class GetContactAttributesRequest < Struct.new(
444
+ :instance_id,
445
+ :initial_contact_id)
446
+ include Aws::Structure
447
+ end
448
+
449
+ # @!attribute [rw] attributes
450
+ # The attributes to update.
451
+ # @return [Hash<String,String>]
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributesResponse AWS API Documentation
454
+ #
455
+ class GetContactAttributesResponse < Struct.new(
456
+ :attributes)
457
+ include Aws::Structure
458
+ end
459
+
420
460
  # @note When making an API call, you may pass GetCurrentMetricDataRequest
421
461
  # data as a hash:
422
462
  #
@@ -478,7 +518,8 @@ module Aws::Connect
478
518
  # @!attribute [rw] current_metrics
479
519
  # A list of `CurrentMetric` objects for the metrics to retrieve. Each
480
520
  # `CurrentMetric` includes a name of a metric to retrieve and the unit
481
- # to use for it.
521
+ # to use for it. You must list each metric to retrieve data for in the
522
+ # request.
482
523
  #
483
524
  # The following metrics are available:
484
525
  #
@@ -719,8 +760,9 @@ module Aws::Connect
719
760
  # A `HistoricalMetric` object contains: `HistoricalMetricName`,
720
761
  # `Statistic`, `Threshold`, and `Unit`.
721
762
  #
722
- # For each historical metric you include in the request, you must
723
- # include a `Unit` and a `Statistic`.
763
+ # You must list each metric to retrieve data for in the request. For
764
+ # each historical metric you include in the request, you must include
765
+ # a `Unit` and a `Statistic`.
724
766
  #
725
767
  # The following historical metrics are available:
726
768
  #
@@ -1125,11 +1167,11 @@ module Aws::Connect
1125
1167
  # @return [Types::Threshold]
1126
1168
  #
1127
1169
  # @!attribute [rw] statistic
1128
- # The statistic for the metric: SUM, MAX, or SUM.
1170
+ # The statistic for the metric.
1129
1171
  # @return [String]
1130
1172
  #
1131
1173
  # @!attribute [rw] unit
1132
- # The unit for the metric: COUNT, PERCENT, or SECONDS.
1174
+ # The unit for the metric.
1133
1175
  # @return [String]
1134
1176
  #
1135
1177
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HistoricalMetric AWS API Documentation
@@ -1545,9 +1587,9 @@ module Aws::Connect
1545
1587
  # attributes are standard Amazon Connect attributes, and can be
1546
1588
  # accessed in contact flows just like any other contact attributes.
1547
1589
  #
1548
- # There can be up to 32,768 UTF-8 bytes across all key-value pairs.
1549
- # Attribute keys can include only alphanumeric, dash, and underscore
1550
- # characters.
1590
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1591
+ # contact. Attribute keys can include only alphanumeric, dash, and
1592
+ # underscore characters.
1551
1593
  #
1552
1594
  # For example, if you want play a greeting when the customer answers
1553
1595
  # the call, you can pass the customer name in attributes similar to
@@ -1670,7 +1712,13 @@ module Aws::Connect
1670
1712
  # @return [String]
1671
1713
  #
1672
1714
  # @!attribute [rw] attributes
1673
- # The key-value pairs for the attribute to update.
1715
+ # Specify a custom key-value pair using an attribute map. The
1716
+ # attributes are standard Amazon Connect attributes, and can be
1717
+ # accessed in contact flows just like any other contact attributes.
1718
+ #
1719
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1720
+ # contact. Attribute keys can include only alphanumeric, dash, and
1721
+ # underscore characters.
1674
1722
  # @return [Hash<String,String>]
1675
1723
  #
1676
1724
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactAttributesRequest AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-connect
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.9.0
4
+ version: 1.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-11-20 00:00:00.000000000 Z
11
+ date: 2018-12-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core