devicefarm/aws.sdk.kotlin.services.devicefarm/DeviceFarmClient

DeviceFarmClient

interface DeviceFarmClient : SdkClient

Welcome to the AWS Device Farm API documentation, which contains APIs for:

  • Testing on desktop browsers Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain TestGrid in their names. For more information, see Testing Web Applications on Selenium with Device Farm.

  • Testing on real mobile devicesDevice Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the Device Farm Developer Guide.

Properties

Link copied to clipboard
abstract override val config: DeviceFarmClient.Config

DeviceFarmClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createDevicePool(input: CreateDevicePoolRequest): CreateDevicePoolResponse

Creates a device pool.

Link copied to clipboard
abstract suspend fun createInstanceProfile(input: CreateInstanceProfileRequest): CreateInstanceProfileResponse

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

Link copied to clipboard
abstract suspend fun createNetworkProfile(input: CreateNetworkProfileRequest): CreateNetworkProfileResponse

Creates a network profile.

Link copied to clipboard
abstract suspend fun createProject(input: CreateProjectRequest): CreateProjectResponse

Creates a project.

Link copied to clipboard
abstract suspend fun createRemoteAccessSession(input: CreateRemoteAccessSessionRequest): CreateRemoteAccessSessionResponse

Specifies and starts a remote access session.

Link copied to clipboard
abstract suspend fun createTestGridProject(input: CreateTestGridProjectRequest): CreateTestGridProjectResponse

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

Link copied to clipboard
abstract suspend fun createTestGridUrl(input: CreateTestGridUrlRequest): CreateTestGridUrlResponse

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

Link copied to clipboard
abstract suspend fun createUpload(input: CreateUploadRequest): CreateUploadResponse

Uploads an app or test scripts.

Link copied to clipboard
abstract suspend fun createVpceConfiguration(input: CreateVpceConfigurationRequest): CreateVpceConfigurationResponse

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

Link copied to clipboard
abstract suspend fun deleteDevicePool(input: DeleteDevicePoolRequest): DeleteDevicePoolResponse

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

Link copied to clipboard
abstract suspend fun deleteInstanceProfile(input: DeleteInstanceProfileRequest): DeleteInstanceProfileResponse

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

Link copied to clipboard
abstract suspend fun deleteNetworkProfile(input: DeleteNetworkProfileRequest): DeleteNetworkProfileResponse

Deletes a network profile.

Link copied to clipboard
abstract suspend fun deleteProject(input: DeleteProjectRequest): DeleteProjectResponse

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

Link copied to clipboard
abstract suspend fun deleteRemoteAccessSession(input: DeleteRemoteAccessSessionRequest): DeleteRemoteAccessSessionResponse

Deletes a completed remote access session and its results.

Link copied to clipboard
abstract suspend fun deleteRun(input: DeleteRunRequest): DeleteRunResponse

Deletes the run, given the run ARN.

Link copied to clipboard
abstract suspend fun deleteTestGridProject(input: DeleteTestGridProjectRequest): DeleteTestGridProjectResponse

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

Link copied to clipboard
abstract suspend fun deleteUpload(input: DeleteUploadRequest): DeleteUploadResponse

Deletes an upload given the upload ARN.

Link copied to clipboard
abstract suspend fun deleteVpceConfiguration(input: DeleteVpceConfigurationRequest): DeleteVpceConfigurationResponse

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

Link copied to clipboard
abstract suspend fun getAccountSettings(input: GetAccountSettingsRequest = GetAccountSettingsRequest { }): GetAccountSettingsResponse

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

Link copied to clipboard
abstract suspend fun getDevice(input: GetDeviceRequest): GetDeviceResponse

Gets information about a unique device type.

Link copied to clipboard
abstract suspend fun getDeviceInstance(input: GetDeviceInstanceRequest): GetDeviceInstanceResponse

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

Link copied to clipboard
abstract suspend fun getDevicePool(input: GetDevicePoolRequest): GetDevicePoolResponse

Gets information about a device pool.

Link copied to clipboard
abstract suspend fun getDevicePoolCompatibility(input: GetDevicePoolCompatibilityRequest): GetDevicePoolCompatibilityResponse

Gets information about compatibility with a device pool.

