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)
...
# create_device_pool method usage example with argument unpacking
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
# create_instance_profile method definition
def create_instance_profile(
self,
*,
name: str,
description: str = ...,
packageCleanup: bool = ...,
excludeAppPackagesFromCleanup: Sequence[str] = ...,
rebootAfterUse: bool = ...,
) -> CreateInstanceProfileResultTypeDef: # (1)
...
# create_instance_profile method usage example with argument unpacking
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
# 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)
...
# create_network_profile method usage example with argument unpacking
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
# create_project method definition
def create_project(
self,
*,
name: str,
defaultJobTimeoutMinutes: int = ...,
vpcConfig: VpcConfigTypeDef = ..., # (1)
) -> CreateProjectResultTypeDef: # (2)
...
# create_project method usage example with argument unpacking
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
# 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)
...
- See CreateRemoteAccessSessionConfigurationTypeDef
- See InteractionModeType
- See CreateRemoteAccessSessionResultTypeDef
# create_remote_access_session method usage example with argument unpacking
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
# create_test_grid_project method definition
def create_test_grid_project(
self,
*,
name: str,
description: str = ...,
vpcConfig: TestGridVpcConfigTypeDef = ..., # (1)
) -> CreateTestGridProjectResultTypeDef: # (2)
...
# create_test_grid_project method usage example with argument unpacking
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
# create_test_grid_url method definition
def create_test_grid_url(
self,
*,
projectArn: str,
expiresInSeconds: int,
) -> CreateTestGridUrlResultTypeDef: # (1)
...
# create_test_grid_url method usage example with argument unpacking
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
# create_upload method definition
def create_upload(
self,
*,
projectArn: str,
name: str,
type: UploadTypeType, # (1)
contentType: str = ...,
) -> CreateUploadResultTypeDef: # (2)
...
# create_upload method usage example with argument unpacking
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
# create_vpce_configuration method definition
def create_vpce_configuration(
self,
*,
vpceConfigurationName: str,
vpceServiceName: str,
serviceDnsName: str,
vpceConfigurationDescription: str = ...,
) -> CreateVPCEConfigurationResultTypeDef: # (1)
...
# create_vpce_configuration method usage example with argument unpacking
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
# 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)
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)
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)
delete_project#
Deletes an AWS Device Farm project, given the project ARN.
Type annotations and code completion for boto3.client("devicefarm").delete_project
method.