AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccountSettings

A container for account-level settings within AWS Device Farm.

Class ArgumentException

DeviceFarm exception

Class Artifact

Represents the output of a test. Examples of artifacts include logs and screenshots.

Class Counters

Represents entity counters.

Class CPU

Represents the amount of CPU that an app is using on a physical device.

Note that this does not represent system-wide CPU usage.

Class CreateDevicePoolRequest

Container for the parameters to the CreateDevicePool operation. Creates a device pool.

Class CreateDevicePoolResponse

Represents the result of a create device pool request.

Class CreateInstanceProfileRequest

Container for the parameters to the CreateInstanceProfile operation. Creates a profile that can be applied to one or more private fleet device instances.

Class CreateInstanceProfileResponse

This is the response object from the CreateInstanceProfile operation.

Class CreateNetworkProfileRequest

Container for the parameters to the CreateNetworkProfile operation. Creates a network profile.

Class CreateNetworkProfileResponse

This is the response object from the CreateNetworkProfile operation.

Class CreateProjectRequest

Container for the parameters to the CreateProject operation. Creates a new project.

Class CreateProjectResponse

Represents the result of a create project request.

Class CreateRemoteAccessSessionConfiguration

Configuration settings for a remote access session, including billing method.

Class CreateRemoteAccessSessionRequest

Container for the parameters to the CreateRemoteAccessSession operation. Specifies and starts a remote access session.

Class CreateRemoteAccessSessionResponse

Represents the server response from a request to create a remote access session.

Class CreateUploadRequest

Container for the parameters to the CreateUpload operation. Uploads an app or test scripts.

Class CreateUploadResponse

Represents the result of a create upload request.

Class CreateVPCEConfigurationRequest

Container for the parameters to the CreateVPCEConfiguration operation. Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

Class CreateVPCEConfigurationResponse

This is the response object from the CreateVPCEConfiguration operation.

Class CustomerArtifactPaths

A JSON object specifying the paths where the artifacts generated by the customer's tests, on the device or in the test environment, will be pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

For web app tests, you can specify both iosPaths and androidPaths.

Class DeleteDevicePoolRequest

Container for the parameters to the DeleteDevicePool operation. Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

Class DeleteDevicePoolResponse

Represents the result of a delete device pool request.

Class DeleteInstanceProfileRequest

Container for the parameters to the DeleteInstanceProfile operation. Deletes a profile that can be applied to one or more private device instances.

Class DeleteInstanceProfileResponse

This is the response object from the DeleteInstanceProfile operation.

Class DeleteNetworkProfileRequest

Container for the parameters to the DeleteNetworkProfile operation. Deletes a network profile.

Class DeleteNetworkProfileResponse

This is the response object from the DeleteNetworkProfile operation.

Class DeleteProjectRequest

Container for the parameters to the DeleteProject operation. Deletes an AWS Device Farm project, given the project ARN.

Note Deleting this resource does not stop an in-progress run.

Class DeleteProjectResponse

Represents the result of a delete project request.

Class DeleteRemoteAccessSessionRequest

Container for the parameters to the DeleteRemoteAccessSession operation. Deletes a completed remote access session and its results.

Class DeleteRemoteAccessSessionResponse

The response from the server when a request is made to delete the remote access session.

Class DeleteRunRequest

Container for the parameters to the DeleteRun operation. Deletes the run, given the run ARN.

Note Deleting this resource does not stop an in-progress run.

Class DeleteRunResponse

Represents the result of a delete run request.

Class DeleteUploadRequest

Container for the parameters to the DeleteUpload operation. Deletes an upload given the upload ARN.

Class DeleteUploadResponse

Represents the result of a delete upload request.

Class DeleteVPCEConfigurationRequest

Container for the parameters to the DeleteVPCEConfiguration operation. Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

Class DeleteVPCEConfigurationResponse

This is the response object from the DeleteVPCEConfiguration operation.

