Skip to content

list_test_case_executions async

list_test_case_executions(
    instance_id: InstanceId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    test_case_id: Optional[TestCaseId] = None,
    test_case_name: Optional[TestCaseName] = None,
    start_time: Optional[EpochMilliseconds] = None,
    end_time: Optional[EpochMilliseconds] = None,
    status: Optional[TestCaseExecutionStatus] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResult100] = None,
) -> ListTestCaseExecutionsResponse

Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.

Parameters:

  • instance_id (InstanceId) –

    The identifier of the Amazon Connect instance.

  • test_case_id (Optional[TestCaseId], default: None ) –

    Filter executions by test case identifier.

  • test_case_name (Optional[TestCaseName], default: None ) –

    Filter executions by test case name.

  • start_time (Optional[EpochMilliseconds], default: None ) –

    Filter executions that started after this time.

  • end_time (Optional[EpochMilliseconds], default: None ) –

    Filter executions that started before this time.

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

    Filter executions by status.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • max_results (Optional[MaxResult100], default: None ) –

    The maximum number of results to return per page.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def list_test_case_executions(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    test_case_id: Optional["capo_connect.types.test_case_id.TestCaseId"] = None,
    test_case_name: Optional[
        "capo_connect.types.test_case_name.TestCaseName"
    ] = None,
    start_time: Optional[
        "capo_connect.types.epoch_milliseconds.EpochMilliseconds"
    ] = None,
    end_time: Optional[
        "capo_connect.types.epoch_milliseconds.EpochMilliseconds"
    ] = None,
    status: Optional[
        "capo_connect.types.test_case_execution_status.TestCaseExecutionStatus"
    ] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
    max_results: Optional["capo_connect.types.max_result100.MaxResult100"] = None,
) -> "capo_connect.types.list_test_case_executions_response.ListTestCaseExecutionsResponse":
    """<p>Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.</p>

    Args:
        instance_id: <p>The identifier of the Amazon Connect instance.</p>
        test_case_id: <p>Filter executions by test case identifier.</p>
        test_case_name: <p>Filter executions by test case name.</p>
        start_time: <p>Filter executions that started after this time.</p>
        end_time: <p>Filter executions that started before this time.</p>
        status: <p>Filter executions by status.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
        max_results: <p>The maximum number of results to return per page.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.list_test_case_executions_request.ListTestCaseExecutionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.list_test_case_executions_response.ListTestCaseExecutionsResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_test_case_executions

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.list_test_case_executions.async_list_test_case_executions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTestCaseExecutions")
    )
    input_: capo_connect.types.list_test_case_executions_request.ListTestCaseExecutionsRequest = {
        "instance_id": instance_id
    }
    if test_case_id is not None:
        input_["test_case_id"] = test_case_id
    if test_case_name is not None:
        input_["test_case_name"] = test_case_name
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if status is not None:
        input_["status"] = status
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output