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
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.
client = boto3.client("devicefarm")
try:
do_something(client)
except (
client.ArgumentException,
client.CannotDeleteException,
client.ClientError,
client.IdempotencyException,
client.InternalServiceException,
client.InvalidOperationException,
client.LimitExceededException,
client.NotEligibleException,
client.NotFoundException,
client.ServiceAccountException,
client.TagOperationException,
client.TagPolicyException,
client.TooManyTagsException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("devicefarm").close
method.
boto3 documentation
create_device_pool
Creates a device pool.
Type annotations and code completion for boto3.client("devicefarm").create_device_pool
method.
boto3 documentation
def create_device_pool(
self,
*,
projectArn: str,
name: str,
rules: Sequence[RuleTypeDef], # (1)
description: str = ...,
maxDevices: int = ...,
) -> CreateDevicePoolResultTypeDef: # (2)
...
kwargs: CreateDevicePoolRequestRequestTypeDef = { # (1)
"projectArn": ...,
"name": ...,
"rules": ...,
}
parent.create_device_pool(**kwargs)
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
def create_instance_profile(
self,
*,
name: str,
description: str = ...,
packageCleanup: bool = ...,
excludeAppPackagesFromCleanup: Sequence[str] = ...,
rebootAfterUse: bool = ...,
) -> CreateInstanceProfileResultTypeDef: # (1)
...
kwargs: CreateInstanceProfileRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_instance_profile(**kwargs)
create_network_profile
Creates a network profile.
Type annotations and code completion for boto3.client("devicefarm").create_network_profile
method.
boto3 documentation
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)
...
kwargs: CreateNetworkProfileRequestRequestTypeDef = { # (1)
"projectArn": ...,
"name": ...,
}
parent.create_network_profile(**kwargs)
create_project
Creates a project.
Type annotations and code completion for boto3.client("devicefarm").create_project
method.
boto3 documentation
def create_project(
self,
*,
name: str,
defaultJobTimeoutMinutes: int = ...,
vpcConfig: VpcConfigTypeDef = ..., # (1)
) -> CreateProjectResultTypeDef: # (2)
...
kwargs: CreateProjectRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_project(**kwargs)
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
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)
...
- See CreateRemoteAccessSessionConfigurationTypeDef
- See InteractionModeType
- See CreateRemoteAccessSessionResultTypeDef
kwargs: CreateRemoteAccessSessionRequestRequestTypeDef = { # (1)
"projectArn": ...,
"deviceArn": ...,
}
parent.create_remote_access_session(**kwargs)
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
def create_test_grid_project(
self,
*,
name: str,
description: str = ...,
vpcConfig: TestGridVpcConfigTypeDef = ..., # (1)
) -> CreateTestGridProjectResultTypeDef: # (2)
...
kwargs: CreateTestGridProjectRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_test_grid_project(**kwargs)
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
def create_test_grid_url(
self,
*,
projectArn: str,
expiresInSeconds: int,
) -> CreateTestGridUrlResultTypeDef: # (1)
...
kwargs: CreateTestGridUrlRequestRequestTypeDef = { # (1)
"projectArn": ...,
"expiresInSeconds": ...,
}
parent.create_test_grid_url(**kwargs)
create_upload
Uploads an app or test scripts.
Type annotations and code completion for boto3.client("devicefarm").create_upload
method.
boto3 documentation
def create_upload(
self,
*,
projectArn: str,
name: str,
type: UploadTypeType, # (1)
contentType: str = ...,
) -> CreateUploadResultTypeDef: # (2)
...
kwargs: CreateUploadRequestRequestTypeDef = { # (1)
"projectArn": ...,
"name": ...,
"type": ...,
}
parent.create_upload(**kwargs)
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
def create_vpce_configuration(
self,
*,
vpceConfigurationName: str,
vpceServiceName: str,
serviceDnsName: str,
vpceConfigurationDescription: str = ...,
) -> CreateVPCEConfigurationResultTypeDef: # (1)
...
kwargs: CreateVPCEConfigurationRequestRequestTypeDef = { # (1)
"vpceConfigurationName": ...,
"vpceServiceName": ...,
"serviceDnsName": ...,
}
parent.create_vpce_configuration(**kwargs)
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
kwargs: DeleteDevicePoolRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_device_pool(**kwargs)
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
kwargs: DeleteInstanceProfileRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_instance_profile(**kwargs)
delete_network_profile
Deletes a network profile.
Type annotations and code completion for boto3.client("devicefarm").delete_network_profile
method.
boto3 documentation
kwargs: DeleteNetworkProfileRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_network_profile(**kwargs)
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
kwargs: DeleteProjectRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_project(**kwargs)
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
kwargs: DeleteRemoteAccessSessionRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_remote_access_session(**kwargs)
delete_run
Deletes the run, given the run ARN.
Type annotations and code completion for boto3.client("devicefarm").delete_run
method.
boto3 documentation
kwargs: DeleteRunRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_run(**kwargs)
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
kwargs: DeleteTestGridProjectRequestRequestTypeDef = { # (1)
"projectArn": ...,
}
parent.delete_test_grid_project(**kwargs)
delete_upload
Deletes an upload given the upload ARN.
Type annotations and code completion for boto3.client("devicefarm").delete_upload
method.
boto3 documentation
kwargs: DeleteUploadRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_upload(**kwargs)
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
kwargs: DeleteVPCEConfigurationRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_vpce_configuration(**kwargs)
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
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_device
Gets information about a unique device type.
Type annotations and code completion for boto3.client("devicefarm").get_device
method.
boto3 documentation
kwargs: GetDeviceRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_device(**kwargs)
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
def get_device_instance(
self,
*,
arn: str,
) -> GetDeviceInstanceResultTypeDef: # (1)
...
kwargs: GetDeviceInstanceRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_device_instance(**kwargs)
get_device_pool
Gets information about a device pool.
Type annotations and code completion for boto3.client("devicefarm").get_device_pool
method.
boto3 documentation
kwargs: GetDevicePoolRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_device_pool(**kwargs)
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
def get_device_pool_compatibility(
self,
*,
devicePoolArn: str,
appArn: str = ...,
testType: TestTypeType = ..., # (1)
test: ScheduleRunTestTypeDef = ..., # (2)
configuration: ScheduleRunConfigurationTypeDef = ..., # (3)
) -> GetDevicePoolCompatibilityResultTypeDef: # (4)
...
- See TestTypeType
- See ScheduleRunTestTypeDef
- See ScheduleRunConfigurationTypeDef
- See GetDevicePoolCompatibilityResultTypeDef
kwargs: GetDevicePoolCompatibilityRequestRequestTypeDef = { # (1)
"devicePoolArn": ...,
}
parent.get_device_pool_compatibility(**kwargs)
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
def get_instance_profile(
self,
*,
arn: str,
) -> GetInstanceProfileResultTypeDef: # (1)
...
kwargs: GetInstanceProfileRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_instance_profile(**kwargs)
get_job
Gets information about a job.
Type annotations and code completion for boto3.client("devicefarm").get_job
method.
boto3 documentation
kwargs: GetJobRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_job(**kwargs)
get_network_profile
Returns information about a network profile.
Type annotations and code completion for boto3.client("devicefarm").get_network_profile
method.
boto3 documentation
def get_network_profile(
self,
*,
arn: str,
) -> GetNetworkProfileResultTypeDef: # (1)
...
kwargs: GetNetworkProfileRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_network_profile(**kwargs)
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
def get_offering_status(
self,
*,
nextToken: str = ...,
) -> GetOfferingStatusResultTypeDef: # (1)
...
kwargs: GetOfferingStatusRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.get_offering_status(**kwargs)
get_project
Gets information about a project.
Type annotations and code completion for boto3.client("devicefarm").get_project
method.
boto3 documentation
kwargs: GetProjectRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_project(**kwargs)
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
def get_remote_access_session(
self,
*,
arn: str,
) -> GetRemoteAccessSessionResultTypeDef: # (1)
...
kwargs: GetRemoteAccessSessionRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_remote_access_session(**kwargs)
get_run
Gets information about a run.
Type annotations and code completion for boto3.client("devicefarm").get_run
method.
boto3 documentation
kwargs: GetRunRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_run(**kwargs)
get_suite
Gets information about a suite.
Type annotations and code completion for boto3.client("devicefarm").get_suite
method.
boto3 documentation
kwargs: GetSuiteRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_suite(**kwargs)
get_test
Gets information about a test.
Type annotations and code completion for boto3.client("devicefarm").get_test
method.
boto3 documentation
kwargs: GetTestRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_test(**kwargs)
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
def get_test_grid_project(
self,
*,
projectArn: str,
) -> GetTestGridProjectResultTypeDef: # (1)
...
kwargs: GetTestGridProjectRequestRequestTypeDef = { # (1)
"projectArn": ...,
}
parent.get_test_grid_project(**kwargs)
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
def get_test_grid_session(
self,
*,
projectArn: str = ...,
sessionId: str = ...,
sessionArn: str = ...,
) -> GetTestGridSessionResultTypeDef: # (1)
...
kwargs: GetTestGridSessionRequestRequestTypeDef = { # (1)
"projectArn": ...,
}
parent.get_test_grid_session(**kwargs)
get_upload
Gets information about an upload.
Type annotations and code completion for boto3.client("devicefarm").get_upload
method.
boto3 documentation
kwargs: GetUploadRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_upload(**kwargs)
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
def get_vpce_configuration(
self,
*,
arn: str,
) -> GetVPCEConfigurationResultTypeDef: # (1)
...
kwargs: GetVPCEConfigurationRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_vpce_configuration(**kwargs)
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
def install_to_remote_access_session(
self,
*,
remoteAccessSessionArn: str,
appArn: str,
) -> InstallToRemoteAccessSessionResultTypeDef: # (1)
...
kwargs: InstallToRemoteAccessSessionRequestRequestTypeDef = { # (1)
"remoteAccessSessionArn": ...,
"appArn": ...,
}
parent.install_to_remote_access_session(**kwargs)
list_artifacts
Gets information about artifacts.
Type annotations and code completion for boto3.client("devicefarm").list_artifacts
method.
boto3 documentation
def list_artifacts(
self,
*,
arn: str,
type: ArtifactCategoryType, # (1)
nextToken: str = ...,
) -> ListArtifactsResultTypeDef: # (2)
...
kwargs: ListArtifactsRequestRequestTypeDef = { # (1)
"arn": ...,
"type": ...,
}
parent.list_artifacts(**kwargs)
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
def list_device_instances(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDeviceInstancesResultTypeDef: # (1)
...
kwargs: ListDeviceInstancesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_device_instances(**kwargs)
list_device_pools
Gets information about device pools.
Type annotations and code completion for boto3.client("devicefarm").list_device_pools
method.
boto3 documentation
def list_device_pools(
self,
*,
arn: str,
type: DevicePoolTypeType = ..., # (1)
nextToken: str = ...,
) -> ListDevicePoolsResultTypeDef: # (2)
...
kwargs: ListDevicePoolsRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.list_device_pools(**kwargs)
list_devices
Gets information about unique device types.
Type annotations and code completion for boto3.client("devicefarm").list_devices
method.
boto3 documentation
def list_devices(
self,
*,
arn: str = ...,
nextToken: str = ...,
filters: Sequence[DeviceFilterTypeDef] = ..., # (1)
) -> ListDevicesResultTypeDef: # (2)
...
kwargs: ListDevicesRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.list_devices(**kwargs)
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
def list_instance_profiles(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListInstanceProfilesResultTypeDef: # (1)
...
kwargs: ListInstanceProfilesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_instance_profiles(**kwargs)
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
def list_jobs(
self,
*,
arn: str,
nextToken: str = ...,
) -> ListJobsResultTypeDef: # (1)
...
kwargs: ListJobsRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.list_jobs(**kwargs)
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
def list_network_profiles(
self,
*,
arn: str,
type: NetworkProfileTypeType = ..., # (1)
nextToken: str = ...,
) -> ListNetworkProfilesResultTypeDef: # (2)
...
kwargs: ListNetworkProfilesRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.list_network_profiles(**kwargs)
list_offering_promotions
Returns a list of offering promotions.
Type annotations and code completion for boto3.client("devicefarm").list_offering_promotions
method.
boto3 documentation