DeviceFarmClient

Index > DeviceFarm > DeviceFarmClient

Auto-generated documentation for DeviceFarm type annotations stubs module mypy-boto3-devicefarm.

DeviceFarmClient

Type annotations and code completion for boto3.client("devicefarm"). boto3 documentation

# DeviceFarmClient usage example

from boto3.session import Session
from mypy_boto3_devicefarm.client import DeviceFarmClient

def get_devicefarm_client() -> DeviceFarmClient:
    return Session().client("devicefarm")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("devicefarm").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("devicefarm")

try:
    do_something(client)
except (
    client.exceptions.ArgumentException,
    client.exceptions.CannotDeleteException,
    client.exceptions.ClientError,
    client.exceptions.IdempotencyException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidOperationException,
    client.exceptions.LimitExceededException,
    client.exceptions.NotEligibleException,
    client.exceptions.NotFoundException,
    client.exceptions.ServiceAccountException,
    client.exceptions.TagOperationException,
    client.exceptions.TagPolicyException,
    client.exceptions.TooManyTagsException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_devicefarm.client import Exceptions

def handle_error(exc: Exceptions.ArgumentException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("devicefarm").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("devicefarm").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_device_pool

Creates a device pool.

Type annotations and code completion for boto3.client("devicefarm").create_device_pool method. boto3 documentation

# create_device_pool method definition

def create_device_pool(
    self,
    *,
    projectArn: str,
    name: str,
    rules: Sequence[RuleTypeDef],  # (1)
    description: str = ...,
    maxDevices: int = ...,
) -> CreateDevicePoolResultTypeDef:  # (2)
    ...

1. See RuleTypeDef
2. See CreateDevicePoolResultTypeDef

# create_device_pool method usage example with argument unpacking

kwargs: CreateDevicePoolRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
    "name": ...,
    "rules": ...,
}

parent.create_device_pool(**kwargs)

1. See CreateDevicePoolRequestRequestTypeDef

create_instance_profile

Creates a profile that can be applied to one or more private fleet device instances.

Type annotations and code completion for boto3.client("devicefarm").create_instance_profile method. boto3 documentation

# create_instance_profile method definition

def create_instance_profile(
    self,
    *,
    name: str,
    description: str = ...,
    packageCleanup: bool = ...,
    excludeAppPackagesFromCleanup: Sequence[str] = ...,
    rebootAfterUse: bool = ...,
) -> CreateInstanceProfileResultTypeDef:  # (1)
    ...

1. See CreateInstanceProfileResultTypeDef

# create_instance_profile method usage example with argument unpacking

kwargs: CreateInstanceProfileRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_instance_profile(**kwargs)

1. See CreateInstanceProfileRequestRequestTypeDef

create_network_profile

Creates a network profile.

Type annotations and code completion for boto3.client("devicefarm").create_network_profile method. boto3 documentation

# create_network_profile method definition

def create_network_profile(
    self,
    *,
    projectArn: str,
    name: str,
    description: str = ...,
    type: NetworkProfileTypeType = ...,  # (1)
    uplinkBandwidthBits: int = ...,
    downlinkBandwidthBits: int = ...,
    uplinkDelayMs: int = ...,
    downlinkDelayMs: int = ...,
    uplinkJitterMs: int = ...,
    downlinkJitterMs: int = ...,
    uplinkLossPercent: int = ...,
    downlinkLossPercent: int = ...,
) -> CreateNetworkProfileResultTypeDef:  # (2)
    ...

1. See NetworkProfileTypeType
2. See CreateNetworkProfileResultTypeDef

# create_network_profile method usage example with argument unpacking

kwargs: CreateNetworkProfileRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
    "name": ...,
}

parent.create_network_profile(**kwargs)

1. See CreateNetworkProfileRequestRequestTypeDef

create_project

Creates a project.

Type annotations and code completion for boto3.client("devicefarm").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    name: str,
    defaultJobTimeoutMinutes: int = ...,
    vpcConfig: VpcConfigTypeDef = ...,  # (1)
) -> CreateProjectResultTypeDef:  # (2)
    ...

1. See VpcConfigTypeDef
2. See CreateProjectResultTypeDef

# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_project(**kwargs)

1. See CreateProjectRequestRequestTypeDef

create_remote_access_session

Specifies and starts a remote access session.

Type annotations and code completion for boto3.client("devicefarm").create_remote_access_session method. boto3 documentation

# create_remote_access_session method definition

def create_remote_access_session(
    self,
    *,
    projectArn: str,
    deviceArn: str,
    instanceArn: str = ...,
    sshPublicKey: str = ...,
    remoteDebugEnabled: bool = ...,
    remoteRecordEnabled: bool = ...,
    remoteRecordAppArn: str = ...,
    name: str = ...,
    clientId: str = ...,
    configuration: CreateRemoteAccessSessionConfigurationTypeDef = ...,  # (1)
    interactionMode: InteractionModeType = ...,  # (2)
    skipAppResign: bool = ...,
) -> CreateRemoteAccessSessionResultTypeDef:  # (3)
    ...

