@datafire/amazonaws_devicefarm v5.0.0

@datafire/amazonaws_devicefarm

Client library for AWS Device Farm

Installation and Usage

npm install --save @datafire/amazonaws_devicefarm

let amazonaws_devicefarm = require('@datafire/amazonaws_devicefarm').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_devicefarm.CreateDevicePool({
  "projectArn": "",
  "name": "",
  "rules": []
}).then(data => {
  console.log(data);
});

Description

AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.

Actions

CreateDevicePool

amazonaws_devicefarm.CreateDevicePool({
  "projectArn": "",
  "name": "",
  "rules": []
}, context)

Input

• input object
  • description Message
  • name required Name
  • projectArn required AmazonResourceName
  • rules required Rules

Output

• output CreateDevicePoolResult

CreateNetworkProfile

amazonaws_devicefarm.CreateNetworkProfile({
  "projectArn": "",
  "name": ""
}, context)

Input

• input object
  • description Message
  • downlinkBandwidthBits Long
  • downlinkDelayMs Long
  • downlinkJitterMs Long
  • downlinkLossPercent PercentInteger
  • name required Name
  • projectArn required AmazonResourceName
  • type NetworkProfileType
  • uplinkBandwidthBits Long
  • uplinkDelayMs Long
  • uplinkJitterMs Long
  • uplinkLossPercent PercentInteger

Output

• output CreateNetworkProfileResult

CreateProject

amazonaws_devicefarm.CreateProject({
  "name": ""
}, context)

Input

• input object
  • defaultJobTimeoutMinutes JobTimeoutMinutes
  • name required Name

Output

• output CreateProjectResult

CreateRemoteAccessSession

amazonaws_devicefarm.CreateRemoteAccessSession({
  "projectArn": "",
  "deviceArn": ""
}, context)

Input

• input object
  • clientId ClientId
  • configuration CreateRemoteAccessSessionConfiguration
  • deviceArn required AmazonResourceName
  • interactionMode InteractionMode
  • name Name
  • projectArn required AmazonResourceName
  • remoteDebugEnabled Boolean
  • remoteRecordAppArn AmazonResourceName
  • remoteRecordEnabled Boolean
  • sshPublicKey SshPublicKey

Output

• output CreateRemoteAccessSessionResult

CreateUpload

amazonaws_devicefarm.CreateUpload({
  "projectArn": "",
  "name": "",
  "type": ""
}, context)

Input

• input object
  • contentType ContentType
  • name required Name
  • projectArn required AmazonResourceName
  • type required UploadType

Output

• output CreateUploadResult

DeleteDevicePool