Class Device

Represents a device type that an app is tested against.

Class DeviceInstance

Represents the device instance.

Class DeviceMinutes

Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.

Class DevicePool

Represents a collection of device types.

Class DevicePoolCompatibilityResult

Represents a device pool compatibility result.

Class ExecutionConfiguration

Represents configuration information about a test run, such as the execution timeout (in minutes).

Class GetAccountSettingsRequest

Container for the parameters to the GetAccountSettings operation. Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.

Class GetAccountSettingsResponse

Represents the account settings return values from the GetAccountSettings request.

Class GetDeviceInstanceRequest

Container for the parameters to the GetDeviceInstance operation. Returns information about a device instance belonging to a private device fleet.

Class GetDeviceInstanceResponse

This is the response object from the GetDeviceInstance operation.

Class GetDevicePoolCompatibilityRequest

Container for the parameters to the GetDevicePoolCompatibility operation. Gets information about compatibility with a device pool.

Class GetDevicePoolCompatibilityResponse

Represents the result of describe device pool compatibility request.

Class GetDevicePoolRequest

Container for the parameters to the GetDevicePool operation. Gets information about a device pool.

Class GetDevicePoolResponse

Represents the result of a get device pool request.

Class GetDeviceRequest

Container for the parameters to the GetDevice operation. Gets information about a unique device type.

Class GetDeviceResponse

Represents the result of a get device request.

Class GetInstanceProfileRequest

Container for the parameters to the GetInstanceProfile operation. Returns information about the specified instance profile.

Class GetInstanceProfileResponse

This is the response object from the GetInstanceProfile operation.

Class GetJobRequest

Container for the parameters to the GetJob operation. Gets information about a job.

Class GetJobResponse

Represents the result of a get job request.

Class GetNetworkProfileRequest

Container for the parameters to the GetNetworkProfile operation. Returns information about a network profile.

Class GetNetworkProfileResponse

This is the response object from the GetNetworkProfile operation.

Class GetOfferingStatusRequest

Container for the parameters to the GetOfferingStatus operation. 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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Class GetOfferingStatusResponse

Returns the status result for a device offering.

Class GetProjectRequest

Container for the parameters to the GetProject operation. Gets information about a project.

Class GetProjectResponse

Represents the result of a get project request.

Class GetRemoteAccessSessionRequest

Container for the parameters to the GetRemoteAccessSession operation. Returns a link to a currently running remote access session.

Class GetRemoteAccessSessionResponse

Represents the response from the server that lists detailed information about the remote access session.

Class GetRunRequest

Container for the parameters to the GetRun operation. Gets information about a run.

Class GetRunResponse

Represents the result of a get run request.

Class GetSuiteRequest

Container for the parameters to the GetSuite operation. Gets information about a suite.

Class GetSuiteResponse

Represents the result of a get suite request.

Class GetTestRequest

Container for the parameters to the GetTest operation. Gets information about a test.

Class GetTestResponse

Represents the result of a get test request.

Class GetUploadRequest

Container for the parameters to the GetUpload operation. Gets information about an upload.

Class GetUploadResponse

Represents the result of a get upload request.

Class GetVPCEConfigurationRequest

Container for the parameters to the GetVPCEConfiguration operation. Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

Class GetVPCEConfigurationResponse

This is the response object from the GetVPCEConfiguration operation.

Class IdempotencyException

DeviceFarm exception

Class IncompatibilityMessage

Represents information about incompatibility.

Class InstallToRemoteAccessSessionRequest

Container for the parameters to the InstallToRemoteAccessSession operation. 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.

Class InstallToRemoteAccessSessionResponse

Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.

Class InstanceProfile

Represents the instance profile.

Class InvalidOperationException

DeviceFarm exception

Class Job

Represents a device.

Class LimitExceededException

DeviceFarm exception

Class ListArtifactsRequest