Link copied to clipboard
abstract suspend fun getInstanceProfile(input: GetInstanceProfileRequest): GetInstanceProfileResponse

Returns information about the specified instance profile.

Link copied to clipboard
abstract suspend fun getJob(input: GetJobRequest): GetJobResponse

Gets information about a job.

Link copied to clipboard
abstract suspend fun getNetworkProfile(input: GetNetworkProfileRequest): GetNetworkProfileResponse

Returns information about a network profile.

Link copied to clipboard
abstract suspend fun getOfferingStatus(input: GetOfferingStatusRequest = GetOfferingStatusRequest { }): GetOfferingStatusResponse

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
abstract suspend fun getProject(input: GetProjectRequest): GetProjectResponse

Gets information about a project.

Link copied to clipboard
abstract suspend fun getRemoteAccessSession(input: GetRemoteAccessSessionRequest): GetRemoteAccessSessionResponse

Returns a link to a currently running remote access session.

Link copied to clipboard
abstract suspend fun getRun(input: GetRunRequest): GetRunResponse

Gets information about a run.

Link copied to clipboard
abstract suspend fun getSuite(input: GetSuiteRequest): GetSuiteResponse

Gets information about a suite.

Link copied to clipboard
abstract suspend fun getTest(input: GetTestRequest): GetTestResponse

Gets information about a test.

Link copied to clipboard
abstract suspend fun getTestGridProject(input: GetTestGridProjectRequest): GetTestGridProjectResponse

Retrieves information about a Selenium testing project.

Link copied to clipboard
abstract suspend fun getTestGridSession(input: GetTestGridSessionRequest = GetTestGridSessionRequest { }): GetTestGridSessionResponse

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url. You can use the following to look up sessions:

Link copied to clipboard
abstract suspend fun getUpload(input: GetUploadRequest): GetUploadResponse

Gets information about an upload.

Link copied to clipboard
abstract suspend fun getVpceConfiguration(input: GetVpceConfigurationRequest): GetVpceConfigurationResponse

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

Link copied to clipboard
abstract suspend fun installToRemoteAccessSession(input: InstallToRemoteAccessSessionRequest): InstallToRemoteAccessSessionResponse

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

Link copied to clipboard
abstract suspend fun listArtifacts(input: ListArtifactsRequest): ListArtifactsResponse

Gets information about artifacts.

Link copied to clipboard
abstract suspend fun listDeviceInstances(input: ListDeviceInstancesRequest = ListDeviceInstancesRequest { }): ListDeviceInstancesResponse

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

Link copied to clipboard
abstract suspend fun listDevicePools(input: ListDevicePoolsRequest): ListDevicePoolsResponse

Gets information about device pools.

Link copied to clipboard
abstract suspend fun listDevices(input: ListDevicesRequest = ListDevicesRequest { }): ListDevicesResponse

Gets information about unique device types.

Link copied to clipboard
abstract suspend fun listInstanceProfiles(input: ListInstanceProfilesRequest = ListInstanceProfilesRequest { }): ListInstanceProfilesResponse

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

Link copied to clipboard
abstract suspend fun listJobs(input: ListJobsRequest): ListJobsResponse

Gets information about jobs for a given test run.

Link copied to clipboard
abstract suspend fun listNetworkProfiles(input: ListNetworkProfilesRequest): ListNetworkProfilesResponse

Returns the list of available network profiles.

Link copied to clipboard
abstract suspend fun listOfferingPromotions(input: ListOfferingPromotionsRequest = ListOfferingPromotionsRequest { }): ListOfferingPromotionsResponse

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you must be able to invoke this operation.

Link copied to clipboard
abstract suspend fun listOfferings(input: ListOfferingsRequest = ListOfferingsRequest { }): ListOfferingsResponse

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
abstract suspend fun listOfferingTransactions(input: ListOfferingTransactionsRequest = ListOfferingTransactionsRequest { }): ListOfferingTransactionsResponse

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
abstract suspend fun listProjects(input: ListProjectsRequest = ListProjectsRequest { }): ListProjectsResponse

Gets information about projects.

Link copied to clipboard
abstract suspend fun listRemoteAccessSessions(input: ListRemoteAccessSessionsRequest): ListRemoteAccessSessionsResponse

Returns a list of all currently running remote access sessions.

Link copied to clipboard
abstract suspend fun listRuns(input: ListRunsRequest): ListRunsResponse

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

Link copied to clipboard
abstract suspend fun listSamples(input: ListSamplesRequest): ListSamplesResponse

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

Link copied to clipboard
abstract suspend fun listSuites(input: ListSuitesRequest): ListSuitesResponse

Gets information about test suites for a given job.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

List the tags for an AWS Device Farm resource.

Link copied to clipboard
abstract suspend fun listTestGridProjects(input: ListTestGridProjectsRequest = ListTestGridProjectsRequest { }): ListTestGridProjectsResponse

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

Link copied to clipboard
abstract suspend fun listTestGridSessionActions(input: ListTestGridSessionActionsRequest): ListTestGridSessionActionsResponse

Returns a list of the actions taken in a TestGridSession.

Link copied to clipboard
abstract suspend fun listTestGridSessionArtifacts(input: ListTestGridSessionArtifactsRequest): ListTestGridSessionArtifactsResponse

Retrieves a list of artifacts created during the session.

Link copied to clipboard
abstract suspend fun listTestGridSessions(input: ListTestGridSessionsRequest): ListTestGridSessionsResponse

Retrieves a list of sessions for a TestGridProject.

Link copied to clipboard
abstract suspend fun listTests(input: ListTestsRequest): ListTestsResponse

Gets information about tests in a given test suite.

Link copied to clipboard
abstract suspend fun listUniqueProblems(input: ListUniqueProblemsRequest): ListUniqueProblemsResponse

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

Link copied to clipboard
abstract suspend fun listUploads(input: ListUploadsRequest): ListUploadsResponse

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

Link copied to clipboard
abstract suspend fun listVpceConfigurations(input: ListVpceConfigurationsRequest = ListVpceConfigurationsRequest { }): ListVpceConfigurationsResponse

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

Link copied to clipboard
abstract suspend fun purchaseOffering(input: PurchaseOfferingRequest): PurchaseOfferingResponse

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
abstract suspend fun renewOffering(input: RenewOfferingRequest): RenewOfferingResponse

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
abstract suspend fun scheduleRun(input: ScheduleRunRequest): ScheduleRunResponse

Schedules a run.

Link copied to clipboard
abstract suspend fun stopJob(input: StopJobRequest): StopJobResponse

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.

Link copied to clipboard
abstract suspend fun stopRemoteAccessSession(input: StopRemoteAccessSessionRequest): StopRemoteAccessSessionResponse

Ends a specified remote access session.

Link copied to clipboard
abstract suspend fun stopRun(input: StopRunRequest): StopRunResponse

Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Deletes the specified tags from a resource.

Link copied to clipboard
abstract suspend fun updateDeviceInstance(input: UpdateDeviceInstanceRequest): UpdateDeviceInstanceResponse

Updates information about a private device instance.

Link copied to clipboard
abstract suspend fun updateDevicePool(input: UpdateDevicePoolRequest): UpdateDevicePoolResponse

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

Link copied to clipboard
abstract suspend fun updateInstanceProfile(input: UpdateInstanceProfileRequest): UpdateInstanceProfileResponse

Updates information about an existing private device instance profile.

Link copied to clipboard
abstract suspend fun updateNetworkProfile(input: UpdateNetworkProfileRequest): UpdateNetworkProfileResponse

Updates the network profile.

Link copied to clipboard
abstract suspend fun updateProject(input: UpdateProjectRequest): UpdateProjectResponse

Modifies the specified project name, given the project ARN and a new name.

Link copied to clipboard
abstract suspend fun updateTestGridProject(input: UpdateTestGridProjectRequest): UpdateTestGridProjectResponse

Change details of a project.

Link copied to clipboard
abstract suspend fun updateUpload(input: UpdateUploadRequest): UpdateUploadResponse

Updates an uploaded test spec.

Link copied to clipboard
abstract suspend fun updateVpceConfiguration(input: UpdateVpceConfigurationRequest): UpdateVpceConfigurationResponse

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun DeviceFarmClient.createDevicePool(crossinline block: CreateDevicePoolRequest.Builder.() -> Unit): CreateDevicePoolResponse

