Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateTestCase

Creates a test case with its content and metadata for the specified Amazon Connect instance.

Request Syntax


PUT /test-cases/InstanceId HTTP/1.1
x-amz-resource-id: TestCaseId
x-amz-last-modified-time: LastModifiedTime
x-amz-last-modified-region: LastModifiedRegion
Content-type: application/json

{
   "Content": "string",
   "Description": "string",
   "EntryPoint": { 
      "Type": "string",
      "VoiceCallEntryPointParameters": { 
         "DestinationPhoneNumber": "string",
         "FlowId": "string",
         "SourcePhoneNumber": "string"
      }
   },
   "InitializationData": "string",
   "Name": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance.

Length Constraints: Minimum length of 1. Maximum length of 250.

Pattern: ^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

LastModifiedRegion

The region in which the resource was last modified

Pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

LastModifiedTime

The time at which the resource was last modified.

TestCaseId

Id of the test case if you want to create it in a replica region using Amazon Connect Global Resiliency

Length Constraints: Maximum length of 500.

Request Body

The request accepts the following data in JSON format.

Content

The JSON string that represents the content of the test.

Type: String

Required: Yes

Description

The description of the test.

Type: String

Required: No

EntryPoint

Defines the starting point for your test.

Type: TestCaseEntryPoint object

Required: No

InitializationData

Defines the initial custom attributes for your test.

Type: String

Required: No

Name

The name of the test.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Status

Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.

Type: String

Valid Values: PUBLISHED | SAVED

Required: No

Tags

The tags used to organize, track, or control access for this resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "TestCaseArn": "string",
   "TestCaseId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TestCaseArn

The Amazon Resource Name (ARN) of the test.

Type: String

TestCaseId

The identifier of the test.

Type: String

Length Constraints: Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

InvalidTestCaseException

The test is not valid.

Problems: The problems with the test. Please fix before trying again.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

Message: The message about the limit.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

Reason: The reason for the exception.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429