Container for the parameters to the ListArtifacts operation. Gets information about artifacts.

Class ListArtifactsResponse

Represents the result of a list artifacts operation.

Class ListDeviceInstancesRequest

Container for the parameters to the ListDeviceInstances operation. Returns information about the private device instances associated with one or more AWS accounts.

Class ListDeviceInstancesResponse

This is the response object from the ListDeviceInstances operation.

Class ListDevicePoolsRequest

Container for the parameters to the ListDevicePools operation. Gets information about device pools.

Class ListDevicePoolsResponse

Represents the result of a list device pools request.

Class ListDevicesRequest

Container for the parameters to the ListDevices operation. Gets information about unique device types.

Class ListDevicesResponse

Represents the result of a list devices operation.

Class ListInstanceProfilesRequest

Container for the parameters to the ListInstanceProfiles operation. Returns information about all the instance profiles in an AWS account.

Class ListInstanceProfilesResponse

This is the response object from the ListInstanceProfiles operation.

Class ListJobsRequest

Container for the parameters to the ListJobs operation. Gets information about jobs for a given test run.

Class ListJobsResponse

Represents the result of a list jobs request.

Class ListNetworkProfilesRequest

Container for the parameters to the ListNetworkProfiles operation. Returns the list of available network profiles.

Class ListNetworkProfilesResponse

This is the response object from the ListNetworkProfiles operation.

Class ListOfferingPromotionsRequest

Container for the parameters to the ListOfferingPromotions operation. 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 believe that you should be able to invoke this operation.

Class ListOfferingPromotionsResponse

This is the response object from the ListOfferingPromotions operation.

Class ListOfferingsRequest

Container for the parameters to the ListOfferings operation. 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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Class ListOfferingsResponse

Represents the return values of the list of offerings.

Class ListOfferingTransactionsRequest

Container for the parameters to the ListOfferingTransactions operation. 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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Class ListOfferingTransactionsResponse

Returns the transaction log of the specified offerings.

Class ListProjectsRequest

Container for the parameters to the ListProjects operation. Gets information about projects.

Class ListProjectsResponse

Represents the result of a list projects request.

Class ListRemoteAccessSessionsRequest

Container for the parameters to the ListRemoteAccessSessions operation. Returns a list of all currently running remote access sessions.

Class ListRemoteAccessSessionsResponse

Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.

Class ListRunsRequest

Container for the parameters to the ListRuns operation. Gets information about runs, given an AWS Device Farm project ARN.

Class ListRunsResponse

Represents the result of a list runs request.

Class ListSamplesRequest

Container for the parameters to the ListSamples operation. Gets information about samples, given an AWS Device Farm project ARN

Class ListSamplesResponse

Represents the result of a list samples request.

Class ListSuitesRequest

Container for the parameters to the ListSuites operation. Gets information about test suites for a given job.

Class ListSuitesResponse

Represents the result of a list suites request.

Class ListTestsRequest

Container for the parameters to the ListTests operation. Gets information about tests in a given test suite.

Class ListTestsResponse

Represents the result of a list tests request.

Class ListUniqueProblemsRequest

Container for the parameters to the ListUniqueProblems operation. Gets information about unique problems.

Class ListUniqueProblemsResponse

Represents the result of a list unique problems request.

Class ListUploadsRequest

Container for the parameters to the ListUploads operation. Gets information about uploads, given an AWS Device Farm project ARN.

Class ListUploadsResponse

Represents the result of a list uploads request.

Class ListVPCEConfigurationsRequest

Container for the parameters to the ListVPCEConfigurations operation. Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

Class ListVPCEConfigurationsResponse

This is the response object from the ListVPCEConfigurations operation.

Class Location

Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).

Elevation is currently not supported.

Class MonetaryAmount

A number representing the monetary amount for an offering or transaction.

Class NetworkProfile

An array of settings that describes characteristics of a network profile.

Class NotEligibleException