Creates a device pool.

Link copied to clipboard
inline suspend fun DeviceFarmClient.createInstanceProfile(crossinline block: CreateInstanceProfileRequest.Builder.() -> Unit): CreateInstanceProfileResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.createNetworkProfile(crossinline block: CreateNetworkProfileRequest.Builder.() -> Unit): CreateNetworkProfileResponse

Creates a network profile.

Link copied to clipboard
inline suspend fun DeviceFarmClient.createProject(crossinline block: CreateProjectRequest.Builder.() -> Unit): CreateProjectResponse

Creates a project.

Link copied to clipboard
inline suspend fun DeviceFarmClient.createRemoteAccessSession(crossinline block: CreateRemoteAccessSessionRequest.Builder.() -> Unit): CreateRemoteAccessSessionResponse

Specifies and starts a remote access session.

Link copied to clipboard
inline suspend fun DeviceFarmClient.createTestGridProject(crossinline block: CreateTestGridProjectRequest.Builder.() -> Unit): CreateTestGridProjectResponse

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

Link copied to clipboard
inline suspend fun DeviceFarmClient.createTestGridUrl(crossinline block: CreateTestGridUrlRequest.Builder.() -> Unit): CreateTestGridUrlResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.createUpload(crossinline block: CreateUploadRequest.Builder.() -> Unit): CreateUploadResponse

Uploads an app or test scripts.

Link copied to clipboard
inline suspend fun DeviceFarmClient.createVpceConfiguration(crossinline block: CreateVpceConfigurationRequest.Builder.() -> Unit): CreateVpceConfigurationResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteDevicePool(crossinline block: DeleteDevicePoolRequest.Builder.() -> Unit): DeleteDevicePoolResponse

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteInstanceProfile(crossinline block: DeleteInstanceProfileRequest.Builder.() -> Unit): DeleteInstanceProfileResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteNetworkProfile(crossinline block: DeleteNetworkProfileRequest.Builder.() -> Unit): DeleteNetworkProfileResponse

Deletes a network profile.

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteProject(crossinline block: DeleteProjectRequest.Builder.() -> Unit): DeleteProjectResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteRemoteAccessSession(crossinline block: DeleteRemoteAccessSessionRequest.Builder.() -> Unit): DeleteRemoteAccessSessionResponse

Deletes a completed remote access session and its results.

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteRun(crossinline block: DeleteRunRequest.Builder.() -> Unit): DeleteRunResponse

Deletes the run, given the run ARN.

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteTestGridProject(crossinline block: DeleteTestGridProjectRequest.Builder.() -> Unit): DeleteTestGridProjectResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteUpload(crossinline block: DeleteUploadRequest.Builder.() -> Unit): DeleteUploadResponse

Deletes an upload given the upload ARN.

Link copied to clipboard
inline suspend fun DeviceFarmClient.deleteVpceConfiguration(crossinline block: DeleteVpceConfigurationRequest.Builder.() -> Unit): DeleteVpceConfigurationResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.getAccountSettings(crossinline block: GetAccountSettingsRequest.Builder.() -> Unit): GetAccountSettingsResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.getDevice(crossinline block: GetDeviceRequest.Builder.() -> Unit): GetDeviceResponse

Gets information about a unique device type.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getDeviceInstance(crossinline block: GetDeviceInstanceRequest.Builder.() -> Unit): GetDeviceInstanceResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.getDevicePool(crossinline block: GetDevicePoolRequest.Builder.() -> Unit): GetDevicePoolResponse

Gets information about a device pool.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getDevicePoolCompatibility(crossinline block: GetDevicePoolCompatibilityRequest.Builder.() -> Unit): GetDevicePoolCompatibilityResponse

Gets information about compatibility with a device pool.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getInstanceProfile(crossinline block: GetInstanceProfileRequest.Builder.() -> Unit): GetInstanceProfileResponse

Returns information about the specified instance profile.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getJob(crossinline block: GetJobRequest.Builder.() -> Unit): GetJobResponse

Gets information about a job.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getNetworkProfile(crossinline block: GetNetworkProfileRequest.Builder.() -> Unit): GetNetworkProfileResponse

