GetTestCaseExecutionSummary - Amazon Connect

GetTestCaseExecutionSummary

Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.

Request Syntax

GET /test-cases/InstanceId/TestCaseId/TestCaseExecutionId/summary 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 100.

Required: Yes

TestCaseExecutionId

The identifier of the test case execution.

Length Constraints: Maximum length of 500.

Required: Yes

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 { "EndTime": number, "ObservationSummary": { "ObservationsFailed": number, "ObservationsPassed": number, "TotalObservations": number }, "StartTime": number, "Status": "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.

EndTime

The timestamp when the test case execution ended.

Type: Timestamp

ObservationSummary

Summary statistics for the test case execution.

Type: ObservationSummary object

StartTime

The timestamp when the test case execution started.

Type: Timestamp

Status

The status of the test case execution.

Type: String

Valid Values: INITIATED | PASSED | FAILED | IN_PROGRESS | STOPPED

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: