Skip to content

describe_test_case

describe_test_case(
    instance_id: InstanceIdOrArn,
    test_case_id: TestCaseId,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    status: Optional[TestCaseStatus] = None,
) -> DescribeTestCaseResponse

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

Parameters:

  • instance_id (InstanceIdOrArn) –

    The identifier of the Amazon Connect instance.

  • test_case_id (TestCaseId) –

    The identifier of the test case.

  • status (Optional[TestCaseStatus], default: None ) –

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

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def describe_test_case(
    self,
    instance_id: "capo_connect.types.instance_id_or_arn.InstanceIdOrArn",
    test_case_id: "capo_connect.types.test_case_id.TestCaseId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    status: Optional["capo_connect.types.test_case_status.TestCaseStatus"] = None,
) -> "capo_connect.types.describe_test_case_response.DescribeTestCaseResponse":
    """<p>Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.</p>

    Args:
        instance_id: <p>The identifier of the Amazon Connect instance.</p>
        test_case_id: <p>The identifier of the test case.</p>
        status: <p>The status of the test case version to retrieve. If not specified, returns the published version if available, otherwise returns the saved version.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.describe_test_case_request.DescribeTestCaseRequest]",
    ) -> OperationResponse[
        "capo_connect.types.describe_test_case_response.DescribeTestCaseResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_test_case

        output, http_response = (
            capo_connect._operations.amazon_connect_service.describe_test_case.describe_test_case(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTestCase")
    )
    input_: capo_connect.types.describe_test_case_request.DescribeTestCaseRequest = {
        "instance_id": instance_id,
        "test_case_id": test_case_id,
    }
    if status is not None:
        input_["status"] = status

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output