list_samples `async` ¶

list_samples(
    arn: AmazonResourceName,
    *,
    config_overrides: Optional[AsyncDeviceFarmClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListSamplesResult

Gets information about samples, given an AWS Device Farm job ARN.

Device Farm does not support performance data samples during test executions.

Parameters:

arn (AmazonResourceName) –

The Amazon Resource Name (ARN) of the job used to list samples.
next_token (Optional[PaginationToken], default: None ) –

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Raises:

ArgumentException –

An invalid argument was specified.
LimitExceededException –

A limit was exceeded.
NotFoundException –

The specified entity was not found.
ServiceAccountException –

There was a problem with the service account.
UnknownServiceError –

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

Examples:

To get information about samples The following example returns information about samples, given a specific Device Farm project.

>>> await client.list_samples(arn='arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', next_token='RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE')

Source code in docs_src/capo_device_farm/_services/async_device_farm.py

async def list_samples(
    self,
    arn: "capo_device_farm.types.amazon_resource_name.AmazonResourceName",
    *,
    config_overrides: Optional[AsyncDeviceFarmClientConfig] = None,
    next_token: Optional[
        "capo_device_farm.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_device_farm.types.list_samples_result.ListSamplesResult":
    """<p>Gets information about samples, given an AWS Device Farm job ARN.</p> <important> <p>Device Farm does not support performance data samples during test executions.</p> </important>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the job used to list samples.</p>
        next_token: <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>

    Raises:
        capo_device_farm.errors.argument_exception.ArgumentException: <p>An invalid argument was specified.</p>
        capo_device_farm.errors.limit_exceeded_exception.LimitExceededException: <p>A limit was exceeded.</p>
        capo_device_farm.errors.not_found_exception.NotFoundException: <p>The specified entity was not found.</p>
        capo_device_farm.errors.service_account_exception.ServiceAccountException: <p>There was a problem with the service account.</p>
        capo_device_farm.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get information about samples
        The following example returns information about samples, given a specific Device Farm project.

        >>> await client.list_samples(arn='arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', next_token='RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_device_farm.types.list_samples_request.ListSamplesRequest]",
    ) -> AsyncOperationResponse[
        "capo_device_farm.types.list_samples_result.ListSamplesResult"
    ]:
        import capo_device_farm._operations.device_farm_20150623.list_samples

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSamples")
    )
    input_: capo_device_farm.types.list_samples_request.ListSamplesRequest = {
        "arn": arn
    }
    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_samples async ¶

list_samples `async` ¶