amazonaws_devicefarm.DeleteDevicePool({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output DeleteDevicePoolResult

DeleteNetworkProfile

amazonaws_devicefarm.DeleteNetworkProfile({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output DeleteNetworkProfileResult

DeleteProject

amazonaws_devicefarm.DeleteProject({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output DeleteProjectResult

DeleteRemoteAccessSession

amazonaws_devicefarm.DeleteRemoteAccessSession({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output DeleteRemoteAccessSessionResult

DeleteRun

amazonaws_devicefarm.DeleteRun({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output DeleteRunResult

DeleteUpload

amazonaws_devicefarm.DeleteUpload({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output DeleteUploadResult

GetAccountSettings

amazonaws_devicefarm.GetAccountSettings({}, context)

Input

• input object

Output

• output GetAccountSettingsResult

GetDevice

amazonaws_devicefarm.GetDevice({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetDeviceResult

GetDevicePool

amazonaws_devicefarm.GetDevicePool({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetDevicePoolResult

GetDevicePoolCompatibility

amazonaws_devicefarm.GetDevicePoolCompatibility({
  "devicePoolArn": ""
}, context)

Input

• input object
  • appArn AmazonResourceName
  • devicePoolArn required AmazonResourceName
  • test ScheduleRunTest
  • testType TestType

Output

• output GetDevicePoolCompatibilityResult

GetJob

amazonaws_devicefarm.GetJob({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetJobResult

GetNetworkProfile

amazonaws_devicefarm.GetNetworkProfile({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetNetworkProfileResult

GetOfferingStatus

amazonaws_devicefarm.GetOfferingStatus({}, context)

Input

• input object
  • nextToken string
  • nextToken PaginationToken

Output

• output GetOfferingStatusResult

GetProject

amazonaws_devicefarm.GetProject({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetProjectResult

GetRemoteAccessSession

amazonaws_devicefarm.GetRemoteAccessSession({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetRemoteAccessSessionResult

GetRun

amazonaws_devicefarm.GetRun({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetRunResult

GetSuite

amazonaws_devicefarm.GetSuite({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetSuiteResult

GetTest

amazonaws_devicefarm.GetTest({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetTestResult

GetUpload

amazonaws_devicefarm.GetUpload({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output GetUploadResult

InstallToRemoteAccessSession

amazonaws_devicefarm.InstallToRemoteAccessSession({
  "remoteAccessSessionArn": "",
  "appArn": ""
}, context)

Input

• input object
  • appArn required AmazonResourceName
  • remoteAccessSessionArn required AmazonResourceName

Output

• output InstallToRemoteAccessSessionResult

ListArtifacts

amazonaws_devicefarm.ListArtifacts({
  "arn": "",
  "type": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken
  • type required ArtifactCategory

Output

• output ListArtifactsResult

ListDevicePools

amazonaws_devicefarm.ListDevicePools({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken
  • type DevicePoolType

Output

• output ListDevicePoolsResult

ListDevices

amazonaws_devicefarm.ListDevices({}, context)

Input

• input object
  • nextToken string
  • arn AmazonResourceName
  • nextToken PaginationToken

Output

• output ListDevicesResult

ListJobs

amazonaws_devicefarm.ListJobs({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListJobsResult

ListNetworkProfiles

amazonaws_devicefarm.ListNetworkProfiles({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName
  • nextToken PaginationToken
  • type NetworkProfileType

Output

• output ListNetworkProfilesResult

ListOfferingPromotions

amazonaws_devicefarm.ListOfferingPromotions({}, context)

Input

• input object
  • nextToken PaginationToken

Output

• output ListOfferingPromotionsResult

ListOfferingTransactions

amazonaws_devicefarm.ListOfferingTransactions({}, context)

Input

• input object
  • nextToken string
  • nextToken PaginationToken

Output

• output ListOfferingTransactionsResult

ListOfferings

amazonaws_devicefarm.ListOfferings({}, context)

Input

• input object
  • nextToken string
  • nextToken PaginationToken

Output

• output ListOfferingsResult

ListProjects

amazonaws_devicefarm.ListProjects({}, context)

Input

• input object
  • nextToken string
  • arn AmazonResourceName
  • nextToken PaginationToken

Output

• output ListProjectsResult

ListRemoteAccessSessions

amazonaws_devicefarm.ListRemoteAccessSessions({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListRemoteAccessSessionsResult

ListRuns

amazonaws_devicefarm.ListRuns({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListRunsResult

ListSamples

amazonaws_devicefarm.ListSamples({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListSamplesResult

ListSuites

amazonaws_devicefarm.ListSuites({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListSuitesResult

ListTests

amazonaws_devicefarm.ListTests({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListTestsResult

ListUniqueProblems

amazonaws_devicefarm.ListUniqueProblems({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListUniqueProblemsResult

ListUploads

amazonaws_devicefarm.ListUploads({
  "arn": ""
}, context)

Input

• input object
  • nextToken string
  • arn required AmazonResourceName
  • nextToken PaginationToken

Output

• output ListUploadsResult

PurchaseOffering

amazonaws_devicefarm.PurchaseOffering({}, context)

Input

• input object
  • offeringId OfferingIdentifier
  • offeringPromotionId OfferingPromotionIdentifier
  • quantity Integer

Output

• output PurchaseOfferingResult

RenewOffering

amazonaws_devicefarm.RenewOffering({}, context)

Input

• input object
  • offeringId OfferingIdentifier
  • quantity Integer

Output

• output RenewOfferingResult

ScheduleRun

amazonaws_devicefarm.ScheduleRun({
  "projectArn": "",
  "devicePoolArn": "",
  "test": {
    "type": ""
  }
}, context)

Input

• input object
  • appArn AmazonResourceName
  • configuration ScheduleRunConfiguration
  • devicePoolArn required AmazonResourceName
  • executionConfiguration ExecutionConfiguration
  • name Name
  • projectArn required AmazonResourceName
  • test required ScheduleRunTest

Output

• output ScheduleRunResult

StopRemoteAccessSession

amazonaws_devicefarm.StopRemoteAccessSession({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output StopRemoteAccessSessionResult

StopRun

amazonaws_devicefarm.StopRun({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName

Output

• output StopRunResult

UpdateDevicePool

amazonaws_devicefarm.UpdateDevicePool({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName
  • description Message
  • name Name
  • rules Rules

Output

• output UpdateDevicePoolResult

UpdateNetworkProfile

amazonaws_devicefarm.UpdateNetworkProfile({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName
  • description Message
  • downlinkBandwidthBits Long
  • downlinkDelayMs Long
  • downlinkJitterMs Long
  • downlinkLossPercent PercentInteger
  • name Name
  • type NetworkProfileType
  • uplinkBandwidthBits Long
  • uplinkDelayMs Long
  • uplinkJitterMs Long
  • uplinkLossPercent PercentInteger

Output

• output UpdateNetworkProfileResult

UpdateProject

amazonaws_devicefarm.UpdateProject({
  "arn": ""
}, context)

Input

• input object
  • arn required AmazonResourceName
  • defaultJobTimeoutMinutes JobTimeoutMinutes
  • name Name

Output

• output UpdateProjectResult

Definitions

AWSAccountNumber

• AWSAccountNumber string

AccountSettings

• AccountSettings object: A container for account-level settings within AWS Device Farm.
  • awsAccountNumber AWSAccountNumber
  • defaultJobTimeoutMinutes JobTimeoutMinutes
  • maxJobTimeoutMinutes JobTimeoutMinutes
  • maxSlots MaxSlotMap
  • trialMinutes TrialMinutes
  • unmeteredDevices PurchasedDevicesMap
  • unmeteredRemoteAccessDevices PurchasedDevicesMap

AccountsCleanup

• AccountsCleanup boolean

AmazonResourceName

• AmazonResourceName string

AmazonResourceNames

• AmazonResourceNames array
  • items AmazonResourceName

AndroidPaths

• AndroidPaths array
  • items String

AppPackagesCleanup

• AppPackagesCleanup boolean

ArgumentException

• ArgumentException object: An invalid argument was specified.
  • message Message

Artifact

• Artifact object: Represents the output of a test. Examples of artifacts include logs and screenshots.
  • arn AmazonResourceName
  • extension String
  • name Name
  • type ArtifactType
  • url URL

ArtifactCategory

• ArtifactCategory string (values: SCREENSHOT, FILE, LOG)

ArtifactType

• ArtifactType string (values: UNKNOWN, SCREENSHOT, DEVICE_LOG, MESSAGE_LOG, VIDEO_LOG, RESULT_LOG, SERVICE_LOG, WEBKIT_LOG, INSTRUMENTATION_OUTPUT, EXERCISER_MONKEY_OUTPUT, CALABASH_JSON_OUTPUT, CALABASH_PRETTY_OUTPUT, CALABASH_STANDARD_OUTPUT, CALABASH_JAVA_XML_OUTPUT, AUTOMATION_OUTPUT, APPIUM_SERVER_OUTPUT, APPIUM_JAVA_OUTPUT, APPIUM_JAVA_XML_OUTPUT, APPIUM_PYTHON_OUTPUT, APPIUM_PYTHON_XML_OUTPUT, EXPLORER_EVENT_LOG, EXPLORER_SUMMARY_LOG, APPLICATION_CRASH_REPORT, XCTEST_LOG, VIDEO, CUSTOMER_ARTIFACT, CUSTOMER_ARTIFACT_LOG)

Artifacts

• Artifacts array
  • items Artifact

BillingMethod

• BillingMethod string (values: METERED, UNMETERED)

Boolean

• Boolean boolean

CPU

• CPU object: Represents the amount of CPU that an app is using on a physical device. Note that this does not represent system-wide CPU usage.
  • architecture String
  • clock Double
  • frequency String

ClientId

• ClientId string

ContentType

• ContentType string

Counters

• Counters object: Represents entity counters.
  • errored Integer
  • failed Integer
  • passed Integer
  • skipped Integer
  • stopped Integer
  • total Integer
  • warned Integer

CreateDevicePoolRequest

• CreateDevicePoolRequest object: Represents a request to the create device pool operation.
  • description Message
  • name required Name
  • projectArn required AmazonResourceName
  • rules required Rules

CreateDevicePoolResult

• CreateDevicePoolResult object: Represents the result of a create device pool request.
  • devicePool DevicePool

CreateNetworkProfileRequest

• CreateNetworkProfileRequest object
  • description Message
  • downlinkBandwidthBits Long
  • downlinkDelayMs Long
  • downlinkJitterMs Long
  • downlinkLossPercent PercentInteger
  • name required Name
  • projectArn required AmazonResourceName
  • type NetworkProfileType
  • uplinkBandwidthBits Long
  • uplinkDelayMs Long
  • uplinkJitterMs Long
  • uplinkLossPercent PercentInteger

CreateNetworkProfileResult

• CreateNetworkProfileResult object
  • networkProfile NetworkProfile

CreateProjectRequest

• CreateProjectRequest object: Represents a request to the create project operation.
  • defaultJobTimeoutMinutes JobTimeoutMinutes
  • name required Name

CreateProjectResult

• CreateProjectResult object: Represents the result of a create project request.
  • project Project

CreateRemoteAccessSessionConfiguration

• CreateRemoteAccessSessionConfiguration object: Creates the configuration settings for a remote access session, including the device model and type.
  • billingMethod BillingMethod

CreateRemoteAccessSessionRequest

• CreateRemoteAccessSessionRequest object: Creates and submits a request to start a remote access session.
  • clientId ClientId
  • configuration CreateRemoteAccessSessionConfiguration
  • deviceArn required AmazonResourceName
  • interactionMode InteractionMode
  • name Name
  • projectArn required AmazonResourceName
  • remoteDebugEnabled Boolean
  • remoteRecordAppArn AmazonResourceName
  • remoteRecordEnabled Boolean
  • sshPublicKey SshPublicKey

CreateRemoteAccessSessionResult

• CreateRemoteAccessSessionResult object: Represents the server response from a request to create a remote access session.
  • remoteAccessSession RemoteAccessSession

CreateUploadRequest

• CreateUploadRequest object: Represents a request to the create upload operation.
  • contentType ContentType
  • name required Name
  • projectArn required AmazonResourceName
  • type required UploadType

CreateUploadResult

• CreateUploadResult object: Represents the result of a create upload request.
  • upload Upload

CurrencyCode

• CurrencyCode string (values: USD)

CustomerArtifactPaths

• CustomerArtifactPaths object: 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.
  • androidPaths AndroidPaths
  • deviceHostPaths DeviceHostPaths
  • iosPaths IosPaths

DateTime

• DateTime string

DeleteDevicePoolRequest

• DeleteDevicePoolRequest object: Represents a request to the delete device pool operation.
  • arn required AmazonResourceName

DeleteDevicePoolResult

• DeleteDevicePoolResult object: Represents the result of a delete device pool request.

DeleteNetworkProfileRequest

• DeleteNetworkProfileRequest object
  • arn required AmazonResourceName

DeleteNetworkProfileResult

• DeleteNetworkProfileResult object

DeleteProjectRequest

• DeleteProjectRequest object: Represents a request to the delete project operation.
  • arn required AmazonResourceName

DeleteProjectResult

• DeleteProjectResult object: Represents the result of a delete project request.

DeleteRemoteAccessSessionRequest

• DeleteRemoteAccessSessionRequest object: Represents the request to delete the specified remote access session.
  • arn required AmazonResourceName

DeleteRemoteAccessSessionResult

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

DeleteRunRequest

• DeleteRunRequest object: Represents a request to the delete run operation.
  • arn required AmazonResourceName

DeleteRunResult

• DeleteRunResult object: Represents the result of a delete run request.

DeleteUploadRequest

• DeleteUploadRequest object: Represents a request to the delete upload operation.
  • arn required AmazonResourceName

DeleteUploadResult

• DeleteUploadResult object: Represents the result of a delete upload request.

Device

• Device object: Represents a device type that an app is tested against.
  • arn AmazonResourceName
  • carrier String
  • cpu CPU
  • fleetName String
  • fleetType String
  • formFactor DeviceFormFactor
  • heapSize Long
  • image String
  • manufacturer String
  • memory Long
  • model String
  • modelId String
  • name Name
  • os String
  • platform DevicePlatform
  • radio String
  • remoteAccessEnabled Boolean
  • remoteDebugEnabled Boolean
  • resolution Resolution

DeviceAttribute

• DeviceAttribute string (values: ARN, PLATFORM, FORM_FACTOR, MANUFACTURER, REMOTE_ACCESS_ENABLED, REMOTE_DEBUG_ENABLED, APPIUM_VERSION)

DeviceFormFactor

• DeviceFormFactor string (values: PHONE, TABLET)

DeviceHostPaths

• DeviceHostPaths array
  • items String

DeviceMinutes

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

DevicePlatform

• DevicePlatform string (values: ANDROID, IOS)

DevicePool

• DevicePool object: Represents a collection of device types.
  • arn AmazonResourceName
  • description Message
  • name Name
  • rules Rules
  • type DevicePoolType

DevicePoolCompatibilityResult

• DevicePoolCompatibilityResult object: Represents a device pool compatibility result.
  • compatible Boolean
  • device Device
  • incompatibilityMessages IncompatibilityMessages

DevicePoolCompatibilityResults

• DevicePoolCompatibilityResults array
  • items DevicePoolCompatibilityResult

DevicePoolType

• DevicePoolType string (values: CURATED, PRIVATE)

DevicePools

• DevicePools array
  • items DevicePool

Devices

• Devices array
  • items Device

Double

• Double number

ExecutionConfiguration

• ExecutionConfiguration object: Represents configuration information about a test run, such as the execution timeout (in minutes).
  • accountsCleanup AccountsCleanup
  • appPackagesCleanup AppPackagesCleanup
  • jobTimeoutMinutes JobTimeoutMinutes

ExecutionResult

• ExecutionResult string (values: PENDING, PASSED, WARNED, FAILED, SKIPPED, ERRORED, STOPPED)

ExecutionResultCode

• ExecutionResultCode string (values: PARSING_FAILED)

ExecutionStatus

• ExecutionStatus string (values: PENDING, PENDING_CONCURRENCY, PENDING_DEVICE, PROCESSING, SCHEDULING, PREPARING, RUNNING, COMPLETED, STOPPING)

Filter

• Filter string

GetAccountSettingsRequest

• GetAccountSettingsRequest object: Represents the request sent to retrieve the account settings.

GetAccountSettingsResult

• GetAccountSettingsResult object: Represents the account settings return values from the GetAccountSettings request.
  • accountSettings AccountSettings

GetDevicePoolCompatibilityRequest

• GetDevicePoolCompatibilityRequest object: Represents a request to the get device pool compatibility operation.
  • appArn AmazonResourceName
  • devicePoolArn required AmazonResourceName
  • test ScheduleRunTest
  • testType TestType

GetDevicePoolCompatibilityResult

• GetDevicePoolCompatibilityResult object: Represents the result of describe device pool compatibility request.
  • compatibleDevices DevicePoolCompatibilityResults
  • incompatibleDevices DevicePoolCompatibilityResults

GetDevicePoolRequest

• GetDevicePoolRequest object: Represents a request to the get device pool operation.
  • arn required AmazonResourceName

GetDevicePoolResult

• GetDevicePoolResult object: Represents the result of a get device pool request.
  • devicePool DevicePool

GetDeviceRequest

• GetDeviceRequest object: Represents a request to the get device request.
  • arn required AmazonResourceName

GetDeviceResult

• GetDeviceResult object: Represents the result of a get device request.
  • device Device

GetJobRequest

• GetJobRequest object: Represents a request to the get job operation.
  • arn required AmazonResourceName

GetJobResult

• GetJobResult object: Represents the result of a get job request.
  • job Job

GetNetworkProfileRequest

• GetNetworkProfileRequest object
  • arn required AmazonResourceName

GetNetworkProfileResult

• GetNetworkProfileResult object
  • networkProfile NetworkProfile

GetOfferingStatusRequest

• GetOfferingStatusRequest object: Represents the request to retrieve the offering status for the specified customer or account.
  • nextToken PaginationToken

GetOfferingStatusResult

• GetOfferingStatusResult object: Returns the status result for a device offering.
  • current OfferingStatusMap
  • nextPeriod OfferingStatusMap
  • nextToken PaginationToken

GetProjectRequest

• GetProjectRequest object: Represents a request to the get project operation.
  • arn required AmazonResourceName

GetProjectResult

• GetProjectResult object: Represents the result of a get project request.
  • project Project

GetRemoteAccessSessionRequest

• GetRemoteAccessSessionRequest object: Represents the request to get information about the specified remote access session.
  • arn required AmazonResourceName

GetRemoteAccessSessionResult

• GetRemoteAccessSessionResult object: Represents the response from the server that lists detailed information about the remote access session.
  • remoteAccessSession RemoteAccessSession

GetRunRequest

• GetRunRequest object: Represents a request to the get run operation.
  • arn required AmazonResourceName

GetRunResult

• GetRunResult object: Represents the result of a get run request.
  • run Run

GetSuiteRequest

• GetSuiteRequest object: Represents a request to the get suite operation.
  • arn required AmazonResourceName

GetSuiteResult

• GetSuiteResult object: Represents the result of a get suite request.
  • suite Suite

GetTestRequest

• GetTestRequest object: Represents a request to the get test operation.
  • arn required AmazonResourceName

GetTestResult

• GetTestResult object: Represents the result of a get test request.
  • test Test

GetUploadRequest

• GetUploadRequest object: Represents a request to the get upload operation.
  • arn required AmazonResourceName

GetUploadResult

• GetUploadResult object: Represents the result of a get upload request.
  • upload Upload

HostAddress

• HostAddress string

IdempotencyException

• IdempotencyException object: An entity with the same name already exists.
  • message Message

IncompatibilityMessage

• IncompatibilityMessage object: Represents information about incompatibility.
  • message Message
  • type DeviceAttribute

IncompatibilityMessages

• IncompatibilityMessages array
  • items IncompatibilityMessage

InstallToRemoteAccessSessionRequest

• InstallToRemoteAccessSessionRequest object: Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.
  • appArn required AmazonResourceName
  • remoteAccessSessionArn required AmazonResourceName

InstallToRemoteAccessSessionResult

• InstallToRemoteAccessSessionResult object: Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
  • appUpload Upload

Integer

• Integer integer

InteractionMode

• InteractionMode string (values: INTERACTIVE, NO_VIDEO, VIDEO_ONLY)

IosPaths

• IosPaths array
  • items String

Job

• Job object: Represents a device.
  • arn AmazonResourceName
  • counters Counters
  • created DateTime
  • device Device
  • deviceMinutes DeviceMinutes
  • message Message
  • name Name
  • result ExecutionResult
  • started DateTime
  • status ExecutionStatus
  • stopped DateTime
  • type TestType

JobTimeoutMinutes

• JobTimeoutMinutes integer

Jobs

• Jobs array
  • items Job

LimitExceededException

• LimitExceededException object: A limit was exceeded.
  • message Message

ListArtifactsRequest

• ListArtifactsRequest object: Represents a request to the list artifacts operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken
  • type required ArtifactCategory

ListArtifactsResult

• ListArtifactsResult object: Represents the result of a list artifacts operation.
  • artifacts Artifacts
  • nextToken PaginationToken

ListDevicePoolsRequest

• ListDevicePoolsRequest object: Represents the result of a list device pools request.
  • arn required AmazonResourceName
  • nextToken PaginationToken
  • type DevicePoolType

ListDevicePoolsResult

• ListDevicePoolsResult object: Represents the result of a list device pools request.
  • devicePools DevicePools
  • nextToken PaginationToken

ListDevicesRequest

• ListDevicesRequest object: Represents the result of a list devices request.
  • arn AmazonResourceName
  • nextToken PaginationToken

ListDevicesResult

• ListDevicesResult object: Represents the result of a list devices operation.
  • devices Devices
  • nextToken PaginationToken

ListJobsRequest

• ListJobsRequest object: Represents a request to the list jobs operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListJobsResult

• ListJobsResult object: Represents the result of a list jobs request.
  • jobs Jobs
  • nextToken PaginationToken

ListNetworkProfilesRequest

• ListNetworkProfilesRequest object
  • arn required AmazonResourceName
  • nextToken PaginationToken
  • type NetworkProfileType

ListNetworkProfilesResult

• ListNetworkProfilesResult object
  • networkProfiles NetworkProfiles
  • nextToken PaginationToken

ListOfferingPromotionsRequest

• ListOfferingPromotionsRequest object
  • nextToken PaginationToken

ListOfferingPromotionsResult

• ListOfferingPromotionsResult object
  • nextToken PaginationToken
  • offeringPromotions OfferingPromotions

ListOfferingTransactionsRequest

• ListOfferingTransactionsRequest object: Represents the request to list the offering transaction history.
  • nextToken PaginationToken

ListOfferingTransactionsResult

• ListOfferingTransactionsResult object: Returns the transaction log of the specified offerings.
  • nextToken PaginationToken
  • offeringTransactions OfferingTransactions

ListOfferingsRequest

• ListOfferingsRequest object: Represents the request to list all offerings.
  • nextToken PaginationToken

ListOfferingsResult

• ListOfferingsResult object: Represents the return values of the list of offerings.
  • nextToken PaginationToken
  • offerings Offerings

ListProjectsRequest

• ListProjectsRequest object: Represents a request to the list projects operation.
  • arn AmazonResourceName
  • nextToken PaginationToken

ListProjectsResult

• ListProjectsResult object: Represents the result of a list projects request.
  • nextToken PaginationToken
  • projects Projects

ListRemoteAccessSessionsRequest

• ListRemoteAccessSessionsRequest object: Represents the request to return information about the remote access session.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListRemoteAccessSessionsResult

• ListRemoteAccessSessionsResult object: Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
  • nextToken PaginationToken
  • remoteAccessSessions RemoteAccessSessions

ListRunsRequest

• ListRunsRequest object: Represents a request to the list runs operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListRunsResult

• ListRunsResult object: Represents the result of a list runs request.
  • nextToken PaginationToken
  • runs Runs

ListSamplesRequest

• ListSamplesRequest object: Represents a request to the list samples operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListSamplesResult

• ListSamplesResult object: Represents the result of a list samples request.
  • nextToken PaginationToken
  • samples Samples

ListSuitesRequest

• ListSuitesRequest object: Represents a request to the list suites operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListSuitesResult

• ListSuitesResult object: Represents the result of a list suites request.
  • nextToken PaginationToken
  • suites Suites

ListTestsRequest

• ListTestsRequest object: Represents a request to the list tests operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListTestsResult

• ListTestsResult object: Represents the result of a list tests request.
  • nextToken PaginationToken
  • tests Tests

ListUniqueProblemsRequest

• ListUniqueProblemsRequest object: Represents a request to the list unique problems operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListUniqueProblemsResult

• ListUniqueProblemsResult object: Represents the result of a list unique problems request.
  • nextToken PaginationToken
  • uniqueProblems UniqueProblemsByExecutionResultMap

ListUploadsRequest

• ListUploadsRequest object: Represents a request to the list uploads operation.
  • arn required AmazonResourceName
  • nextToken PaginationToken

ListUploadsResult

• ListUploadsResult object: Represents the result of a list uploads request.
  • nextToken PaginationToken
  • uploads Uploads

Location

• Location object: Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491). Elevation is currently not supported.
  • latitude required Double
  • longitude required Double

Long

• Long integer

MaxSlotMap

• MaxSlotMap array
  • items object
    • key String
    • value Integer

Message

• Message string

Metadata

• Metadata string

MonetaryAmount

• MonetaryAmount object: A number representing the monetary amount for an offering or transaction.
  • amount Double
  • currencyCode CurrencyCode

Name

• Name string

NetworkProfile

• NetworkProfile object: An array of settings that describes characteristics of a network profile.
  • arn AmazonResourceName
  • description Message
  • downlinkBandwidthBits Long
  • downlinkDelayMs Long
  • downlinkJitterMs Long
  • downlinkLossPercent PercentInteger
  • name Name
  • type NetworkProfileType
  • uplinkBandwidthBits Long
  • uplinkDelayMs Long
  • uplinkJitterMs Long
  • uplinkLossPercent PercentInteger

NetworkProfileType

• NetworkProfileType string (values: CURATED, PRIVATE)

NetworkProfiles

• NetworkProfiles array
  • items NetworkProfile

NotEligibleException

• NotEligibleException object: Exception gets thrown when a user is not eligible to perform the specified transaction.
  • message Message

NotFoundException

• NotFoundException object: The specified entity was not found.
  • message Message

Offering

• Offering object: Represents the metadata of a device offering.
  • description Message
  • id OfferingIdentifier
  • platform DevicePlatform
  • recurringCharges RecurringCharges
  • type OfferingType

OfferingIdentifier

• OfferingIdentifier string

OfferingPromotion

• OfferingPromotion object: Represents information about an offering promotion.
  • description Message
  • id OfferingPromotionIdentifier

OfferingPromotionIdentifier

• OfferingPromotionIdentifier string

OfferingPromotions

• OfferingPromotions array
  • items OfferingPromotion

OfferingStatus

• OfferingStatus object: The status of the offering.
  • effectiveOn DateTime
  • offering Offering
  • quantity Integer
  • type OfferingTransactionType

OfferingStatusMap

• OfferingStatusMap array
  • items object
    • key OfferingIdentifier
    • value OfferingStatus

OfferingTransaction

• OfferingTransaction object: Represents the metadata of an offering transaction.
  • cost MonetaryAmount
  • createdOn DateTime
  • offeringPromotionId OfferingPromotionIdentifier
  • offeringStatus OfferingStatus
  • transactionId TransactionIdentifier

OfferingTransactionType

• OfferingTransactionType string (values: PURCHASE, RENEW, SYSTEM)

OfferingTransactions

• OfferingTransactions array
  • items OfferingTransaction

OfferingType

• OfferingType string (values: RECURRING)

Offerings

• Offerings array
  • items Offering

PaginationToken

• PaginationToken string

PercentInteger

• PercentInteger integer

Problem

• Problem object: Represents a specific warning or failure.
  • device Device
  • job ProblemDetail
  • message Message
  • result ExecutionResult
  • run ProblemDetail
  • suite ProblemDetail
  • test ProblemDetail

ProblemDetail

• ProblemDetail object: Information about a problem detail.
  • arn AmazonResourceName
  • name Name

Problems

• Problems array
  • items Problem

Project

• Project object: Represents an operating-system neutral workspace for running and managing tests.
  • arn AmazonResourceName
  • created DateTime
  • defaultJobTimeoutMinutes JobTimeoutMinutes
  • name Name

Projects

• Projects array
  • items Project

PurchaseOfferingRequest

• PurchaseOfferingRequest object: Represents a request for a purchase offering.
  • offeringId OfferingIdentifier
  • offeringPromotionId OfferingPromotionIdentifier
  • quantity Integer

PurchaseOfferingResult

• PurchaseOfferingResult object: The result of the purchase offering (e.g., success or failure).
  • offeringTransaction OfferingTransaction

PurchasedDevicesMap

• PurchasedDevicesMap array
  • items object
    • key DevicePlatform
    • value Integer

Radios

• Radios object: Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
  • bluetooth Boolean
  • gps Boolean
  • nfc Boolean
  • wifi Boolean

RecurringCharge

• RecurringCharge object: Specifies whether charges for devices will be recurring.
  • cost MonetaryAmount
  • frequency RecurringChargeFrequency

RecurringChargeFrequency

• RecurringChargeFrequency string (values: MONTHLY)

RecurringCharges

• RecurringCharges array
  • items RecurringCharge

RemoteAccessSession

• RemoteAccessSession object: Represents information about the remote access session.
  • arn AmazonResourceName
  • billingMethod BillingMethod
  • clientId ClientId
  • created DateTime
  • device Device
  • deviceMinutes DeviceMinutes
  • deviceUdid String
  • endpoint String
  • hostAddress HostAddress
  • interactionMode InteractionMode
  • message Message
  • name Name
  • remoteDebugEnabled Boolean
  • remoteRecordAppArn AmazonResourceName
  • remoteRecordEnabled Boolean
  • result ExecutionResult
  • started DateTime
  • status ExecutionStatus
  • stopped DateTime

RemoteAccessSessions

• RemoteAccessSessions array
  • items RemoteAccessSession

RenewOfferingRequest

• RenewOfferingRequest object: A request representing an offering renewal.
  • offeringId OfferingIdentifier
  • quantity Integer

RenewOfferingResult

• RenewOfferingResult object: The result of a renewal offering.
  • offeringTransaction OfferingTransaction

Resolution

• Resolution object: Represents the screen resolution of a device in height and width, expressed in pixels.
  • height Integer
  • width Integer

Rule

• Rule object: Represents a condition for a device pool.
  • attribute DeviceAttribute
  • operator RuleOperator
  • value String

RuleOperator

• RuleOperator string (values: EQUALS, LESS_THAN, GREATER_THAN, IN, NOT_IN, CONTAINS)

Rules

• Rules array
  • items Rule

Run

• Run object: Represents a test run on a set of devices with a given app package, test parameters, etc.
  • appUpload AmazonResourceName
  • arn AmazonResourceName
  • billingMethod BillingMethod
  • completedJobs Integer
  • counters Counters
  • created DateTime
  • customerArtifactPaths CustomerArtifactPaths
  • deviceMinutes DeviceMinutes
  • devicePoolArn AmazonResourceName
  • eventCount Integer
  • jobTimeoutMinutes JobTimeoutMinutes
  • locale String
  • location Location
  • message Message
  • name Name
  • networkProfile NetworkProfile
  • parsingResultUrl String
  • platform DevicePlatform
  • radios Radios
  • result ExecutionResult
  • resultCode ExecutionResultCode
  • seed Integer
  • started DateTime
  • status ExecutionStatus
  • stopped DateTime
  • totalJobs Integer
  • type TestType
  • webUrl String

Runs

• Runs array
  • items Run

Sample

• Sample object: Represents a sample of performance data.
  • arn AmazonResourceName
  • type SampleType
  • url URL

SampleType

• SampleType string (values: CPU, MEMORY, THREADS, RX_RATE, TX_RATE, RX, TX, NATIVE_FRAMES, NATIVE_FPS, NATIVE_MIN_DRAWTIME, NATIVE_AVG_DRAWTIME, NATIVE_MAX_DRAWTIME, OPENGL_FRAMES, OPENGL_FPS, OPENGL_MIN_DRAWTIME, OPENGL_AVG_DRAWTIME, OPENGL_MAX_DRAWTIME)

Samples

• Samples array
  • items Sample

ScheduleRunConfiguration

• ScheduleRunConfiguration object: Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.
  • auxiliaryApps AmazonResourceNames
  • billingMethod BillingMethod
  • customerArtifactPaths CustomerArtifactPaths
  • extraDataPackageArn AmazonResourceName
  • locale String
  • location Location
  • networkProfileArn AmazonResourceName
  • radios Radios

ScheduleRunRequest

• ScheduleRunRequest object: Represents a request to the schedule run operation.
  • appArn AmazonResourceName
  • configuration ScheduleRunConfiguration
  • devicePoolArn required AmazonResourceName
  • executionConfiguration ExecutionConfiguration
  • name Name
  • projectArn required AmazonResourceName
  • test required ScheduleRunTest

ScheduleRunResult

• ScheduleRunResult object: Represents the result of a schedule run request.
  • run Run

ScheduleRunTest

• ScheduleRunTest object: Represents additional test settings.
  • filter Filter
  • parameters TestParameters
  • testPackageArn AmazonResourceName
  • type required TestType

ServiceAccountException

• ServiceAccountException object: There was a problem with the service account.
  • message Message

SshPublicKey

• SshPublicKey string

StopRemoteAccessSessionRequest

• StopRemoteAccessSessionRequest object: Represents the request to stop the remote access session.
  • arn required AmazonResourceName

StopRemoteAccessSessionResult

• StopRemoteAccessSessionResult object: Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
  • remoteAccessSession RemoteAccessSession

StopRunRequest

• StopRunRequest object: Represents the request to stop a specific run.
  • arn required AmazonResourceName

StopRunResult

• StopRunResult object: Represents the results of your stop run attempt.
  • run Run

String

• String string

Suite

• Suite object: Represents a collection of one or more tests.
  • arn AmazonResourceName
  • counters Counters
  • created DateTime
  • deviceMinutes DeviceMinutes
  • message Message
  • name Name
  • result ExecutionResult
  • started DateTime
  • status ExecutionStatus
  • stopped DateTime
  • type TestType

Suites

• Suites array
  • items Suite

Test

• Test object: Represents a condition that is evaluated.
  • arn AmazonResourceName
  • counters Counters
  • created DateTime
  • deviceMinutes DeviceMinutes
  • message Message
  • name Name
  • result ExecutionResult
  • started DateTime
  • status ExecutionStatus
  • stopped DateTime
  • type TestType

TestParameters

• TestParameters array
  • items object
    • key String
    • value String

TestType

• TestType string (values: BUILTIN_FUZZ, BUILTIN_EXPLORER, WEB_PERFORMANCE_PROFILE, APPIUM_JAVA_JUNIT, APPIUM_JAVA_TESTNG, APPIUM_PYTHON, APPIUM_WEB_JAVA_JUNIT, APPIUM_WEB_JAVA_TESTNG, APPIUM_WEB_PYTHON, CALABASH, INSTRUMENTATION, UIAUTOMATION, UIAUTOMATOR, XCTEST, XCTEST_UI, REMOTE_ACCESS_RECORD, REMOTE_ACCESS_REPLAY)

Tests

• Tests array
  • items Test

TransactionIdentifier

• TransactionIdentifier string

TrialMinutes

• TrialMinutes object: Represents information about free trial device minutes for an AWS account.
  • remaining Double
  • total Double

URL

• URL string

UniqueProblem

• UniqueProblem object: A collection of one or more problems, grouped by their result.
  • message Message
  • problems Problems

UniqueProblems

• UniqueProblems array
  • items UniqueProblem

UniqueProblemsByExecutionResultMap

• UniqueProblemsByExecutionResultMap array
  • items object
    • key ExecutionResult
    • value UniqueProblems

UpdateDevicePoolRequest

• UpdateDevicePoolRequest object: Represents a request to the update device pool operation.
  • arn required AmazonResourceName
  • description Message
  • name Name
  • rules Rules

UpdateDevicePoolResult

• UpdateDevicePoolResult object: Represents the result of an update device pool request.
  • devicePool DevicePool

UpdateNetworkProfileRequest

• UpdateNetworkProfileRequest object
  • arn required AmazonResourceName
  • description Message
  • downlinkBandwidthBits Long
  • downlinkDelayMs Long
  • downlinkJitterMs Long
  • downlinkLossPercent PercentInteger
  • name Name
  • type NetworkProfileType
  • uplinkBandwidthBits Long
  • uplinkDelayMs Long
  • uplinkJitterMs Long
  • uplinkLossPercent PercentInteger

UpdateNetworkProfileResult

• UpdateNetworkProfileResult object
  • networkProfile NetworkProfile

UpdateProjectRequest

• UpdateProjectRequest object: Represents a request to the update project operation.
  • arn required AmazonResourceName
  • defaultJobTimeoutMinutes JobTimeoutMinutes
  • name Name

UpdateProjectResult

• UpdateProjectResult object: Represents the result of an update project request.
  • project Project

Upload

• Upload object: An app or a set of one or more tests to upload or that have been uploaded.
  • arn AmazonResourceName
  • contentType ContentType
  • created DateTime
  • message Message
  • metadata Metadata
  • name Name
  • status UploadStatus
  • type UploadType
  • url URL

UploadStatus

• UploadStatus string (values: INITIALIZED, PROCESSING, SUCCEEDED, FAILED)

UploadType

• UploadType string (values: ANDROID_APP, IOS_APP, WEB_APP, EXTERNAL_DATA, APPIUM_JAVA_JUNIT_TEST_PACKAGE, APPIUM_JAVA_TESTNG_TEST_PACKAGE, APPIUM_PYTHON_TEST_PACKAGE, APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE, APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE, APPIUM_WEB_PYTHON_TEST_PACKAGE, CALABASH_TEST_PACKAGE, INSTRUMENTATION_TEST_PACKAGE, UIAUTOMATION_TEST_PACKAGE, UIAUTOMATOR_TEST_PACKAGE, XCTEST_TEST_PACKAGE, XCTEST_UI_TEST_PACKAGE)

Uploads

• Uploads array
  • items Upload