1. See CreateRemoteAccessSessionConfigurationTypeDef
2. See InteractionModeType
3. See CreateRemoteAccessSessionResultTypeDef

# create_remote_access_session method usage example with argument unpacking

kwargs: CreateRemoteAccessSessionRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
    "deviceArn": ...,
}

parent.create_remote_access_session(**kwargs)

1. See CreateRemoteAccessSessionRequestRequestTypeDef

create_test_grid_project

Creates a Selenium testing project.

Type annotations and code completion for boto3.client("devicefarm").create_test_grid_project method. boto3 documentation

# create_test_grid_project method definition

def create_test_grid_project(
    self,
    *,
    name: str,
    description: str = ...,
    vpcConfig: TestGridVpcConfigTypeDef = ...,  # (1)
) -> CreateTestGridProjectResultTypeDef:  # (2)
    ...

1. See TestGridVpcConfigTypeDef
2. See CreateTestGridProjectResultTypeDef

# create_test_grid_project method usage example with argument unpacking

kwargs: CreateTestGridProjectRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_test_grid_project(**kwargs)

1. See CreateTestGridProjectRequestRequestTypeDef

create_test_grid_url

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.

Type annotations and code completion for boto3.client("devicefarm").create_test_grid_url method. boto3 documentation

# create_test_grid_url method definition

def create_test_grid_url(
    self,
    *,
    projectArn: str,
    expiresInSeconds: int,
) -> CreateTestGridUrlResultTypeDef:  # (1)
    ...

1. See CreateTestGridUrlResultTypeDef

# create_test_grid_url method usage example with argument unpacking

kwargs: CreateTestGridUrlRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
    "expiresInSeconds": ...,
}

parent.create_test_grid_url(**kwargs)

1. See CreateTestGridUrlRequestRequestTypeDef

create_upload

Uploads an app or test scripts.

Type annotations and code completion for boto3.client("devicefarm").create_upload method. boto3 documentation

# create_upload method definition

def create_upload(
    self,
    *,
    projectArn: str,
    name: str,
    type: UploadTypeType,  # (1)
    contentType: str = ...,
) -> CreateUploadResultTypeDef:  # (2)
    ...

1. See UploadTypeType
2. See CreateUploadResultTypeDef

# create_upload method usage example with argument unpacking

kwargs: CreateUploadRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
    "name": ...,
    "type": ...,
}

parent.create_upload(**kwargs)

1. See CreateUploadRequestRequestTypeDef

create_vpce_configuration

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

Type annotations and code completion for boto3.client("devicefarm").create_vpce_configuration method. boto3 documentation

# create_vpce_configuration method definition

def create_vpce_configuration(
    self,
    *,
    vpceConfigurationName: str,
    vpceServiceName: str,
    serviceDnsName: str,
    vpceConfigurationDescription: str = ...,
) -> CreateVPCEConfigurationResultTypeDef:  # (1)
    ...

1. See CreateVPCEConfigurationResultTypeDef

# create_vpce_configuration method usage example with argument unpacking

kwargs: CreateVPCEConfigurationRequestRequestTypeDef = {  # (1)
    "vpceConfigurationName": ...,
    "vpceServiceName": ...,
    "serviceDnsName": ...,
}

parent.create_vpce_configuration(**kwargs)

1. See CreateVPCEConfigurationRequestRequestTypeDef

delete_device_pool

Deletes a device pool given the pool ARN.

Type annotations and code completion for boto3.client("devicefarm").delete_device_pool method. boto3 documentation

# delete_device_pool method definition