DeviceFarm exception

Class NotFoundException

DeviceFarm exception

Class Offering

Represents the metadata of a device offering.

Class OfferingPromotion

Represents information about an offering promotion.

Class OfferingStatus

The status of the offering.

Class OfferingTransaction

Represents the metadata of an offering transaction.

Class Problem

Represents a specific warning or failure.

Class ProblemDetail

Information about a problem detail.

Class Project

Represents an operating-system neutral workspace for running and managing tests.

Class PurchaseOfferingRequest

Container for the parameters to the PurchaseOffering operation. 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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Class PurchaseOfferingResponse

The result of the purchase offering (e.g., success or failure).

Class Radios

Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.

Class RecurringCharge

Specifies whether charges for devices will be recurring.

Class RemoteAccessSession

Represents information about the remote access session.

Class RenewOfferingRequest

Container for the parameters to the RenewOffering operation. 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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Class RenewOfferingResponse

The result of a renewal offering.

Class Resolution

Represents the screen resolution of a device in height and width, expressed in pixels.

Class Rule

Represents a condition for a device pool.

Class Run

Represents a test run on a set of devices with a given app package, test parameters, etc.

Class Sample

Represents a sample of performance data.

Class ScheduleRunConfiguration

Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.

Class ScheduleRunRequest

Container for the parameters to the ScheduleRun operation. Schedules a run.

Class ScheduleRunResponse

Represents the result of a schedule run request.

Class ScheduleRunTest

Represents additional test settings.

Class ServiceAccountException

DeviceFarm exception

Class StopJobRequest

Container for the parameters to the StopJob operation. Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

Class StopJobResponse

This is the response object from the StopJob operation.

Class StopRemoteAccessSessionRequest

Container for the parameters to the StopRemoteAccessSession operation. Ends a specified remote access session.

Class StopRemoteAccessSessionResponse

Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.

Class StopRunRequest

Container for the parameters to the StopRun operation. 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 completed.

Class StopRunResponse

Represents the results of your stop run attempt.

Class Suite

Represents a collection of one or more tests.

Class Test

Represents a condition that is evaluated.

Class TrialMinutes

Represents information about free trial device minutes for an AWS account.

Class UniqueProblem

A collection of one or more problems, grouped by their result.

Class UpdateDeviceInstanceRequest

Container for the parameters to the UpdateDeviceInstance operation. Updates information about an existing private device instance.

Class UpdateDeviceInstanceResponse

This is the response object from the UpdateDeviceInstance operation.

Class UpdateDevicePoolRequest

Container for the parameters to the UpdateDevicePool operation. 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).

Class UpdateDevicePoolResponse

Represents the result of an update device pool request.

Class UpdateInstanceProfileRequest

Container for the parameters to the UpdateInstanceProfile operation. Updates information about an existing private device instance profile.

Class UpdateInstanceProfileResponse

This is the response object from the UpdateInstanceProfile operation.

Class UpdateNetworkProfileRequest

Container for the parameters to the UpdateNetworkProfile operation. Updates the network profile with specific settings.

Class UpdateNetworkProfileResponse

This is the response object from the UpdateNetworkProfile operation.

Class UpdateProjectRequest

Container for the parameters to the UpdateProject operation. Modifies the specified project name, given the project ARN and a new name.

Class UpdateProjectResponse

Represents the result of an update project request.

Class UpdateUploadRequest

Container for the parameters to the UpdateUpload operation. Update an uploaded test specification (test spec).

Class UpdateUploadResponse

This is the response object from the UpdateUpload operation.

Class UpdateVPCEConfigurationRequest

Container for the parameters to the UpdateVPCEConfiguration operation. Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.

Class UpdateVPCEConfigurationResponse

This is the response object from the UpdateVPCEConfiguration operation.

Class Upload

An app or a set of one or more tests to upload or that have been uploaded.

Class VPCEConfiguration

Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.