Returns information about a network profile.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getOfferingStatus(crossinline block: GetOfferingStatusRequest.Builder.() -> Unit): GetOfferingStatusResponse

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.getProject(crossinline block: GetProjectRequest.Builder.() -> Unit): GetProjectResponse

Gets information about a project.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getRemoteAccessSession(crossinline block: GetRemoteAccessSessionRequest.Builder.() -> Unit): GetRemoteAccessSessionResponse

Returns a link to a currently running remote access session.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getRun(crossinline block: GetRunRequest.Builder.() -> Unit): GetRunResponse

Gets information about a run.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getSuite(crossinline block: GetSuiteRequest.Builder.() -> Unit): GetSuiteResponse

Gets information about a suite.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getTest(crossinline block: GetTestRequest.Builder.() -> Unit): GetTestResponse

Gets information about a test.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getTestGridProject(crossinline block: GetTestGridProjectRequest.Builder.() -> Unit): GetTestGridProjectResponse

Retrieves information about a Selenium testing project.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getTestGridSession(crossinline block: GetTestGridSessionRequest.Builder.() -> Unit): GetTestGridSessionResponse

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url. You can use the following to look up sessions:

Link copied to clipboard
inline suspend fun DeviceFarmClient.getUpload(crossinline block: GetUploadRequest.Builder.() -> Unit): GetUploadResponse

Gets information about an upload.

Link copied to clipboard
inline suspend fun DeviceFarmClient.getVpceConfiguration(crossinline block: GetVpceConfigurationRequest.Builder.() -> Unit): GetVpceConfigurationResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.installToRemoteAccessSession(crossinline block: InstallToRemoteAccessSessionRequest.Builder.() -> Unit): InstallToRemoteAccessSessionResponse

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

Link copied to clipboard
inline suspend fun DeviceFarmClient.listArtifacts(crossinline block: ListArtifactsRequest.Builder.() -> Unit): ListArtifactsResponse

Gets information about artifacts.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listDeviceInstances(crossinline block: ListDeviceInstancesRequest.Builder.() -> Unit): ListDeviceInstancesResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.listDevicePools(crossinline block: ListDevicePoolsRequest.Builder.() -> Unit): ListDevicePoolsResponse

Gets information about device pools.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listDevices(crossinline block: ListDevicesRequest.Builder.() -> Unit): ListDevicesResponse

Gets information about unique device types.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listInstanceProfiles(crossinline block: ListInstanceProfilesRequest.Builder.() -> Unit): ListInstanceProfilesResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.listJobs(crossinline block: ListJobsRequest.Builder.() -> Unit): ListJobsResponse

Gets information about jobs for a given test run.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listNetworkProfiles(crossinline block: ListNetworkProfilesRequest.Builder.() -> Unit): ListNetworkProfilesResponse

Returns the list of available network profiles.

Link copied to clipboard
inline suspend fun DeviceFarmClient.listOfferingPromotions(crossinline block: ListOfferingPromotionsRequest.Builder.() -> Unit): ListOfferingPromotionsResponse

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you must be able to invoke this operation.

Link copied to clipboard
inline suspend fun DeviceFarmClient.listOfferings(crossinline block: ListOfferingsRequest.Builder.() -> Unit): ListOfferingsResponse

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listOfferingTransactions(crossinline block: ListOfferingTransactionsRequest.Builder.() -> Unit): ListOfferingTransactionsResponse

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listProjects(crossinline block: ListProjectsRequest.Builder.() -> Unit): ListProjectsResponse

Gets information about projects.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listRemoteAccessSessions(crossinline block: ListRemoteAccessSessionsRequest.Builder.() -> Unit): ListRemoteAccessSessionsResponse

Returns a list of all currently running remote access sessions.

Link copied to clipboard
inline suspend fun DeviceFarmClient.listRuns(crossinline block: ListRunsRequest.Builder.() -> Unit): ListRunsResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listSamples(crossinline block: ListSamplesRequest.Builder.() -> Unit): ListSamplesResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listSuites(crossinline block: ListSuitesRequest.Builder.() -> Unit): ListSuitesResponse

Gets information about test suites for a given job.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List the tags for an AWS Device Farm resource.

