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

DescribeTestCase

Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.

Request Syntax


GET /test-cases/InstanceId/TestCaseId?status=Status HTTP/1.1

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

Status

The status of the test case version to retrieve. If not specified, returns the published version if available, otherwise returns the saved version.

Valid Values: PUBLISHED | SAVED

TestCaseId

The identifier of the test case.

Length Constraints: Maximum length of 500.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "TestCase": { 
      "Arn": "string",
      "Content": "string",
      "Description": "string",
      "EntryPoint": { 
         "Type": "string",
         "VoiceCallEntryPointParameters": { 
            "DestinationPhoneNumber": "string",
            "FlowId": "string",
            "SourcePhoneNumber": "string"
         }
      },
      "Id": "string",
      "InitializationData": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "TestCaseSha256": "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.

TestCase

The test case object containing all test case information.

Type: TestCase object

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

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

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429