DeviceFarmClient Class

Member Function Documentation

DeviceFarmClient::DeviceFarmClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a DeviceFarmClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

DeviceFarmClient::DeviceFarmClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads DeviceFarmClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateDevicePoolResponse *DeviceFarmClient::createDevicePool(const CreateDevicePoolRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an CreateDevicePoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a device

[slot] CreateInstanceProfileResponse *DeviceFarmClient::createInstanceProfile(const CreateInstanceProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an CreateInstanceProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateNetworkProfileResponse *DeviceFarmClient::createNetworkProfile(const CreateNetworkProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an CreateNetworkProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a network

[slot] CreateProjectResponse *DeviceFarmClient::createProject(const CreateProjectRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an CreateProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new

[slot] CreateRemoteAccessSessionResponse *DeviceFarmClient::createRemoteAccessSession(const CreateRemoteAccessSessionRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an CreateRemoteAccessSessionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Specifies and starts a remote access

[slot] CreateUploadResponse *DeviceFarmClient::createUpload(const CreateUploadRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an CreateUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Uploads an app or test

[slot] CreateVPCEConfigurationResponse *DeviceFarmClient::createVPCEConfiguration(const CreateVPCEConfigurationRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an CreateVPCEConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteDevicePoolResponse *DeviceFarmClient::deleteDevicePool(const DeleteDevicePoolRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteDevicePoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteInstanceProfileResponse *DeviceFarmClient::deleteInstanceProfile(const DeleteInstanceProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteInstanceProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteNetworkProfileResponse *DeviceFarmClient::deleteNetworkProfile(const DeleteNetworkProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteNetworkProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a network

[slot] DeleteProjectResponse *DeviceFarmClient::deleteProject(const DeleteProjectRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an AWS Device Farm project, given the project

ARN>

<b>Note</b> Deleting this resource does not stop an in-progress

[slot] DeleteRemoteAccessSessionResponse *DeviceFarmClient::deleteRemoteAccessSession(const DeleteRemoteAccessSessionRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteRemoteAccessSessionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a completed remote access session and its

[slot] DeleteRunResponse *DeviceFarmClient::deleteRun(const DeleteRunRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the run, given the run

ARN>

<b>Note</b> Deleting this resource does not stop an in-progress

[slot] DeleteUploadResponse *DeviceFarmClient::deleteUpload(const DeleteUploadRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an upload given the upload

[slot] DeleteVPCEConfigurationResponse *DeviceFarmClient::deleteVPCEConfiguration(const DeleteVPCEConfigurationRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an DeleteVPCEConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetAccountSettingsResponse *DeviceFarmClient::getAccountSettings(const GetAccountSettingsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetAccountSettingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the

[slot] GetDeviceResponse *DeviceFarmClient::getDevice(const GetDeviceRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a unique device

[slot] GetDeviceInstanceResponse *DeviceFarmClient::getDeviceInstance(const GetDeviceInstanceRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetDeviceInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a device instance belonging to a private device

[slot] GetDevicePoolResponse *DeviceFarmClient::getDevicePool(const GetDevicePoolRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetDevicePoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a device

[slot] GetDevicePoolCompatibilityResponse *DeviceFarmClient::getDevicePoolCompatibility(const GetDevicePoolCompatibilityRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetDevicePoolCompatibilityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about compatibility with a device

[slot] GetInstanceProfileResponse *DeviceFarmClient::getInstanceProfile(const GetInstanceProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetInstanceProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the specified instance

[slot] GetJobResponse *DeviceFarmClient::getJob(const GetJobRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] GetNetworkProfileResponse *DeviceFarmClient::getNetworkProfile(const GetNetworkProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetNetworkProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a network

[slot] GetOfferingStatusResponse *DeviceFarmClient::getOfferingStatus(const GetOfferingStatusRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetOfferingStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this

[slot] GetProjectResponse *DeviceFarmClient::getProject(const GetProjectRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] GetRemoteAccessSessionResponse *DeviceFarmClient::getRemoteAccessSession(const GetRemoteAccessSessionRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetRemoteAccessSessionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a link to a currently running remote access

[slot] GetRunResponse *DeviceFarmClient::getRun(const GetRunRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] GetSuiteResponse *DeviceFarmClient::getSuite(const GetSuiteRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetSuiteResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] GetTestResponse *DeviceFarmClient::getTest(const GetTestRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetTestResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] GetUploadResponse *DeviceFarmClient::getUpload(const GetUploadRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about an

[slot] GetVPCEConfigurationResponse *DeviceFarmClient::getVPCEConfiguration(const GetVPCEConfigurationRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an GetVPCEConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] InstallToRemoteAccessSessionResponse *DeviceFarmClient::installToRemoteAccessSession(const InstallToRemoteAccessSessionRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an InstallToRemoteAccessSessionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListArtifactsResponse *DeviceFarmClient::listArtifacts(const ListArtifactsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListArtifactsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about

[slot] ListDeviceInstancesResponse *DeviceFarmClient::listDeviceInstances(const ListDeviceInstancesRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListDeviceInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListDevicePoolsResponse *DeviceFarmClient::listDevicePools(const ListDevicePoolsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListDevicePoolsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about device

[slot] ListDevicesResponse *DeviceFarmClient::listDevices(const ListDevicesRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListDevicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about unique device

[slot] ListInstanceProfilesResponse *DeviceFarmClient::listInstanceProfiles(const ListInstanceProfilesRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListInstanceProfilesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about all the instance profiles in an AWS

[slot] ListJobsResponse *DeviceFarmClient::listJobs(const ListJobsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about jobs for a given test

[slot] ListNetworkProfilesResponse *DeviceFarmClient::listNetworkProfiles(const ListNetworkProfilesRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListNetworkProfilesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the list of available network

[slot] ListOfferingPromotionsResponse *DeviceFarmClient::listOfferingPromotions(const ListOfferingPromotionsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListOfferingPromotionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a <code>NotEligible</code> error if the caller is not permitted to invoke the operation. Contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this

[slot] ListOfferingTransactionsResponse *DeviceFarmClient::listOfferingTransactions(const ListOfferingTransactionsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListOfferingTransactionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this

[slot] ListOfferingsResponse *DeviceFarmClient::listOfferings(const ListOfferingsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListOfferingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this

[slot] ListProjectsResponse *DeviceFarmClient::listProjects(const ListProjectsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListProjectsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about

[slot] ListRemoteAccessSessionsResponse *DeviceFarmClient::listRemoteAccessSessions(const ListRemoteAccessSessionsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListRemoteAccessSessionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of all currently running remote access

[slot] ListRunsResponse *DeviceFarmClient::listRuns(const ListRunsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListRunsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about runs, given an AWS Device Farm project

[slot] ListSamplesResponse *DeviceFarmClient::listSamples(const ListSamplesRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListSamplesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about samples, given an AWS Device Farm project

[slot] ListSuitesResponse *DeviceFarmClient::listSuites(const ListSuitesRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListSuitesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about test suites for a given

[slot] ListTestsResponse *DeviceFarmClient::listTests(const ListTestsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListTestsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about tests in a given test

[slot] ListUniqueProblemsResponse *DeviceFarmClient::listUniqueProblems(const ListUniqueProblemsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListUniqueProblemsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about unique

[slot] ListUploadsResponse *DeviceFarmClient::listUploads(const ListUploadsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListUploadsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about uploads, given an AWS Device Farm project

[slot] ListVPCEConfigurationsResponse *DeviceFarmClient::listVPCEConfigurations(const ListVPCEConfigurationsRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ListVPCEConfigurationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PurchaseOfferingResponse *DeviceFarmClient::purchaseOffering(const PurchaseOfferingRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an PurchaseOfferingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this

[slot] RenewOfferingResponse *DeviceFarmClient::renewOffering(const RenewOfferingRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an RenewOfferingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Explicitly sets the quantity of devices to renew for an offering, starting from the <code>effectiveDate</code> of the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this

[slot] ScheduleRunResponse *DeviceFarmClient::scheduleRun(const ScheduleRunRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an ScheduleRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Schedules a

[slot] StopRemoteAccessSessionResponse *DeviceFarmClient::stopRemoteAccessSession(const StopRemoteAccessSessionRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an StopRemoteAccessSessionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Ends a specified remote access

[slot] StopRunResponse *DeviceFarmClient::stopRun(const StopRunRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an StopRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already

[slot] UpdateDeviceInstanceResponse *DeviceFarmClient::updateDeviceInstance(const UpdateDeviceInstanceRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an UpdateDeviceInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates information about an existing private device

[slot] UpdateDevicePoolResponse *DeviceFarmClient::updateDevicePool(const UpdateDevicePoolRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an UpdateDevicePoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateInstanceProfileResponse *DeviceFarmClient::updateInstanceProfile(const UpdateInstanceProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an UpdateInstanceProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates information about an existing private device instance

[slot] UpdateNetworkProfileResponse *DeviceFarmClient::updateNetworkProfile(const UpdateNetworkProfileRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an UpdateNetworkProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the network profile with specific

[slot] UpdateProjectResponse *DeviceFarmClient::updateProject(const UpdateProjectRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an UpdateProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateVPCEConfigurationResponse *DeviceFarmClient::updateVPCEConfiguration(const UpdateVPCEConfigurationRequest &request)

Sends request to the DeviceFarmClient service, and returns a pointer to an UpdateVPCEConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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