Skip to content

list_test_grid_sessions async

list_test_grid_sessions(
    project_arn: DeviceFarmArn,
    *,
    config_overrides: Optional[AsyncDeviceFarmClientConfig] = None,
    status: Optional[TestGridSessionStatus] = None,
    creation_time_after: Optional[DateTime] = None,
    creation_time_before: Optional[DateTime] = None,
    end_time_after: Optional[DateTime] = None,
    end_time_before: Optional[DateTime] = None,
    max_result: Optional[MaxPageSize] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListTestGridSessionsResult

Retrieves a list of sessions for a TestGridProject.

Parameters:

Raises:

Source code in docs_src/capo_device_farm/_services/async_device_farm.py
async def list_test_grid_sessions(
    self,
    project_arn: "capo_device_farm.types.device_farm_arn.DeviceFarmArn",
    *,
    config_overrides: Optional[AsyncDeviceFarmClientConfig] = None,
    status: Optional[
        "capo_device_farm.types.test_grid_session_status.TestGridSessionStatus"
    ] = None,
    creation_time_after: Optional[
        "capo_device_farm.types.date_time.DateTime"
    ] = None,
    creation_time_before: Optional[
        "capo_device_farm.types.date_time.DateTime"
    ] = None,
    end_time_after: Optional["capo_device_farm.types.date_time.DateTime"] = None,
    end_time_before: Optional["capo_device_farm.types.date_time.DateTime"] = None,
    max_result: Optional["capo_device_farm.types.max_page_size.MaxPageSize"] = None,
    next_token: Optional[
        "capo_device_farm.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_device_farm.types.list_test_grid_sessions_result.ListTestGridSessionsResult":
    """<p>Retrieves a list of sessions for a <a>TestGridProject</a>.</p>

    Args:
        project_arn: <p>ARN of a <a>TestGridProject</a>.</p>
        status: <p>Return only sessions in this state.</p>
        creation_time_after: <p>Return only sessions created after this time.</p>
        creation_time_before: <p>Return only sessions created before this time.</p>
        end_time_after: <p>Return only sessions that ended after this time.</p>
        end_time_before: <p>Return only sessions that ended before this time.</p>
        max_result: <p>Return only this many results at a time.</p>
        next_token: <p>Pagination token.</p>

    Raises:
        capo_device_farm.errors.argument_exception.ArgumentException: <p>An invalid argument was specified.</p>
        capo_device_farm.errors.internal_service_exception.InternalServiceException: <p>An internal exception was raised in the service. Contact <a href="mailto:[email protected]">[email protected]</a> if you see this error. </p>
        capo_device_farm.errors.not_found_exception.NotFoundException: <p>The specified entity was not found.</p>
        capo_device_farm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_device_farm.types.list_test_grid_sessions_request.ListTestGridSessionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_device_farm.types.list_test_grid_sessions_result.ListTestGridSessionsResult"
    ]:
        import capo_device_farm._operations.device_farm_20150623.list_test_grid_sessions

        (
            output,
            http_response,
        ) = await capo_device_farm._operations.device_farm_20150623.list_test_grid_sessions.async_list_test_grid_sessions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTestGridSessions")
    )
    input_: capo_device_farm.types.list_test_grid_sessions_request.ListTestGridSessionsRequest = {
        "project_arn": project_arn
    }
    if status is not None:
        input_["status"] = status
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if end_time_after is not None:
        input_["end_time_after"] = end_time_after
    if end_time_before is not None:
        input_["end_time_before"] = end_time_before
    if max_result is not None:
        input_["max_result"] = max_result
    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