Link copied to clipboard
inline suspend fun DeviceFarmClient.listTestGridProjects(crossinline block: ListTestGridProjectsRequest.Builder.() -> Unit): ListTestGridProjectsResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listTestGridSessionActions(crossinline block: ListTestGridSessionActionsRequest.Builder.() -> Unit): ListTestGridSessionActionsResponse

Returns a list of the actions taken in a TestGridSession.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listTestGridSessionArtifacts(crossinline block: ListTestGridSessionArtifactsRequest.Builder.() -> Unit): ListTestGridSessionArtifactsResponse

Retrieves a list of artifacts created during the session.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listTestGridSessions(crossinline block: ListTestGridSessionsRequest.Builder.() -> Unit): ListTestGridSessionsResponse

Retrieves a list of sessions for a TestGridProject.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listTests(crossinline block: ListTestsRequest.Builder.() -> Unit): ListTestsResponse

Gets information about tests in a given test suite.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listUniqueProblems(crossinline block: ListUniqueProblemsRequest.Builder.() -> Unit): ListUniqueProblemsResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listUploads(crossinline block: ListUploadsRequest.Builder.() -> Unit): ListUploadsResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun DeviceFarmClient.listVpceConfigurations(crossinline block: ListVpceConfigurationsRequest.Builder.() -> Unit): ListVpceConfigurationsResponse

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

Link copied to clipboard
inline suspend fun DeviceFarmClient.purchaseOffering(crossinline block: PurchaseOfferingRequest.Builder.() -> Unit): PurchaseOfferingResponse

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
inline suspend fun DeviceFarmClient.renewOffering(crossinline block: RenewOfferingRequest.Builder.() -> Unit): RenewOfferingResponse

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Link copied to clipboard
inline suspend fun DeviceFarmClient.scheduleRun(crossinline block: ScheduleRunRequest.Builder.() -> Unit): ScheduleRunResponse

Schedules a run.

Link copied to clipboard
inline suspend fun DeviceFarmClient.stopJob(crossinline block: StopJobRequest.Builder.() -> Unit): StopJobResponse

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.

Link copied to clipboard
inline suspend fun DeviceFarmClient.stopRemoteAccessSession(crossinline block: StopRemoteAccessSessionRequest.Builder.() -> Unit): StopRemoteAccessSessionResponse

Ends a specified remote access session.

Link copied to clipboard
inline suspend fun DeviceFarmClient.stopRun(crossinline block: StopRunRequest.Builder.() -> Unit): StopRunResponse

Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.

Link copied to clipboard
inline suspend fun DeviceFarmClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

Link copied to clipboard
inline suspend fun DeviceFarmClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes the specified tags from a resource.

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateDeviceInstance(crossinline block: UpdateDeviceInstanceRequest.Builder.() -> Unit): UpdateDeviceInstanceResponse

Updates information about a private device instance.

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateDevicePool(crossinline block: UpdateDevicePoolRequest.Builder.() -> Unit): UpdateDevicePoolResponse

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateInstanceProfile(crossinline block: UpdateInstanceProfileRequest.Builder.() -> Unit): UpdateInstanceProfileResponse

Updates information about an existing private device instance profile.

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateNetworkProfile(crossinline block: UpdateNetworkProfileRequest.Builder.() -> Unit): UpdateNetworkProfileResponse

Updates the network profile.

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateProject(crossinline block: UpdateProjectRequest.Builder.() -> Unit): UpdateProjectResponse

Modifies the specified project name, given the project ARN and a new name.

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateTestGridProject(crossinline block: UpdateTestGridProjectRequest.Builder.() -> Unit): UpdateTestGridProjectResponse

Change details of a project.

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateUpload(crossinline block: UpdateUploadRequest.Builder.() -> Unit): UpdateUploadResponse

Updates an uploaded test spec.

Link copied to clipboard
inline suspend fun DeviceFarmClient.updateVpceConfiguration(crossinline block: UpdateVpceConfigurationRequest.Builder.() -> Unit): UpdateVpceConfigurationResponse

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Link copied to clipboard
fun DeviceFarmClient.withConfig(block: DeviceFarmClient.Config.Builder.() -> Unit): DeviceFarmClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.