list_suite_runs `async` ¶

list_suite_runs(
    *,
    config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
    suite_definition_id: Optional[UUID] = None,
    suite_definition_version: Optional[SuiteDefinitionVersion] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[Token] = None,
) -> ListSuiteRunsResponse

Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

Requires permission to access the ListSuiteRuns action.

Parameters:

suite_definition_id (Optional[UUID], default: None ) –

Lists the test suite runs of the specified test suite based on suite definition ID.
suite_definition_version (Optional[SuiteDefinitionVersion], default: None ) –

Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return at once.
next_token (Optional[Token], default: None ) –

A token to retrieve the next set of results.

Raises:

InternalServerException –

Sends an Internal Failure exception.
ValidationException –

Sends a validation exception.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotdeviceadvisor/_services/async_iot_device_advisor.py

async def list_suite_runs(
    self,
    *,
    config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
    suite_definition_id: Optional["capo_iotdeviceadvisor.types.uuid.UUID"] = None,
    suite_definition_version: Optional[
        "capo_iotdeviceadvisor.types.suite_definition_version.SuiteDefinitionVersion"
    ] = None,
    max_results: Optional[
        "capo_iotdeviceadvisor.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_iotdeviceadvisor.types.token.Token"] = None,
) -> "capo_iotdeviceadvisor.types.list_suite_runs_response.ListSuiteRunsResponse":
    """<p>Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteRuns</a> action.</p>

    Args:
        suite_definition_id: <p>Lists the test suite runs of the specified test suite based on suite definition ID.</p>
        suite_definition_version: <p>Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of the specified test suite based on suite definition version.</p>
        max_results: <p>The maximum number of results to return at once.</p>
        next_token: <p>A token to retrieve the next set of results.</p>

    Raises:
        capo_iotdeviceadvisor.errors.internal_server_exception.InternalServerException: <p>Sends an Internal Failure exception.</p>
        capo_iotdeviceadvisor.errors.validation_exception.ValidationException: <p>Sends a validation exception.</p>
        capo_iotdeviceadvisor.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotdeviceadvisor.types.list_suite_runs_request.ListSuiteRunsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotdeviceadvisor.types.list_suite_runs_response.ListSuiteRunsResponse"
    ]:
        import capo_iotdeviceadvisor._operations.iot_senate_service.list_suite_runs

        (
            output,
            http_response,
        ) = await capo_iotdeviceadvisor._operations.iot_senate_service.list_suite_runs.async_list_suite_runs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSuiteRuns")
    )
    input_: capo_iotdeviceadvisor.types.list_suite_runs_request.ListSuiteRunsRequest = {}
    if suite_definition_id is not None:
        input_["suite_definition_id"] = suite_definition_id
    if suite_definition_version is not None:
        input_["suite_definition_version"] = suite_definition_version
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_suite_runs async ¶

list_suite_runs `async` ¶