def delete_device_pool(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_device_pool method usage example with argument unpacking

kwargs: DeleteDevicePoolRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_device_pool(**kwargs)

1. See DeleteDevicePoolRequestRequestTypeDef

delete_instance_profile

Deletes a profile that can be applied to one or more private device instances.

Type annotations and code completion for boto3.client("devicefarm").delete_instance_profile method. boto3 documentation

# delete_instance_profile method definition

def delete_instance_profile(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_instance_profile method usage example with argument unpacking

kwargs: DeleteInstanceProfileRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_instance_profile(**kwargs)

1. See DeleteInstanceProfileRequestRequestTypeDef

delete_network_profile

Deletes a network profile.

Type annotations and code completion for boto3.client("devicefarm").delete_network_profile method. boto3 documentation

# delete_network_profile method definition

def delete_network_profile(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_network_profile method usage example with argument unpacking

kwargs: DeleteNetworkProfileRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_network_profile(**kwargs)

1. See DeleteNetworkProfileRequestRequestTypeDef

delete_project

Deletes an AWS Device Farm project, given the project ARN.

Type annotations and code completion for boto3.client("devicefarm").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_project method usage example with argument unpacking

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_project(**kwargs)

1. See DeleteProjectRequestRequestTypeDef

delete_remote_access_session

Deletes a completed remote access session and its results.

Type annotations and code completion for boto3.client("devicefarm").delete_remote_access_session method. boto3 documentation

# delete_remote_access_session method definition

def delete_remote_access_session(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_remote_access_session method usage example with argument unpacking

kwargs: DeleteRemoteAccessSessionRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_remote_access_session(**kwargs)

1. See DeleteRemoteAccessSessionRequestRequestTypeDef

delete_run

Deletes the run, given the run ARN.

Type annotations and code completion for boto3.client("devicefarm").delete_run method. boto3 documentation

# delete_run method definition

def delete_run(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_run method usage example with argument unpacking

kwargs: DeleteRunRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_run(**kwargs)

1. See DeleteRunRequestRequestTypeDef

delete_test_grid_project

Deletes a Selenium testing project and all content generated under it.

Type annotations and code completion for boto3.client("devicefarm").delete_test_grid_project method. boto3 documentation

# delete_test_grid_project method definition

def delete_test_grid_project(
    self,
    *,
    projectArn: str,
) -> Dict[str, Any]:
    ...

# delete_test_grid_project method usage example with argument unpacking

kwargs: DeleteTestGridProjectRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
}

parent.delete_test_grid_project(**kwargs)

1. See DeleteTestGridProjectRequestRequestTypeDef

delete_upload

Deletes an upload given the upload ARN.

Type annotations and code completion for boto3.client("devicefarm").delete_upload method. boto3 documentation

# delete_upload method definition

def delete_upload(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_upload method usage example with argument unpacking

kwargs: DeleteUploadRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_upload(**kwargs)

1. See DeleteUploadRequestRequestTypeDef

delete_vpce_configuration

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

Type annotations and code completion for boto3.client("devicefarm").delete_vpce_configuration method. boto3 documentation

# delete_vpce_configuration method definition

def delete_vpce_configuration(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_vpce_configuration method usage example with argument unpacking

kwargs: DeleteVPCEConfigurationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_vpce_configuration(**kwargs)

1. See DeleteVPCEConfigurationRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("devicefarm").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_account_settings

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.

Type annotations and code completion for boto3.client("devicefarm").get_account_settings method. boto3 documentation

# get_account_settings method definition

def get_account_settings(
    self,
) -> GetAccountSettingsResultTypeDef:  # (1)
    ...

1. See GetAccountSettingsResultTypeDef

get_device

Gets information about a unique device type.

Type annotations and code completion for boto3.client("devicefarm").get_device method. boto3 documentation

# get_device method definition

def get_device(
    self,
    *,
    arn: str,
) -> GetDeviceResultTypeDef:  # (1)
    ...

1. See GetDeviceResultTypeDef

# get_device method usage example with argument unpacking

kwargs: GetDeviceRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_device(**kwargs)

1. See GetDeviceRequestRequestTypeDef

get_device_instance

Returns information about a device instance that belongs to a private device fleet.

Type annotations and code completion for boto3.client("devicefarm").get_device_instance method. boto3 documentation

# get_device_instance method definition

def get_device_instance(
    self,
    *,
    arn: str,
) -> GetDeviceInstanceResultTypeDef:  # (1)
    ...

1. See GetDeviceInstanceResultTypeDef

# get_device_instance method usage example with argument unpacking

kwargs: GetDeviceInstanceRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_device_instance(**kwargs)

1. See GetDeviceInstanceRequestRequestTypeDef

get_device_pool

Gets information about a device pool.

Type annotations and code completion for boto3.client("devicefarm").get_device_pool method. boto3 documentation

# get_device_pool method definition

def get_device_pool(
    self,
    *,
    arn: str,
) -> GetDevicePoolResultTypeDef:  # (1)
    ...

1. See GetDevicePoolResultTypeDef

# get_device_pool method usage example with argument unpacking

kwargs: GetDevicePoolRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_device_pool(**kwargs)

1. See GetDevicePoolRequestRequestTypeDef

get_device_pool_compatibility

Gets information about compatibility with a device pool.

Type annotations and code completion for boto3.client("devicefarm").get_device_pool_compatibility method. boto3 documentation

# get_device_pool_compatibility method definition

def get_device_pool_compatibility(
    self,
    *,
    devicePoolArn: str,
    appArn: str = ...,
    testType: TestTypeType = ...,  # (1)
    test: ScheduleRunTestTypeDef = ...,  # (2)
    configuration: ScheduleRunConfigurationTypeDef = ...,  # (3)
) -> GetDevicePoolCompatibilityResultTypeDef:  # (4)
    ...

1. See TestTypeType
2. See ScheduleRunTestTypeDef
3. See ScheduleRunConfigurationTypeDef
4. See GetDevicePoolCompatibilityResultTypeDef

# get_device_pool_compatibility method usage example with argument unpacking

kwargs: GetDevicePoolCompatibilityRequestRequestTypeDef = {  # (1)
    "devicePoolArn": ...,
}

parent.get_device_pool_compatibility(**kwargs)

1. See GetDevicePoolCompatibilityRequestRequestTypeDef

get_instance_profile

Returns information about the specified instance profile.

Type annotations and code completion for boto3.client("devicefarm").get_instance_profile method. boto3 documentation

# get_instance_profile method definition

def get_instance_profile(
    self,
    *,
    arn: str,
) -> GetInstanceProfileResultTypeDef:  # (1)
    ...

1. See GetInstanceProfileResultTypeDef

# get_instance_profile method usage example with argument unpacking

kwargs: GetInstanceProfileRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_instance_profile(**kwargs)

1. See GetInstanceProfileRequestRequestTypeDef

get_job

Gets information about a job.

Type annotations and code completion for boto3.client("devicefarm").get_job method. boto3 documentation

# get_job method definition

def get_job(
    self,
    *,
    arn: str,
) -> GetJobResultTypeDef:  # (1)
    ...

1. See GetJobResultTypeDef

# get_job method usage example with argument unpacking

kwargs: GetJobRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_job(**kwargs)

1. See GetJobRequestRequestTypeDef

get_network_profile

Returns information about a network profile.

Type annotations and code completion for boto3.client("devicefarm").get_network_profile method. boto3 documentation

# get_network_profile method definition

def get_network_profile(
    self,
    *,
    arn: str,
) -> GetNetworkProfileResultTypeDef:  # (1)
    ...

1. See GetNetworkProfileResultTypeDef

# get_network_profile method usage example with argument unpacking

kwargs: GetNetworkProfileRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_network_profile(**kwargs)

1. See GetNetworkProfileRequestRequestTypeDef

get_offering_status

Gets the current status and future status of all offerings purchased by an AWS account.

Type annotations and code completion for boto3.client("devicefarm").get_offering_status method. boto3 documentation

# get_offering_status method definition

def get_offering_status(
    self,
    *,
    nextToken: str = ...,
) -> GetOfferingStatusResultTypeDef:  # (1)
    ...

1. See GetOfferingStatusResultTypeDef

# get_offering_status method usage example with argument unpacking

kwargs: GetOfferingStatusRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_offering_status(**kwargs)

1. See GetOfferingStatusRequestRequestTypeDef

get_project

Gets information about a project.

Type annotations and code completion for boto3.client("devicefarm").get_project method. boto3 documentation

# get_project method definition

def get_project(
    self,
    *,
    arn: str,
) -> GetProjectResultTypeDef:  # (1)
    ...

1. See GetProjectResultTypeDef

# get_project method usage example with argument unpacking

kwargs: GetProjectRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_project(**kwargs)

1. See GetProjectRequestRequestTypeDef

get_remote_access_session

Returns a link to a currently running remote access session.

Type annotations and code completion for boto3.client("devicefarm").get_remote_access_session method. boto3 documentation

# get_remote_access_session method definition

def get_remote_access_session(
    self,
    *,
    arn: str,
) -> GetRemoteAccessSessionResultTypeDef:  # (1)
    ...

1. See GetRemoteAccessSessionResultTypeDef

# get_remote_access_session method usage example with argument unpacking

kwargs: GetRemoteAccessSessionRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_remote_access_session(**kwargs)

1. See GetRemoteAccessSessionRequestRequestTypeDef

get_run

Gets information about a run.

Type annotations and code completion for boto3.client("devicefarm").get_run method. boto3 documentation

# get_run method definition

def get_run(
    self,
    *,
    arn: str,
) -> GetRunResultTypeDef:  # (1)
    ...

1. See GetRunResultTypeDef

# get_run method usage example with argument unpacking

kwargs: GetRunRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_run(**kwargs)

1. See GetRunRequestRequestTypeDef

get_suite

Gets information about a suite.

Type annotations and code completion for boto3.client("devicefarm").get_suite method. boto3 documentation

# get_suite method definition

def get_suite(
    self,
    *,
    arn: str,
) -> GetSuiteResultTypeDef:  # (1)
    ...

1. See GetSuiteResultTypeDef

# get_suite method usage example with argument unpacking

kwargs: GetSuiteRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_suite(**kwargs)

1. See GetSuiteRequestRequestTypeDef

get_test

Gets information about a test.

Type annotations and code completion for boto3.client("devicefarm").get_test method. boto3 documentation

# get_test method definition

def get_test(
    self,
    *,
    arn: str,
) -> GetTestResultTypeDef:  # (1)
    ...

1. See GetTestResultTypeDef

# get_test method usage example with argument unpacking

kwargs: GetTestRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_test(**kwargs)

1. See GetTestRequestRequestTypeDef

get_test_grid_project

Retrieves information about a Selenium testing project.

Type annotations and code completion for boto3.client("devicefarm").get_test_grid_project method. boto3 documentation

# get_test_grid_project method definition

def get_test_grid_project(
    self,
    *,
    projectArn: str,
) -> GetTestGridProjectResultTypeDef:  # (1)
    ...

1. See GetTestGridProjectResultTypeDef

# get_test_grid_project method usage example with argument unpacking

kwargs: GetTestGridProjectRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
}

parent.get_test_grid_project(**kwargs)

1. See GetTestGridProjectRequestRequestTypeDef

get_test_grid_session

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url.

Type annotations and code completion for boto3.client("devicefarm").get_test_grid_session method. boto3 documentation

# get_test_grid_session method definition

def get_test_grid_session(
    self,
    *,
    projectArn: str = ...,
    sessionId: str = ...,
    sessionArn: str = ...,
) -> GetTestGridSessionResultTypeDef:  # (1)
    ...

1. See GetTestGridSessionResultTypeDef

# get_test_grid_session method usage example with argument unpacking

kwargs: GetTestGridSessionRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
}

parent.get_test_grid_session(**kwargs)

1. See GetTestGridSessionRequestRequestTypeDef

get_upload

Gets information about an upload.

Type annotations and code completion for boto3.client("devicefarm").get_upload method. boto3 documentation

# get_upload method definition

def get_upload(
    self,
    *,
    arn: str,
) -> GetUploadResultTypeDef:  # (1)
    ...

1. See GetUploadResultTypeDef

# get_upload method usage example with argument unpacking

kwargs: GetUploadRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_upload(**kwargs)

1. See GetUploadRequestRequestTypeDef

get_vpce_configuration

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

Type annotations and code completion for boto3.client("devicefarm").get_vpce_configuration method. boto3 documentation

# get_vpce_configuration method definition

def get_vpce_configuration(
    self,
    *,
    arn: str,
) -> GetVPCEConfigurationResultTypeDef:  # (1)
    ...

1. See GetVPCEConfigurationResultTypeDef

# get_vpce_configuration method usage example with argument unpacking

kwargs: GetVPCEConfigurationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_vpce_configuration(**kwargs)

1. See GetVPCEConfigurationRequestRequestTypeDef

install_to_remote_access_session

Installs an application to the device in a remote access session.

Type annotations and code completion for boto3.client("devicefarm").install_to_remote_access_session method. boto3 documentation

# install_to_remote_access_session method definition

def install_to_remote_access_session(
    self,
    *,
    remoteAccessSessionArn: str,
    appArn: str,
) -> InstallToRemoteAccessSessionResultTypeDef:  # (1)
    ...

1. See InstallToRemoteAccessSessionResultTypeDef

# install_to_remote_access_session method usage example with argument unpacking

kwargs: InstallToRemoteAccessSessionRequestRequestTypeDef = {  # (1)
    "remoteAccessSessionArn": ...,
    "appArn": ...,
}

parent.install_to_remote_access_session(**kwargs)

1. See InstallToRemoteAccessSessionRequestRequestTypeDef

list_artifacts

Gets information about artifacts.

Type annotations and code completion for boto3.client("devicefarm").list_artifacts method. boto3 documentation

# list_artifacts method definition

def list_artifacts(
    self,
    *,
    arn: str,
    type: ArtifactCategoryType,  # (1)
    nextToken: str = ...,
) -> ListArtifactsResultTypeDef:  # (2)
    ...

1. See ArtifactCategoryType
2. See ListArtifactsResultTypeDef

# list_artifacts method usage example with argument unpacking

kwargs: ListArtifactsRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "type": ...,
}

parent.list_artifacts(**kwargs)

1. See ListArtifactsRequestRequestTypeDef

list_device_instances

Returns information about the private device instances associated with one or more AWS accounts.

Type annotations and code completion for boto3.client("devicefarm").list_device_instances method. boto3 documentation

# list_device_instances method definition

def list_device_instances(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDeviceInstancesResultTypeDef:  # (1)
    ...

1. See ListDeviceInstancesResultTypeDef

# list_device_instances method usage example with argument unpacking

kwargs: ListDeviceInstancesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_device_instances(**kwargs)

1. See ListDeviceInstancesRequestRequestTypeDef

list_device_pools

Gets information about device pools.

Type annotations and code completion for boto3.client("devicefarm").list_device_pools method. boto3 documentation

# list_device_pools method definition

def list_device_pools(
    self,
    *,
    arn: str,
    type: DevicePoolTypeType = ...,  # (1)
    nextToken: str = ...,
) -> ListDevicePoolsResultTypeDef:  # (2)
    ...

1. See DevicePoolTypeType
2. See ListDevicePoolsResultTypeDef

# list_device_pools method usage example with argument unpacking

kwargs: ListDevicePoolsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_device_pools(**kwargs)

1. See ListDevicePoolsRequestRequestTypeDef

list_devices

Gets information about unique device types.

Type annotations and code completion for boto3.client("devicefarm").list_devices method. boto3 documentation

# list_devices method definition

def list_devices(
    self,
    *,
    arn: str = ...,
    nextToken: str = ...,
    filters: Sequence[DeviceFilterTypeDef] = ...,  # (1)
) -> ListDevicesResultTypeDef:  # (2)
    ...

1. See DeviceFilterTypeDef
2. See ListDevicesResultTypeDef

# list_devices method usage example with argument unpacking

kwargs: ListDevicesRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_devices(**kwargs)

1. See ListDevicesRequestRequestTypeDef

list_instance_profiles

Returns information about all the instance profiles in an AWS account.

Type annotations and code completion for boto3.client("devicefarm").list_instance_profiles method. boto3 documentation

# list_instance_profiles method definition

def list_instance_profiles(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListInstanceProfilesResultTypeDef:  # (1)
    ...

1. See ListInstanceProfilesResultTypeDef

# list_instance_profiles method usage example with argument unpacking

kwargs: ListInstanceProfilesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_instance_profiles(**kwargs)

1. See ListInstanceProfilesRequestRequestTypeDef

list_jobs

Gets information about jobs for a given test run.

Type annotations and code completion for boto3.client("devicefarm").list_jobs method. boto3 documentation

# list_jobs method definition

def list_jobs(
    self,
    *,
    arn: str,
    nextToken: str = ...,
) -> ListJobsResultTypeDef:  # (1)
    ...

1. See ListJobsResultTypeDef

# list_jobs method usage example with argument unpacking

kwargs: ListJobsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_jobs(**kwargs)

1. See ListJobsRequestRequestTypeDef

list_network_profiles

Returns the list of available network profiles.

Type annotations and code completion for boto3.client("devicefarm").list_network_profiles method. boto3 documentation

# list_network_profiles method definition

def list_network_profiles(
    self,
    *,
    arn: str,
    type: NetworkProfileTypeType = ...,  # (1)
    nextToken: str = ...,
) -> ListNetworkProfilesResultTypeDef:  # (2)
    ...

1. See NetworkProfileTypeType
2. See ListNetworkProfilesResultTypeDef

# list_network_profiles method usage example with argument unpacking

kwargs: ListNetworkProfilesRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_network_profiles(**kwargs)

1. See ListNetworkProfilesRequestRequestTypeDef

list_offering_promotions

Returns a list of offering promotions.

Type annotations and code completion for boto3.client("devicefarm").list_offering_promotions method. boto3 documentation

# list_offering_promotions method definition

def list_offering_promotions(
    self,
    *,
    nextToken: str = ...,
) -> ListOfferingPromotionsResultTypeDef:  # (1)
    ...

1. See ListOfferingPromotionsResultTypeDef

# list_offering_promotions method usage example with argument unpacking

kwargs: ListOfferingPromotionsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_offering_promotions(**kwargs)

1. See ListOfferingPromotionsRequestRequestTypeDef

list_offering_transactions

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.

Type annotations and code completion for boto3.client("devicefarm").list_offering_transactions method. boto3 documentation

# list_offering_transactions method definition

def list_offering_transactions(
    self,
    *,
    nextToken: str = ...,
) -> ListOfferingTransactionsResultTypeDef:  # (1)
    ...

1. See ListOfferingTransactionsResultTypeDef

# list_offering_transactions method usage example with argument unpacking

kwargs: ListOfferingTransactionsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_offering_transactions(**kwargs)

1. See ListOfferingTransactionsRequestRequestTypeDef

list_offerings

Returns a list of products or offerings that the user can manage through the API.

Type annotations and code completion for boto3.client("devicefarm").list_offerings method. boto3 documentation

# list_offerings method definition

def list_offerings(
    self,
    *,
    nextToken: str = ...,
) -> ListOfferingsResultTypeDef:  # (1)
    ...

1. See ListOfferingsResultTypeDef

# list_offerings method usage example with argument unpacking

kwargs: ListOfferingsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_offerings(**kwargs)

1. See ListOfferingsRequestRequestTypeDef

list_projects

Gets information about projects.

Type annotations and code completion for boto3.client("devicefarm").list_projects method. boto3 documentation

# list_projects method definition

def list_projects(
    self,
    *,
    arn: str = ...,
    nextToken: str = ...,
) -> ListProjectsResultTypeDef:  # (1)
    ...

1. See ListProjectsResultTypeDef

# list_projects method usage example with argument unpacking

kwargs: ListProjectsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_projects(**kwargs)

1. See ListProjectsRequestRequestTypeDef

list_remote_access_sessions

Returns a list of all currently running remote access sessions.

Type annotations and code completion for boto3.client("devicefarm").list_remote_access_sessions method. boto3 documentation

# list_remote_access_sessions method definition

def list_remote_access_sessions(
    self,
    *,
    arn: str,
    nextToken: str = ...,
) -> ListRemoteAccessSessionsResultTypeDef:  # (1)
    ...

1. See ListRemoteAccessSessionsResultTypeDef

# list_remote_access_sessions method usage example with argument unpacking

kwargs: ListRemoteAccessSessionsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_remote_access_sessions(**kwargs)

1. See ListRemoteAccessSessionsRequestRequestTypeDef

list_runs

Gets information about runs, given an AWS Device Farm project ARN.

Type annotations and code completion for boto3.client("devicefarm").list_runs method. boto3 documentation

# list_runs method definition

def list_runs(
    self,
    *,
    arn: str,
    nextToken: str = ...,
) -> ListRunsResultTypeDef:  # (1)
    ...

1. See ListRunsResultTypeDef

# list_runs method usage example with argument unpacking

kwargs: ListRunsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_runs(**kwargs)

1. See ListRunsRequestRequestTypeDef

list_samples

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

Type annotations and code completion for boto3.client("devicefarm").list_samples method. boto3 documentation

# list_samples method definition

def list_samples(
    self,
    *,
    arn: str,
    nextToken: str = ...,
) -> ListSamplesResultTypeDef:  # (1)
    ...

1. See ListSamplesResultTypeDef

# list_samples method usage example with argument unpacking

kwargs: ListSamplesRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_samples(**kwargs)

1. See ListSamplesRequestRequestTypeDef

list_suites

Gets information about test suites for a given job.

Type annotations and code completion for boto3.client("devicefarm").list_suites method. boto3 documentation

# list_suites method definition

def list_suites(
    self,
    *,
    arn: str,
    nextToken: str = ...,
) -> ListSuitesResultTypeDef:  # (1)
    ...

1. See ListSuitesResultTypeDef

# list_suites method usage example with argument unpacking

kwargs: ListSuitesRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_suites(**kwargs)

1. See ListSuitesRequestRequestTypeDef

list_tags_for_resource

List the tags for an AWS Device Farm resource.

Type annotations and code completion for boto3.client("devicefarm").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_test_grid_projects

Gets a list of all Selenium testing projects in your account.

Type annotations and code completion for boto3.client("devicefarm").list_test_grid_projects method. boto3 documentation

# list_test_grid_projects method definition

def list_test_grid_projects(
    self,
    *,
    maxResult: int = ...,
    nextToken: str = ...,
) -> ListTestGridProjectsResultTypeDef:  # (1)
    ...

1. See ListTestGridProjectsResultTypeDef

# list_test_grid_projects method usage example with argument unpacking

kwargs: ListTestGridProjectsRequestRequestTypeDef = {  # (1)
    "maxResult": ...,
}

parent.list_test_grid_projects(**kwargs)

1. See ListTestGridProjectsRequestRequestTypeDef

list_test_grid_session_actions

Returns a list of the actions taken in a TestGridSession.

Type annotations and code completion for boto3.client("devicefarm").list_test_grid_session_actions method. boto3 documentation

# list_test_grid_session_actions method definition

def list_test_grid_session_actions(
    self,
    *,
    sessionArn: str,
    maxResult: int = ...,
    nextToken: str = ...,
) -> ListTestGridSessionActionsResultTypeDef:  # (1)
    ...

1. See ListTestGridSessionActionsResultTypeDef

# list_test_grid_session_actions method usage example with argument unpacking

kwargs: ListTestGridSessionActionsRequestRequestTypeDef = {  # (1)
    "sessionArn": ...,
}

parent.list_test_grid_session_actions(**kwargs)

1. See ListTestGridSessionActionsRequestRequestTypeDef

list_test_grid_session_artifacts

Retrieves a list of artifacts created during the session.

Type annotations and code completion for boto3.client("devicefarm").list_test_grid_session_artifacts method. boto3 documentation

# list_test_grid_session_artifacts method definition

def list_test_grid_session_artifacts(
    self,
    *,
    sessionArn: str,
    type: TestGridSessionArtifactCategoryType = ...,  # (1)
    maxResult: int = ...,
    nextToken: str = ...,
) -> ListTestGridSessionArtifactsResultTypeDef:  # (2)
    ...

1. See TestGridSessionArtifactCategoryType
2. See ListTestGridSessionArtifactsResultTypeDef

# list_test_grid_session_artifacts method usage example with argument unpacking

kwargs: ListTestGridSessionArtifactsRequestRequestTypeDef = {  # (1)
    "sessionArn": ...,
}

parent.list_test_grid_session_artifacts(**kwargs)

1. See ListTestGridSessionArtifactsRequestRequestTypeDef

list_test_grid_sessions

Retrieves a list of sessions for a TestGridProject.

Type annotations and code completion for boto3.client("devicefarm").list_test_grid_sessions method. boto3 documentation

# list_test_grid_sessions method definition

def list_test_grid_sessions(
    self,
    *,
    projectArn: str,
    status: TestGridSessionStatusType = ...,  # (1)
    creationTimeAfter: Union[datetime, str] = ...,
    creationTimeBefore: Union[datetime, str] = ...,
    endTimeAfter: Union[datetime, str] = ...,
    endTimeBefore: Union[datetime, str] = ...,
    maxResult: int = ...,
    nextToken: str = ...,
) -> ListTestGridSessionsResultTypeDef:  # (2)
    ...

1. See TestGridSessionStatusType
2. See ListTestGridSessionsResultTypeDef

# list_test_grid_sessions method usage example with argument unpacking

kwargs: ListTestGridSessionsRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
}

parent.list_test_grid_sessions(**kwargs)

1. See ListTestGridSessionsRequestRequestTypeDef

list_tests

Gets information about tests in a given test suite.

Type annotations and code completion for boto3.client("devicefarm").list_tests method. boto3 documentation

# list_tests method definition

def list_tests(
    self,
    *,
    arn: str,
    nextToken: str = ...,
) -> ListTestsResultTypeDef:  # (1)
    ...

1. See ListTestsResultTypeDef

# list_tests method usage example with argument unpacking

kwargs: ListTestsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_tests(**kwargs)

1. See ListTestsRequestRequestTypeDef

list_unique_problems

Gets information about unique problems, such as exceptions or crashes.

Type annotations and code completion for boto3.client("devicefarm").list_unique_problems method. boto3 documentation

# list_unique_problems method definition

def list_unique_problems(
    self,
    *,
    arn: str,
    nextToken: str = ...,
) -> ListUniqueProblemsResultTypeDef:  # (1)
    ...

1. See ListUniqueProblemsResultTypeDef

# list_unique_problems method usage example with argument unpacking

kwargs: ListUniqueProblemsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_unique_problems(**kwargs)

1. See ListUniqueProblemsRequestRequestTypeDef

list_uploads

Gets information about uploads, given an AWS Device Farm project ARN.

Type annotations and code completion for boto3.client("devicefarm").list_uploads method. boto3 documentation

# list_uploads method definition

def list_uploads(
    self,
    *,
    arn: str,
    type: UploadTypeType = ...,  # (1)
    nextToken: str = ...,
) -> ListUploadsResultTypeDef:  # (2)
    ...

1. See UploadTypeType
2. See ListUploadsResultTypeDef

# list_uploads method usage example with argument unpacking

kwargs: ListUploadsRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_uploads(**kwargs)

1. See ListUploadsRequestRequestTypeDef

list_vpce_configurations

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

Type annotations and code completion for boto3.client("devicefarm").list_vpce_configurations method. boto3 documentation

# list_vpce_configurations method definition

def list_vpce_configurations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListVPCEConfigurationsResultTypeDef:  # (1)
    ...

1. See ListVPCEConfigurationsResultTypeDef

# list_vpce_configurations method usage example with argument unpacking

kwargs: ListVPCEConfigurationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_vpce_configurations(**kwargs)

1. See ListVPCEConfigurationsRequestRequestTypeDef

purchase_offering

Immediately purchases offerings for an AWS account.

Type annotations and code completion for boto3.client("devicefarm").purchase_offering method. boto3 documentation

# purchase_offering method definition

def purchase_offering(
    self,
    *,
    offeringId: str,
    quantity: int,
    offeringPromotionId: str = ...,
) -> PurchaseOfferingResultTypeDef:  # (1)
    ...

1. See PurchaseOfferingResultTypeDef

# purchase_offering method usage example with argument unpacking

kwargs: PurchaseOfferingRequestRequestTypeDef = {  # (1)
    "offeringId": ...,
    "quantity": ...,
}

parent.purchase_offering(**kwargs)

1. See PurchaseOfferingRequestRequestTypeDef

renew_offering

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period.

Type annotations and code completion for boto3.client("devicefarm").renew_offering method. boto3 documentation

# renew_offering method definition

def renew_offering(
    self,
    *,
    offeringId: str,
    quantity: int,
) -> RenewOfferingResultTypeDef:  # (1)
    ...

1. See RenewOfferingResultTypeDef

# renew_offering method usage example with argument unpacking

kwargs: RenewOfferingRequestRequestTypeDef = {  # (1)
    "offeringId": ...,
    "quantity": ...,
}

parent.renew_offering(**kwargs)

1. See RenewOfferingRequestRequestTypeDef

schedule_run

Schedules a run.

Type annotations and code completion for boto3.client("devicefarm").schedule_run method. boto3 documentation

# schedule_run method definition

def schedule_run(
    self,
    *,
    projectArn: str,
    test: ScheduleRunTestTypeDef,  # (1)
    appArn: str = ...,
    devicePoolArn: str = ...,
    deviceSelectionConfiguration: DeviceSelectionConfigurationTypeDef = ...,  # (2)
    name: str = ...,
    configuration: ScheduleRunConfigurationTypeDef = ...,  # (3)
    executionConfiguration: ExecutionConfigurationTypeDef = ...,  # (4)
) -> ScheduleRunResultTypeDef:  # (5)
    ...

1. See ScheduleRunTestTypeDef
2. See DeviceSelectionConfigurationTypeDef
3. See ScheduleRunConfigurationTypeDef
4. See ExecutionConfigurationTypeDef
5. See ScheduleRunResultTypeDef

# schedule_run method usage example with argument unpacking

kwargs: ScheduleRunRequestRequestTypeDef = {  # (1)
    "projectArn": ...,
    "test": ...,
}

parent.schedule_run(**kwargs)

1. See ScheduleRunRequestRequestTypeDef

stop_job

Initiates a stop request for the current job.

Type annotations and code completion for boto3.client("devicefarm").stop_job method.