aws-sdk-connect 1.236.0 → 1.237.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +652 -1
- data/lib/aws-sdk-connect/client_api.rb +417 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/types.rb +938 -63
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +213 -0
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +244 -0
- metadata +1 -1
|
@@ -4932,6 +4932,89 @@ module Aws::Connect
|
|
|
4932
4932
|
req.send_request(options)
|
|
4933
4933
|
end
|
|
4934
4934
|
|
|
4935
|
+
# Creates a test case with its content and metadata for the specified
|
|
4936
|
+
# Amazon Connect instance.
|
|
4937
|
+
#
|
|
4938
|
+
# @option params [required, String] :instance_id
|
|
4939
|
+
# The identifier of the Amazon Connect instance.
|
|
4940
|
+
#
|
|
4941
|
+
# @option params [required, String] :name
|
|
4942
|
+
# The name of the test.
|
|
4943
|
+
#
|
|
4944
|
+
# @option params [String] :description
|
|
4945
|
+
# The description of the test.
|
|
4946
|
+
#
|
|
4947
|
+
# @option params [required, String] :content
|
|
4948
|
+
# The JSON string that represents the content of the test.
|
|
4949
|
+
#
|
|
4950
|
+
# @option params [Types::TestCaseEntryPoint] :entry_point
|
|
4951
|
+
# Defines the starting point for your test.
|
|
4952
|
+
#
|
|
4953
|
+
# @option params [String] :initialization_data
|
|
4954
|
+
# Defines the initial custom attributes for your test.
|
|
4955
|
+
#
|
|
4956
|
+
# @option params [String] :status
|
|
4957
|
+
# Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED
|
|
4958
|
+
# status will initiate validation on the content. The SAVED status does
|
|
4959
|
+
# not initiate validation of the content.
|
|
4960
|
+
#
|
|
4961
|
+
# @option params [String] :test_case_id
|
|
4962
|
+
# Id of the test case if you want to create it in a replica region using
|
|
4963
|
+
# Amazon Connect Global Resiliency
|
|
4964
|
+
#
|
|
4965
|
+
# @option params [Hash<String,String>] :tags
|
|
4966
|
+
# The tags used to organize, track, or control access for this resource.
|
|
4967
|
+
#
|
|
4968
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified_time
|
|
4969
|
+
# The time at which the resource was last modified.
|
|
4970
|
+
#
|
|
4971
|
+
# @option params [String] :last_modified_region
|
|
4972
|
+
# The region in which the resource was last modified
|
|
4973
|
+
#
|
|
4974
|
+
# @return [Types::CreateTestCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4975
|
+
#
|
|
4976
|
+
# * {Types::CreateTestCaseResponse#test_case_id #test_case_id} => String
|
|
4977
|
+
# * {Types::CreateTestCaseResponse#test_case_arn #test_case_arn} => String
|
|
4978
|
+
#
|
|
4979
|
+
# @example Request syntax with placeholder values
|
|
4980
|
+
#
|
|
4981
|
+
# resp = client.create_test_case({
|
|
4982
|
+
# instance_id: "InstanceIdOrArn", # required
|
|
4983
|
+
# name: "TestCaseName", # required
|
|
4984
|
+
# description: "TestCaseDescription",
|
|
4985
|
+
# content: "TestCaseContent", # required
|
|
4986
|
+
# entry_point: {
|
|
4987
|
+
# type: "VOICE_CALL", # accepts VOICE_CALL
|
|
4988
|
+
# voice_call_entry_point_parameters: {
|
|
4989
|
+
# source_phone_number: "PhoneNumber",
|
|
4990
|
+
# destination_phone_number: "PhoneNumber",
|
|
4991
|
+
# flow_id: "ContactFlowId",
|
|
4992
|
+
# },
|
|
4993
|
+
# },
|
|
4994
|
+
# initialization_data: "TestCaseInitializationData",
|
|
4995
|
+
# status: "PUBLISHED", # accepts PUBLISHED, SAVED
|
|
4996
|
+
# test_case_id: "TestCaseId",
|
|
4997
|
+
# tags: {
|
|
4998
|
+
# "TagKey" => "TagValue",
|
|
4999
|
+
# },
|
|
5000
|
+
# last_modified_time: Time.now,
|
|
5001
|
+
# last_modified_region: "RegionName",
|
|
5002
|
+
# })
|
|
5003
|
+
#
|
|
5004
|
+
# @example Response structure
|
|
5005
|
+
#
|
|
5006
|
+
# resp.test_case_id #=> String
|
|
5007
|
+
# resp.test_case_arn #=> String
|
|
5008
|
+
#
|
|
5009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTestCase AWS API Documentation
|
|
5010
|
+
#
|
|
5011
|
+
# @overload create_test_case(params = {})
|
|
5012
|
+
# @param [Hash] params ({})
|
|
5013
|
+
def create_test_case(params = {}, options = {})
|
|
5014
|
+
req = build_request(:create_test_case, params)
|
|
5015
|
+
req.send_request(options)
|
|
5016
|
+
end
|
|
5017
|
+
|
|
4935
5018
|
# Creates a traffic distribution group given an Amazon Connect instance
|
|
4936
5019
|
# that has been replicated.
|
|
4937
5020
|
#
|
|
@@ -6564,6 +6647,33 @@ module Aws::Connect
|
|
|
6564
6647
|
req.send_request(options)
|
|
6565
6648
|
end
|
|
6566
6649
|
|
|
6650
|
+
# Deletes the test case that has already been created for the specified
|
|
6651
|
+
# Amazon Connect instance.
|
|
6652
|
+
#
|
|
6653
|
+
# @option params [required, String] :instance_id
|
|
6654
|
+
# The identifier of the Amazon Connect instance.
|
|
6655
|
+
#
|
|
6656
|
+
# @option params [required, String] :test_case_id
|
|
6657
|
+
# The identifier of the test case to delete.
|
|
6658
|
+
#
|
|
6659
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6660
|
+
#
|
|
6661
|
+
# @example Request syntax with placeholder values
|
|
6662
|
+
#
|
|
6663
|
+
# resp = client.delete_test_case({
|
|
6664
|
+
# instance_id: "InstanceIdOrArn", # required
|
|
6665
|
+
# test_case_id: "TestCaseId", # required
|
|
6666
|
+
# })
|
|
6667
|
+
#
|
|
6668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTestCase AWS API Documentation
|
|
6669
|
+
#
|
|
6670
|
+
# @overload delete_test_case(params = {})
|
|
6671
|
+
# @param [Hash] params ({})
|
|
6672
|
+
def delete_test_case(params = {}, options = {})
|
|
6673
|
+
req = build_request(:delete_test_case, params)
|
|
6674
|
+
req.send_request(options)
|
|
6675
|
+
end
|
|
6676
|
+
|
|
6567
6677
|
# Deletes a traffic distribution group. This API can be called only in
|
|
6568
6678
|
# the Region where the traffic distribution group is created.
|
|
6569
6679
|
#
|
|
@@ -8695,6 +8805,61 @@ module Aws::Connect
|
|
|
8695
8805
|
req.send_request(options)
|
|
8696
8806
|
end
|
|
8697
8807
|
|
|
8808
|
+
# Describes the specified test case and allows you to get the content
|
|
8809
|
+
# and metadata of the test case for the specified Amazon Connect
|
|
8810
|
+
# instance.
|
|
8811
|
+
#
|
|
8812
|
+
# @option params [required, String] :instance_id
|
|
8813
|
+
# The identifier of the Amazon Connect instance.
|
|
8814
|
+
#
|
|
8815
|
+
# @option params [required, String] :test_case_id
|
|
8816
|
+
# The identifier of the test case.
|
|
8817
|
+
#
|
|
8818
|
+
# @option params [String] :status
|
|
8819
|
+
# The status of the test case version to retrieve. If not specified,
|
|
8820
|
+
# returns the published version if available, otherwise returns the
|
|
8821
|
+
# saved version.
|
|
8822
|
+
#
|
|
8823
|
+
# @return [Types::DescribeTestCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8824
|
+
#
|
|
8825
|
+
# * {Types::DescribeTestCaseResponse#test_case #test_case} => Types::TestCase
|
|
8826
|
+
#
|
|
8827
|
+
# @example Request syntax with placeholder values
|
|
8828
|
+
#
|
|
8829
|
+
# resp = client.describe_test_case({
|
|
8830
|
+
# instance_id: "InstanceIdOrArn", # required
|
|
8831
|
+
# test_case_id: "TestCaseId", # required
|
|
8832
|
+
# status: "PUBLISHED", # accepts PUBLISHED, SAVED
|
|
8833
|
+
# })
|
|
8834
|
+
#
|
|
8835
|
+
# @example Response structure
|
|
8836
|
+
#
|
|
8837
|
+
# resp.test_case.arn #=> String
|
|
8838
|
+
# resp.test_case.id #=> String
|
|
8839
|
+
# resp.test_case.name #=> String
|
|
8840
|
+
# resp.test_case.content #=> String
|
|
8841
|
+
# resp.test_case.entry_point.type #=> String, one of "VOICE_CALL"
|
|
8842
|
+
# resp.test_case.entry_point.voice_call_entry_point_parameters.source_phone_number #=> String
|
|
8843
|
+
# resp.test_case.entry_point.voice_call_entry_point_parameters.destination_phone_number #=> String
|
|
8844
|
+
# resp.test_case.entry_point.voice_call_entry_point_parameters.flow_id #=> String
|
|
8845
|
+
# resp.test_case.initialization_data #=> String
|
|
8846
|
+
# resp.test_case.description #=> String
|
|
8847
|
+
# resp.test_case.status #=> String, one of "PUBLISHED", "SAVED"
|
|
8848
|
+
# resp.test_case.last_modified_time #=> Time
|
|
8849
|
+
# resp.test_case.last_modified_region #=> String
|
|
8850
|
+
# resp.test_case.tags #=> Hash
|
|
8851
|
+
# resp.test_case.tags["TagKey"] #=> String
|
|
8852
|
+
# resp.test_case.test_case_sha_256 #=> String
|
|
8853
|
+
#
|
|
8854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeTestCase AWS API Documentation
|
|
8855
|
+
#
|
|
8856
|
+
# @overload describe_test_case(params = {})
|
|
8857
|
+
# @param [Hash] params ({})
|
|
8858
|
+
def describe_test_case(params = {}, options = {})
|
|
8859
|
+
req = build_request(:describe_test_case, params)
|
|
8860
|
+
req.send_request(options)
|
|
8861
|
+
end
|
|
8862
|
+
|
|
8698
8863
|
# Gets details and status of a traffic distribution group.
|
|
8699
8864
|
#
|
|
8700
8865
|
# @option params [required, String] :traffic_distribution_group_id
|
|
@@ -13594,6 +13759,51 @@ module Aws::Connect
|
|
|
13594
13759
|
req.send_request(options)
|
|
13595
13760
|
end
|
|
13596
13761
|
|
|
13762
|
+
# Retrieves an overview of a test execution that includes the status of
|
|
13763
|
+
# the execution, start and end time, and observation summary.
|
|
13764
|
+
#
|
|
13765
|
+
# @option params [required, String] :instance_id
|
|
13766
|
+
# The identifier of the Amazon Connect instance.
|
|
13767
|
+
#
|
|
13768
|
+
# @option params [required, String] :test_case_id
|
|
13769
|
+
# The identifier of the test case.
|
|
13770
|
+
#
|
|
13771
|
+
# @option params [required, String] :test_case_execution_id
|
|
13772
|
+
# The identifier of the test case execution.
|
|
13773
|
+
#
|
|
13774
|
+
# @return [Types::GetTestCaseExecutionSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
13775
|
+
#
|
|
13776
|
+
# * {Types::GetTestCaseExecutionSummaryResponse#start_time #start_time} => Time
|
|
13777
|
+
# * {Types::GetTestCaseExecutionSummaryResponse#end_time #end_time} => Time
|
|
13778
|
+
# * {Types::GetTestCaseExecutionSummaryResponse#status #status} => String
|
|
13779
|
+
# * {Types::GetTestCaseExecutionSummaryResponse#observation_summary #observation_summary} => Types::ObservationSummary
|
|
13780
|
+
#
|
|
13781
|
+
# @example Request syntax with placeholder values
|
|
13782
|
+
#
|
|
13783
|
+
# resp = client.get_test_case_execution_summary({
|
|
13784
|
+
# instance_id: "InstanceId", # required
|
|
13785
|
+
# test_case_id: "TestCaseId", # required
|
|
13786
|
+
# test_case_execution_id: "TestCaseExecutionId", # required
|
|
13787
|
+
# })
|
|
13788
|
+
#
|
|
13789
|
+
# @example Response structure
|
|
13790
|
+
#
|
|
13791
|
+
# resp.start_time #=> Time
|
|
13792
|
+
# resp.end_time #=> Time
|
|
13793
|
+
# resp.status #=> String, one of "INITIATED", "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"
|
|
13794
|
+
# resp.observation_summary.total_observations #=> Integer
|
|
13795
|
+
# resp.observation_summary.observations_passed #=> Integer
|
|
13796
|
+
# resp.observation_summary.observations_failed #=> Integer
|
|
13797
|
+
#
|
|
13798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTestCaseExecutionSummary AWS API Documentation
|
|
13799
|
+
#
|
|
13800
|
+
# @overload get_test_case_execution_summary(params = {})
|
|
13801
|
+
# @param [Hash] params ({})
|
|
13802
|
+
def get_test_case_execution_summary(params = {}, options = {})
|
|
13803
|
+
req = build_request(:get_test_case_execution_summary, params)
|
|
13804
|
+
req.send_request(options)
|
|
13805
|
+
end
|
|
13806
|
+
|
|
13597
13807
|
# Retrieves the current traffic distribution for a given traffic
|
|
13598
13808
|
# distribution group.
|
|
13599
13809
|
#
|
|
@@ -17039,6 +17249,181 @@ module Aws::Connect
|
|
|
17039
17249
|
req.send_request(options)
|
|
17040
17250
|
end
|
|
17041
17251
|
|
|
17252
|
+
# Lists detailed steps of test case execution that includes all
|
|
17253
|
+
# observations along with actions taken and data associated in the
|
|
17254
|
+
# specified Amazon Connect instance.
|
|
17255
|
+
#
|
|
17256
|
+
# @option params [required, String] :instance_id
|
|
17257
|
+
# The identifier of the Amazon Connect instance.
|
|
17258
|
+
#
|
|
17259
|
+
# @option params [required, String] :test_case_id
|
|
17260
|
+
# The identifier of the test case.
|
|
17261
|
+
#
|
|
17262
|
+
# @option params [required, String] :test_case_execution_id
|
|
17263
|
+
# The identifier of the test case execution.
|
|
17264
|
+
#
|
|
17265
|
+
# @option params [String] :status
|
|
17266
|
+
# Filter execution records by status.
|
|
17267
|
+
#
|
|
17268
|
+
# @option params [String] :next_token
|
|
17269
|
+
# The token for the next set of results. Use the value returned in the
|
|
17270
|
+
# previous response in the next request to retrieve the next set of
|
|
17271
|
+
# results.
|
|
17272
|
+
#
|
|
17273
|
+
# @option params [Integer] :max_results
|
|
17274
|
+
# The maximum number of results to return per page.
|
|
17275
|
+
#
|
|
17276
|
+
# @return [Types::ListTestCaseExecutionRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17277
|
+
#
|
|
17278
|
+
# * {Types::ListTestCaseExecutionRecordsResponse#execution_records #execution_records} => Array<Types::ExecutionRecord>
|
|
17279
|
+
# * {Types::ListTestCaseExecutionRecordsResponse#next_token #next_token} => String
|
|
17280
|
+
#
|
|
17281
|
+
# @example Request syntax with placeholder values
|
|
17282
|
+
#
|
|
17283
|
+
# resp = client.list_test_case_execution_records({
|
|
17284
|
+
# instance_id: "InstanceId", # required
|
|
17285
|
+
# test_case_id: "TestCaseId", # required
|
|
17286
|
+
# test_case_execution_id: "TestCaseExecutionId", # required
|
|
17287
|
+
# status: "INITIATED", # accepts INITIATED, PASSED, FAILED, IN_PROGRESS, STOPPED
|
|
17288
|
+
# next_token: "NextToken",
|
|
17289
|
+
# max_results: 1,
|
|
17290
|
+
# })
|
|
17291
|
+
#
|
|
17292
|
+
# @example Response structure
|
|
17293
|
+
#
|
|
17294
|
+
# resp.execution_records #=> Array
|
|
17295
|
+
# resp.execution_records[0].observation_id #=> String
|
|
17296
|
+
# resp.execution_records[0].status #=> String, one of "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"
|
|
17297
|
+
# resp.execution_records[0].timestamp #=> Time
|
|
17298
|
+
# resp.execution_records[0].record #=> String
|
|
17299
|
+
# resp.next_token #=> String
|
|
17300
|
+
#
|
|
17301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTestCaseExecutionRecords AWS API Documentation
|
|
17302
|
+
#
|
|
17303
|
+
# @overload list_test_case_execution_records(params = {})
|
|
17304
|
+
# @param [Hash] params ({})
|
|
17305
|
+
def list_test_case_execution_records(params = {}, options = {})
|
|
17306
|
+
req = build_request(:list_test_case_execution_records, params)
|
|
17307
|
+
req.send_request(options)
|
|
17308
|
+
end
|
|
17309
|
+
|
|
17310
|
+
# Lists all test case executions and allows filtering by test case id,
|
|
17311
|
+
# test case name, start time, end time or status of the execution for
|
|
17312
|
+
# the specified Amazon Connect instance.
|
|
17313
|
+
#
|
|
17314
|
+
# @option params [required, String] :instance_id
|
|
17315
|
+
# The identifier of the Amazon Connect instance.
|
|
17316
|
+
#
|
|
17317
|
+
# @option params [String] :test_case_id
|
|
17318
|
+
# Filter executions by test case identifier.
|
|
17319
|
+
#
|
|
17320
|
+
# @option params [String] :test_case_name
|
|
17321
|
+
# Filter executions by test case name.
|
|
17322
|
+
#
|
|
17323
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
|
17324
|
+
# Filter executions that started after this time.
|
|
17325
|
+
#
|
|
17326
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
|
17327
|
+
# Filter executions that started before this time.
|
|
17328
|
+
#
|
|
17329
|
+
# @option params [String] :status
|
|
17330
|
+
# Filter executions by status.
|
|
17331
|
+
#
|
|
17332
|
+
# @option params [String] :next_token
|
|
17333
|
+
# The token for the next set of results. Use the value returned in the
|
|
17334
|
+
# previous response in the next request to retrieve the next set of
|
|
17335
|
+
# results.
|
|
17336
|
+
#
|
|
17337
|
+
# @option params [Integer] :max_results
|
|
17338
|
+
# The maximum number of results to return per page.
|
|
17339
|
+
#
|
|
17340
|
+
# @return [Types::ListTestCaseExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17341
|
+
#
|
|
17342
|
+
# * {Types::ListTestCaseExecutionsResponse#test_case_executions #test_case_executions} => Array<Types::TestCaseExecution>
|
|
17343
|
+
# * {Types::ListTestCaseExecutionsResponse#next_token #next_token} => String
|
|
17344
|
+
#
|
|
17345
|
+
# @example Request syntax with placeholder values
|
|
17346
|
+
#
|
|
17347
|
+
# resp = client.list_test_case_executions({
|
|
17348
|
+
# instance_id: "InstanceId", # required
|
|
17349
|
+
# test_case_id: "TestCaseId",
|
|
17350
|
+
# test_case_name: "TestCaseName",
|
|
17351
|
+
# start_time: Time.now,
|
|
17352
|
+
# end_time: Time.now,
|
|
17353
|
+
# status: "INITIATED", # accepts INITIATED, PASSED, FAILED, IN_PROGRESS, STOPPED
|
|
17354
|
+
# next_token: "NextToken",
|
|
17355
|
+
# max_results: 1,
|
|
17356
|
+
# })
|
|
17357
|
+
#
|
|
17358
|
+
# @example Response structure
|
|
17359
|
+
#
|
|
17360
|
+
# resp.test_case_executions #=> Array
|
|
17361
|
+
# resp.test_case_executions[0].start_time #=> Time
|
|
17362
|
+
# resp.test_case_executions[0].end_time #=> Time
|
|
17363
|
+
# resp.test_case_executions[0].test_case_execution_id #=> String
|
|
17364
|
+
# resp.test_case_executions[0].test_case_id #=> String
|
|
17365
|
+
# resp.test_case_executions[0].test_case_execution_status #=> String, one of "INITIATED", "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"
|
|
17366
|
+
# resp.test_case_executions[0].tags #=> Hash
|
|
17367
|
+
# resp.test_case_executions[0].tags["TagKey"] #=> String
|
|
17368
|
+
# resp.next_token #=> String
|
|
17369
|
+
#
|
|
17370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTestCaseExecutions AWS API Documentation
|
|
17371
|
+
#
|
|
17372
|
+
# @overload list_test_case_executions(params = {})
|
|
17373
|
+
# @param [Hash] params ({})
|
|
17374
|
+
def list_test_case_executions(params = {}, options = {})
|
|
17375
|
+
req = build_request(:list_test_case_executions, params)
|
|
17376
|
+
req.send_request(options)
|
|
17377
|
+
end
|
|
17378
|
+
|
|
17379
|
+
# Lists the test cases present in the specific Amazon Connect instance.
|
|
17380
|
+
#
|
|
17381
|
+
# @option params [required, String] :instance_id
|
|
17382
|
+
# The identifier of the Amazon Connect instance.
|
|
17383
|
+
#
|
|
17384
|
+
# @option params [String] :next_token
|
|
17385
|
+
# The token for the next set of results. Use the value returned in the
|
|
17386
|
+
# previous response in the next request to retrieve the next set of
|
|
17387
|
+
# results.
|
|
17388
|
+
#
|
|
17389
|
+
# @option params [Integer] :max_results
|
|
17390
|
+
# The maximum number of results to return per page.
|
|
17391
|
+
#
|
|
17392
|
+
# @return [Types::ListTestCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17393
|
+
#
|
|
17394
|
+
# * {Types::ListTestCasesResponse#test_case_summary_list #test_case_summary_list} => Array<Types::TestCaseSummary>
|
|
17395
|
+
# * {Types::ListTestCasesResponse#next_token #next_token} => String
|
|
17396
|
+
#
|
|
17397
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
17398
|
+
#
|
|
17399
|
+
# @example Request syntax with placeholder values
|
|
17400
|
+
#
|
|
17401
|
+
# resp = client.list_test_cases({
|
|
17402
|
+
# instance_id: "InstanceId", # required
|
|
17403
|
+
# next_token: "NextToken",
|
|
17404
|
+
# max_results: 1,
|
|
17405
|
+
# })
|
|
17406
|
+
#
|
|
17407
|
+
# @example Response structure
|
|
17408
|
+
#
|
|
17409
|
+
# resp.test_case_summary_list #=> Array
|
|
17410
|
+
# resp.test_case_summary_list[0].id #=> String
|
|
17411
|
+
# resp.test_case_summary_list[0].arn #=> String
|
|
17412
|
+
# resp.test_case_summary_list[0].name #=> String
|
|
17413
|
+
# resp.test_case_summary_list[0].status #=> String, one of "PUBLISHED", "SAVED"
|
|
17414
|
+
# resp.test_case_summary_list[0].last_modified_time #=> Time
|
|
17415
|
+
# resp.test_case_summary_list[0].last_modified_region #=> String
|
|
17416
|
+
# resp.next_token #=> String
|
|
17417
|
+
#
|
|
17418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTestCases AWS API Documentation
|
|
17419
|
+
#
|
|
17420
|
+
# @overload list_test_cases(params = {})
|
|
17421
|
+
# @param [Hash] params ({})
|
|
17422
|
+
def list_test_cases(params = {}, options = {})
|
|
17423
|
+
req = build_request(:list_test_cases, params)
|
|
17424
|
+
req.send_request(options)
|
|
17425
|
+
end
|
|
17426
|
+
|
|
17042
17427
|
# Lists traffic distribution group users.
|
|
17043
17428
|
#
|
|
17044
17429
|
# @option params [required, String] :traffic_distribution_group_id
|
|
@@ -20153,6 +20538,114 @@ module Aws::Connect
|
|
|
20153
20538
|
req.send_request(options)
|
|
20154
20539
|
end
|
|
20155
20540
|
|
|
20541
|
+
# Searches for test cases in the specified Amazon Connect instance, with
|
|
20542
|
+
# optional filtering.
|
|
20543
|
+
#
|
|
20544
|
+
# @option params [required, String] :instance_id
|
|
20545
|
+
# The identifier of the Amazon Connect instance. You can find the
|
|
20546
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
20547
|
+
#
|
|
20548
|
+
# @option params [String] :next_token
|
|
20549
|
+
# The token for the next set of results. Use the value returned in the
|
|
20550
|
+
# previous response in the next request to retrieve the next set of
|
|
20551
|
+
# results.
|
|
20552
|
+
#
|
|
20553
|
+
# @option params [Integer] :max_results
|
|
20554
|
+
# The maximum number of results to return per page.
|
|
20555
|
+
#
|
|
20556
|
+
# @option params [Types::TestCaseSearchFilter] :search_filter
|
|
20557
|
+
# Filters to be applied to search results.
|
|
20558
|
+
#
|
|
20559
|
+
# @option params [Types::TestCaseSearchCriteria] :search_criteria
|
|
20560
|
+
# The search criteria to be used to return test cases.
|
|
20561
|
+
#
|
|
20562
|
+
# @return [Types::SearchTestCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
20563
|
+
#
|
|
20564
|
+
# * {Types::SearchTestCasesResponse#test_cases #test_cases} => Array<Types::TestCase>
|
|
20565
|
+
# * {Types::SearchTestCasesResponse#next_token #next_token} => String
|
|
20566
|
+
# * {Types::SearchTestCasesResponse#approximate_total_count #approximate_total_count} => Integer
|
|
20567
|
+
#
|
|
20568
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
20569
|
+
#
|
|
20570
|
+
# @example Request syntax with placeholder values
|
|
20571
|
+
#
|
|
20572
|
+
# resp = client.search_test_cases({
|
|
20573
|
+
# instance_id: "InstanceIdOrArn", # required
|
|
20574
|
+
# next_token: "NextToken2500",
|
|
20575
|
+
# max_results: 1,
|
|
20576
|
+
# search_filter: {
|
|
20577
|
+
# tag_filter: {
|
|
20578
|
+
# or_conditions: [
|
|
20579
|
+
# [
|
|
20580
|
+
# {
|
|
20581
|
+
# tag_key: "String",
|
|
20582
|
+
# tag_value: "String",
|
|
20583
|
+
# },
|
|
20584
|
+
# ],
|
|
20585
|
+
# ],
|
|
20586
|
+
# and_conditions: [
|
|
20587
|
+
# {
|
|
20588
|
+
# tag_key: "String",
|
|
20589
|
+
# tag_value: "String",
|
|
20590
|
+
# },
|
|
20591
|
+
# ],
|
|
20592
|
+
# tag_condition: {
|
|
20593
|
+
# tag_key: "String",
|
|
20594
|
+
# tag_value: "String",
|
|
20595
|
+
# },
|
|
20596
|
+
# },
|
|
20597
|
+
# },
|
|
20598
|
+
# search_criteria: {
|
|
20599
|
+
# or_conditions: [
|
|
20600
|
+
# {
|
|
20601
|
+
# # recursive TestCaseSearchCriteria
|
|
20602
|
+
# },
|
|
20603
|
+
# ],
|
|
20604
|
+
# and_conditions: [
|
|
20605
|
+
# {
|
|
20606
|
+
# # recursive TestCaseSearchCriteria
|
|
20607
|
+
# },
|
|
20608
|
+
# ],
|
|
20609
|
+
# string_condition: {
|
|
20610
|
+
# field_name: "String",
|
|
20611
|
+
# value: "String",
|
|
20612
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
20613
|
+
# },
|
|
20614
|
+
# status_condition: "PUBLISHED", # accepts PUBLISHED, SAVED
|
|
20615
|
+
# },
|
|
20616
|
+
# })
|
|
20617
|
+
#
|
|
20618
|
+
# @example Response structure
|
|
20619
|
+
#
|
|
20620
|
+
# resp.test_cases #=> Array
|
|
20621
|
+
# resp.test_cases[0].arn #=> String
|
|
20622
|
+
# resp.test_cases[0].id #=> String
|
|
20623
|
+
# resp.test_cases[0].name #=> String
|
|
20624
|
+
# resp.test_cases[0].content #=> String
|
|
20625
|
+
# resp.test_cases[0].entry_point.type #=> String, one of "VOICE_CALL"
|
|
20626
|
+
# resp.test_cases[0].entry_point.voice_call_entry_point_parameters.source_phone_number #=> String
|
|
20627
|
+
# resp.test_cases[0].entry_point.voice_call_entry_point_parameters.destination_phone_number #=> String
|
|
20628
|
+
# resp.test_cases[0].entry_point.voice_call_entry_point_parameters.flow_id #=> String
|
|
20629
|
+
# resp.test_cases[0].initialization_data #=> String
|
|
20630
|
+
# resp.test_cases[0].description #=> String
|
|
20631
|
+
# resp.test_cases[0].status #=> String, one of "PUBLISHED", "SAVED"
|
|
20632
|
+
# resp.test_cases[0].last_modified_time #=> Time
|
|
20633
|
+
# resp.test_cases[0].last_modified_region #=> String
|
|
20634
|
+
# resp.test_cases[0].tags #=> Hash
|
|
20635
|
+
# resp.test_cases[0].tags["TagKey"] #=> String
|
|
20636
|
+
# resp.test_cases[0].test_case_sha_256 #=> String
|
|
20637
|
+
# resp.next_token #=> String
|
|
20638
|
+
# resp.approximate_total_count #=> Integer
|
|
20639
|
+
#
|
|
20640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchTestCases AWS API Documentation
|
|
20641
|
+
#
|
|
20642
|
+
# @overload search_test_cases(params = {})
|
|
20643
|
+
# @param [Hash] params ({})
|
|
20644
|
+
def search_test_cases(params = {}, options = {})
|
|
20645
|
+
req = build_request(:search_test_cases, params)
|
|
20646
|
+
req.send_request(options)
|
|
20647
|
+
end
|
|
20648
|
+
|
|
20156
20649
|
# Searches UserHierarchyGroups in an Amazon Connect instance, with
|
|
20157
20650
|
# optional filtering.
|
|
20158
20651
|
#
|
|
@@ -22641,6 +23134,53 @@ module Aws::Connect
|
|
|
22641
23134
|
req.send_request(options)
|
|
22642
23135
|
end
|
|
22643
23136
|
|
|
23137
|
+
# Starts executing a published test case.
|
|
23138
|
+
#
|
|
23139
|
+
# @option params [required, String] :instance_id
|
|
23140
|
+
# The identifier of the Amazon Connect instance.
|
|
23141
|
+
#
|
|
23142
|
+
# @option params [required, String] :test_case_id
|
|
23143
|
+
# The identifier of the test case to execute.
|
|
23144
|
+
#
|
|
23145
|
+
# @option params [String] :client_token
|
|
23146
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
23147
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
23148
|
+
# SDK populates this field. For more information about idempotency, see
|
|
23149
|
+
# [Making retries safe with idempotent APIs][1].
|
|
23150
|
+
#
|
|
23151
|
+
#
|
|
23152
|
+
#
|
|
23153
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
23154
|
+
#
|
|
23155
|
+
# @return [Types::StartTestCaseExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
23156
|
+
#
|
|
23157
|
+
# * {Types::StartTestCaseExecutionResponse#test_case_execution_id #test_case_execution_id} => String
|
|
23158
|
+
# * {Types::StartTestCaseExecutionResponse#test_case_id #test_case_id} => String
|
|
23159
|
+
# * {Types::StartTestCaseExecutionResponse#status #status} => String
|
|
23160
|
+
#
|
|
23161
|
+
# @example Request syntax with placeholder values
|
|
23162
|
+
#
|
|
23163
|
+
# resp = client.start_test_case_execution({
|
|
23164
|
+
# instance_id: "InstanceId", # required
|
|
23165
|
+
# test_case_id: "TestCaseId", # required
|
|
23166
|
+
# client_token: "ClientToken",
|
|
23167
|
+
# })
|
|
23168
|
+
#
|
|
23169
|
+
# @example Response structure
|
|
23170
|
+
#
|
|
23171
|
+
# resp.test_case_execution_id #=> String
|
|
23172
|
+
# resp.test_case_id #=> String
|
|
23173
|
+
# resp.status #=> String, one of "INITIATED", "PASSED", "FAILED", "IN_PROGRESS", "STOPPED"
|
|
23174
|
+
#
|
|
23175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTestCaseExecution AWS API Documentation
|
|
23176
|
+
#
|
|
23177
|
+
# @overload start_test_case_execution(params = {})
|
|
23178
|
+
# @param [Hash] params ({})
|
|
23179
|
+
def start_test_case_execution(params = {}, options = {})
|
|
23180
|
+
req = build_request(:start_test_case_execution, params)
|
|
23181
|
+
req.send_request(options)
|
|
23182
|
+
end
|
|
23183
|
+
|
|
22644
23184
|
# Places an inbound in-app, web, or video call to a contact, and then
|
|
22645
23185
|
# initiates the flow. It performs the actions in the flow that are
|
|
22646
23186
|
# specified (in ContactFlowId) and present in the Amazon Connect
|
|
@@ -22956,6 +23496,47 @@ module Aws::Connect
|
|
|
22956
23496
|
req.send_request(options)
|
|
22957
23497
|
end
|
|
22958
23498
|
|
|
23499
|
+
# Stops a running test execution.
|
|
23500
|
+
#
|
|
23501
|
+
# @option params [required, String] :instance_id
|
|
23502
|
+
# The identifier of the Amazon Connect instance.
|
|
23503
|
+
#
|
|
23504
|
+
# @option params [required, String] :test_case_execution_id
|
|
23505
|
+
# The identifier of the test case execution to stop.
|
|
23506
|
+
#
|
|
23507
|
+
# @option params [required, String] :test_case_id
|
|
23508
|
+
# The identifier of the test case.
|
|
23509
|
+
#
|
|
23510
|
+
# @option params [String] :client_token
|
|
23511
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
23512
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
23513
|
+
# SDK populates this field. For more information about idempotency, see
|
|
23514
|
+
# [Making retries safe with idempotent APIs][1].
|
|
23515
|
+
#
|
|
23516
|
+
#
|
|
23517
|
+
#
|
|
23518
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
23519
|
+
#
|
|
23520
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
23521
|
+
#
|
|
23522
|
+
# @example Request syntax with placeholder values
|
|
23523
|
+
#
|
|
23524
|
+
# resp = client.stop_test_case_execution({
|
|
23525
|
+
# instance_id: "InstanceId", # required
|
|
23526
|
+
# test_case_execution_id: "TestCaseExecutionId", # required
|
|
23527
|
+
# test_case_id: "TestCaseId", # required
|
|
23528
|
+
# client_token: "ClientToken",
|
|
23529
|
+
# })
|
|
23530
|
+
#
|
|
23531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopTestCaseExecution AWS API Documentation
|
|
23532
|
+
#
|
|
23533
|
+
# @overload stop_test_case_execution(params = {})
|
|
23534
|
+
# @param [Hash] params ({})
|
|
23535
|
+
def stop_test_case_execution(params = {}, options = {})
|
|
23536
|
+
req = build_request(:stop_test_case_execution, params)
|
|
23537
|
+
req.send_request(options)
|
|
23538
|
+
end
|
|
23539
|
+
|
|
22959
23540
|
# Submits a contact evaluation in the specified Amazon Connect instance.
|
|
22960
23541
|
# Answers included in the request are merged with existing answers for
|
|
22961
23542
|
# the given evaluation. If no answers or notes are passed, the
|
|
@@ -26393,6 +26974,76 @@ module Aws::Connect
|
|
|
26393
26974
|
req.send_request(options)
|
|
26394
26975
|
end
|
|
26395
26976
|
|
|
26977
|
+
# Updates any of the metadata for a test case, such as the name,
|
|
26978
|
+
# description, and status or content of an existing test case. This API
|
|
26979
|
+
# doesn't allow customers to update the tags of the test case resource
|
|
26980
|
+
# for the specified Amazon Connect instance.
|
|
26981
|
+
#
|
|
26982
|
+
# @option params [required, String] :instance_id
|
|
26983
|
+
# The identifier of the Amazon Connect instance.
|
|
26984
|
+
#
|
|
26985
|
+
# @option params [required, String] :test_case_id
|
|
26986
|
+
# The identifier of the test case to update.
|
|
26987
|
+
#
|
|
26988
|
+
# @option params [String] :content
|
|
26989
|
+
# The JSON string that represents the content of the test.
|
|
26990
|
+
#
|
|
26991
|
+
# @option params [Types::TestCaseEntryPoint] :entry_point
|
|
26992
|
+
# Defines the starting point for your test.
|
|
26993
|
+
#
|
|
26994
|
+
# @option params [String] :initialization_data
|
|
26995
|
+
# Defines the test attributes for precise data representation.
|
|
26996
|
+
#
|
|
26997
|
+
# @option params [String] :name
|
|
26998
|
+
# The name of the test case.
|
|
26999
|
+
#
|
|
27000
|
+
# @option params [String] :description
|
|
27001
|
+
# The description of the test case.
|
|
27002
|
+
#
|
|
27003
|
+
# @option params [String] :status
|
|
27004
|
+
# Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED
|
|
27005
|
+
# status will initiate validation on the content. The SAVED status does
|
|
27006
|
+
# not initiate validation of the content.
|
|
27007
|
+
#
|
|
27008
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified_time
|
|
27009
|
+
# The time at which the resource was last modified.
|
|
27010
|
+
#
|
|
27011
|
+
# @option params [String] :last_modified_region
|
|
27012
|
+
# The region in which the resource was last modified
|
|
27013
|
+
#
|
|
27014
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
27015
|
+
#
|
|
27016
|
+
# @example Request syntax with placeholder values
|
|
27017
|
+
#
|
|
27018
|
+
# resp = client.update_test_case({
|
|
27019
|
+
# instance_id: "InstanceIdOrArn", # required
|
|
27020
|
+
# test_case_id: "TestCaseId", # required
|
|
27021
|
+
# content: "TestCaseContent",
|
|
27022
|
+
# entry_point: {
|
|
27023
|
+
# type: "VOICE_CALL", # accepts VOICE_CALL
|
|
27024
|
+
# voice_call_entry_point_parameters: {
|
|
27025
|
+
# source_phone_number: "PhoneNumber",
|
|
27026
|
+
# destination_phone_number: "PhoneNumber",
|
|
27027
|
+
# flow_id: "ContactFlowId",
|
|
27028
|
+
# },
|
|
27029
|
+
# },
|
|
27030
|
+
# initialization_data: "TestCaseInitializationData",
|
|
27031
|
+
# name: "TestCaseName",
|
|
27032
|
+
# description: "TestCaseDescription",
|
|
27033
|
+
# status: "PUBLISHED", # accepts PUBLISHED, SAVED
|
|
27034
|
+
# last_modified_time: Time.now,
|
|
27035
|
+
# last_modified_region: "RegionName",
|
|
27036
|
+
# })
|
|
27037
|
+
#
|
|
27038
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTestCase AWS API Documentation
|
|
27039
|
+
#
|
|
27040
|
+
# @overload update_test_case(params = {})
|
|
27041
|
+
# @param [Hash] params ({})
|
|
27042
|
+
def update_test_case(params = {}, options = {})
|
|
27043
|
+
req = build_request(:update_test_case, params)
|
|
27044
|
+
req.send_request(options)
|
|
27045
|
+
end
|
|
27046
|
+
|
|
26396
27047
|
# Updates the traffic distribution for a given traffic distribution
|
|
26397
27048
|
# group.
|
|
26398
27049
|
#
|
|
@@ -27173,7 +27824,7 @@ module Aws::Connect
|
|
|
27173
27824
|
tracer: tracer
|
|
27174
27825
|
)
|
|
27175
27826
|
context[:gem_name] = 'aws-sdk-connect'
|
|
27176
|
-
context[:gem_version] = '1.
|
|
27827
|
+
context[:gem_version] = '1.237.0'
|
|
27177
27828
|
Seahorse::Client::Request.new(handlers, context)
|
|
27178
27829
|
end
|
|
27179
27830
|
|