"documentation":"<p>Deletes an AWS Device Farm project, given the project ARN.</p> <p> <b>Note</b> Deleting this resource does not stop an in-progress run.</p>"
"documentation":"<p>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 operation.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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 operation.</p>"
},
"ListOfferings":{
"name":"ListOfferings",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListOfferingsRequest"},
"output":{"shape":"ListOfferingsResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"NotEligibleException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>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 operation.</p>"
"documentation":"<p>Gets information about uploads, given an AWS Device Farm project ARN.</p>"
},
"PurchaseOffering":{
"name":"PurchaseOffering",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PurchaseOfferingRequest"},
"output":{"shape":"PurchaseOfferingResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"NotEligibleException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>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 operation.</p>"
},
"RenewOffering":{
"name":"RenewOffering",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RenewOfferingRequest"},
"output":{"shape":"RenewOfferingResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"NotEligibleException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>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 operation.</p>"
"documentation":"<p>Ends a specified remote access session.</p>"
},
"StopRun":{
"name":"StopRun",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopRunRequest"},
"output":{"shape":"StopRunResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>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.</p>"
"documentation":"<p>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).</p>"
},
"UpdateProject":{
"name":"UpdateProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateProjectRequest"},
"output":{"shape":"UpdateProjectResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Modifies the specified project name, given the project ARN and a new name.</p>"
}
},
"shapes":{
"AWSAccountNumber":{
"type":"string",
"max":16,
"min":2
},
"AccountSettings":{
"type":"structure",
"members":{
"awsAccountNumber":{
"shape":"AWSAccountNumber",
"documentation":"<p>The AWS account number specified in the <code>AccountSettings</code> container.</p>"
"documentation":"<p>The artifact's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>UNKNOWN: An unknown type.</p> </li> <li> <p>SCREENSHOT: The screenshot type.</p> </li> <li> <p>DEVICE_LOG: The device log type.</p> </li> <li> <p>MESSAGE_LOG: The message log type.</p> </li> <li> <p>RESULT_LOG: The result log type.</p> </li> <li> <p>SERVICE_LOG: The service log type.</p> </li> <li> <p>WEBKIT_LOG: The web kit log type.</p> </li> <li> <p>INSTRUMENTATION_OUTPUT: The instrumentation type.</p> </li> <li> <p>EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.</p> </li> <li> <p>CALABASH_JSON_OUTPUT: The Calabash JSON output type.</p> </li> <li> <p>CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.</p> </li> <li> <p>CALABASH_STANDARD_OUTPUT: The Calabash standard output type.</p> </li> <li> <p>CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.</p> </li> <li> <p>AUTOMATION_OUTPUT: The automation output type.</p> </li> <li> <p>APPIUM_SERVER_OUTPUT: The Appium server output type.</p> </li> <li> <p>APPIUM_JAVA_OUTPUT: The Appium Java output type.</p> </li> <li> <p>APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.</p> </li> <li> <p>APPIUM_PYTHON_OUTPUT: The Appium Python output type.</p> </li> <li> <p>APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.</p> </li> <li> <p>EXPLORER_EVENT_LOG: The Explorer event log output type.</p> </li> <li> <p>EXPLORER_SUMMARY_LOG: The Explorer summary log output type.</p> </li> <li> <p>APPLICATION_CRASH_REPORT: The application crash report output type.</p> </li> <li> <p>XCTEST_LOG: The XCode test output type.</p> </li> </ul>"
"documentation":"<p>The CPU's architecture, for example x86 or ARM.</p>"
},
"clock":{
"shape":"Double",
"documentation":"<p>The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.</p>"
}
},
"documentation":"<p>Represents the amount of CPU that an app is using on a physical device.</p> <p>Note that this does not represent system-wide CPU usage.</p>"
},
"ContentType":{
"type":"string",
"max":64,
"min":0
},
"Counters":{
"type":"structure",
"members":{
"total":{
"shape":"Integer",
"documentation":"<p>The total number of entities.</p>"
},
"passed":{
"shape":"Integer",
"documentation":"<p>The number of passed entities.</p>"
},
"failed":{
"shape":"Integer",
"documentation":"<p>The number of failed entities.</p>"
},
"warned":{
"shape":"Integer",
"documentation":"<p>The number of warned entities.</p>"
},
"errored":{
"shape":"Integer",
"documentation":"<p>The number of errored entities.</p>"
},
"stopped":{
"shape":"Integer",
"documentation":"<p>The number of stopped entities.</p>"
},
"skipped":{
"shape":"Integer",
"documentation":"<p>The number of skipped entities.</p>"
"documentation":"<p>The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the <code>.ipa</code> extension. If uploading an Android app, the file name needs to end with the <code>.apk</code> extension. For all others, the file name must end with the <code>.zip</code> file extension.</p>"
"documentation":"<p>The upload's upload type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> </ul> <p> <b>Note</b> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error.</p>"
"documentation":"<p>The device's form factor.</p> <p>Allowed values include:</p> <ul> <li> <p>PHONE: The phone form factor.</p> </li> <li> <p>TABLET: The tablet form factor.</p> </li> </ul>"
"documentation":"<p>When specified, represents the total minutes used by the resource to run tests.</p>"
},
"metered":{
"shape":"Double",
"documentation":"<p>When specified, represents only the sum of metered minutes used by the resource to run tests.</p>"
},
"unmetered":{
"shape":"Double",
"documentation":"<p>When specified, represents only the sum of unmetered minutes used by the resource to run tests.</p>"
}
},
"documentation":"<p>Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.</p>"
"documentation":"<p>The device pool's type.</p> <p>Allowed values include:</p> <ul> <li> <p>CURATED: A device pool that is created and managed by AWS Device Farm.</p> </li> <li> <p>PRIVATE: A device pool that is created and managed by the device pool developer.</p> </li> </ul>"
"documentation":"<p>The test type for the specified device pool.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the request to retrieve the offering status for the specified customer or account.</p>"
},
"GetOfferingStatusResult":{
"type":"structure",
"members":{
"current":{
"shape":"OfferingStatusMap",
"documentation":"<p>When specified, gets the offering status for the current period.</p>"
},
"nextPeriod":{
"shape":"OfferingStatusMap",
"documentation":"<p>When specified, gets the offering status for the next period.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Returns the status result for a device offering.</p>"
"documentation":"<p>The type of incompatibility.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> </ul>"
"documentation":"<p>The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.</p>"
},
"appArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the app about which you are requesting information.</p>"
}
},
"documentation":"<p>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.</p>"
},
"InstallToRemoteAccessSessionResult":{
"type":"structure",
"members":{
"appUpload":{"shape":"Upload"}
},
"documentation":"<p>Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.</p>"
"documentation":"<p>The job's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The artifacts' type.</p> <p>Allowed values include:</p> <ul> <li> <p>FILE: The artifacts are files.</p> </li> <li> <p>LOG: The artifacts are logs.</p> </li> <li> <p>SCREENSHOT: The artifacts are screenshots.</p> </li> </ul>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list artifacts operation.</p>"
},
"ListArtifactsResult":{
"type":"structure",
"members":{
"artifacts":{
"shape":"Artifacts",
"documentation":"<p>Information about the artifacts.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list artifacts operation.</p>"
"documentation":"<p>The device pools' type.</p> <p>Allowed values include:</p> <ul> <li> <p>CURATED: A device pool that is created and managed by AWS Device Farm.</p> </li> <li> <p>PRIVATE: A device pool that is created and managed by the device pool developer.</p> </li> </ul>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list device pools request.</p>"
},
"ListDevicePoolsResult":{
"type":"structure",
"members":{
"devicePools":{
"shape":"DevicePools",
"documentation":"<p>Information about the device pools.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list device pools request.</p>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list devices request.</p>"
},
"ListDevicesResult":{
"type":"structure",
"members":{
"devices":{
"shape":"Devices",
"documentation":"<p>Information about the devices.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list devices operation.</p>"
},
"ListJobsRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The jobs' ARNs.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list jobs operation.</p>"
},
"ListJobsResult":{
"type":"structure",
"members":{
"jobs":{
"shape":"Jobs",
"documentation":"<p>Information about the jobs.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list jobs request.</p>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the request to list the offering transaction history.</p>"
},
"ListOfferingTransactionsResult":{
"type":"structure",
"members":{
"offeringTransactions":{
"shape":"OfferingTransactions",
"documentation":"<p>The audit log of subscriptions you have purchased and modified through AWS Device Farm.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Returns the transaction log of the specified offerings.</p>"
},
"ListOfferingsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the request to list all offerings.</p>"
},
"ListOfferingsResult":{
"type":"structure",
"members":{
"offerings":{
"shape":"Offerings",
"documentation":"<p>A value representing the list offering results.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the return values of the list of offerings.</p>"
"documentation":"<p>Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.</p>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list projects operation.</p>"
},
"ListProjectsResult":{
"type":"structure",
"members":{
"projects":{
"shape":"Projects",
"documentation":"<p>Information about the projects.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list projects request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the request to return information about the remote access session.</p>"
},
"ListRemoteAccessSessionsResult":{
"type":"structure",
"members":{
"remoteAccessSessions":{
"shape":"RemoteAccessSessions",
"documentation":"<p>A container representing the metadata from the service about each remote access session you are requesting.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.</p>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list runs operation.</p>"
},
"ListRunsResult":{
"type":"structure",
"members":{
"runs":{
"shape":"Runs",
"documentation":"<p>Information about the runs.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list runs request.</p>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list samples operation.</p>"
},
"ListSamplesResult":{
"type":"structure",
"members":{
"samples":{
"shape":"Samples",
"documentation":"<p>Information about the samples.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list samples request.</p>"
},
"ListSuitesRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The suites' ARNs.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list suites operation.</p>"
},
"ListSuitesResult":{
"type":"structure",
"members":{
"suites":{
"shape":"Suites",
"documentation":"<p>Information about the suites.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list suites request.</p>"
},
"ListTestsRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The tests' ARNs.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list tests operation.</p>"
},
"ListTestsResult":{
"type":"structure",
"members":{
"tests":{
"shape":"Tests",
"documentation":"<p>Information about the tests.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list tests request.</p>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list unique problems operation.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list unique problems request.</p>"
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents a request to the list uploads operation.</p>"
},
"ListUploadsResult":{
"type":"structure",
"members":{
"uploads":{
"shape":"Uploads",
"documentation":"<p>Information about the uploads.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list uploads request.</p>"
},
"Location":{
"type":"structure",
"required":[
"latitude",
"longitude"
],
"members":{
"latitude":{
"shape":"Double",
"documentation":"<p>The latitude.</p>"
},
"longitude":{
"shape":"Double",
"documentation":"<p>The longitude.</p>"
}
},
"documentation":"<p>Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).</p> <p>Elevation is currently not supported.</p>"
"documentation":"<p>The cost of the recurring charge.</p>"
},
"frequency":{
"shape":"RecurringChargeFrequency",
"documentation":"<p>The frequency in which charges will recur.</p>"
}
},
"documentation":"<p>Specifies whether charges for devices will be recurring.</p>"
},
"RecurringChargeFrequency":{
"type":"string",
"enum":["MONTHLY"]
},
"RecurringCharges":{
"type":"list",
"member":{"shape":"RecurringCharge"}
},
"RemoteAccessSession":{
"type":"structure",
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the remote access session.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the remote access session.</p>"
},
"created":{
"shape":"DateTime",
"documentation":"<p>The date and time the remote access session was created.</p>"
},
"status":{
"shape":"ExecutionStatus",
"documentation":"<p>The status of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING: A pending status.</p> </li> <li> <p>PENDING_CONCURRENCY: A pending concurrency status.</p> </li> <li> <p>PENDING_DEVICE: A pending device status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SCHEDULING: A scheduling status.</p> </li> <li> <p>PREPARING: A preparing status.</p> </li> <li> <p>RUNNING: A running status.</p> </li> <li> <p>COMPLETED: A completed status.</p> </li> <li> <p>STOPPING: A stopping status.</p> </li> </ul>"
},
"result":{
"shape":"ExecutionResult",
"documentation":"<p>The result of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
},
"message":{
"shape":"Message",
"documentation":"<p>A message about the remote access session.</p>"
},
"started":{
"shape":"DateTime",
"documentation":"<p>The date and time the remote access session was started.</p>"
},
"stopped":{
"shape":"DateTime",
"documentation":"<p>The date and time the remote access session was stopped.</p>"
},
"device":{"shape":"Device"},
"billingMethod":{
"shape":"BillingMethod",
"documentation":"<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"http://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.\"</p>"
},
"deviceMinutes":{"shape":"DeviceMinutes"},
"endpoint":{
"shape":"String",
"documentation":"<p>The endpoint for the remote access sesssion.</p>"
}
},
"documentation":"<p>Represents information about the remote access session.</p>"
},
"RemoteAccessSessions":{
"type":"list",
"member":{"shape":"RemoteAccessSession"}
},
"RenewOfferingRequest":{
"type":"structure",
"members":{
"offeringId":{
"shape":"OfferingIdentifier",
"documentation":"<p>The ID of a request to renew an offering.</p>"
},
"quantity":{
"shape":"Integer",
"documentation":"<p>The quantity requested in an offering renewal.</p>"
}
},
"documentation":"<p>A request representing an offering renewal.</p>"
},
"RenewOfferingResult":{
"type":"structure",
"members":{
"offeringTransaction":{
"shape":"OfferingTransaction",
"documentation":"<p>Represents the status of the offering transaction for the renewal.</p>"
}
},
"documentation":"<p>The result of a renewal offering.</p>"
"documentation":"<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> </ul>"
"documentation":"<p>The run's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>"
"documentation":"<p>The sample's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.</p> </li> <li> <p>MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.</p> </li> <li> <p>NATIVE_AVG_DRAWTIME</p> </li> <li> <p>NATIVE_FPS</p> </li> <li> <p>NATIVE_FRAMES</p> </li> <li> <p>NATIVE_MAX_DRAWTIME</p> </li> <li> <p>NATIVE_MIN_DRAWTIME</p> </li> <li> <p>OPENGL_AVG_DRAWTIME</p> </li> <li> <p>OPENGL_FPS</p> </li> <li> <p>OPENGL_FRAMES</p> </li> <li> <p>OPENGL_MAX_DRAWTIME</p> </li> <li> <p>OPENGL_MIN_DRAWTIME</p> </li> <li> <p>RX</p> </li> <li> <p>RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.</p> </li> <li> <p>THREADS: A threads sample type. This is expressed as the total number of threads per app process.</p> </li> <li> <p>TX</p> </li> <li> <p>TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.</p> </li> </ul>"
"documentation":"<p>The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.</p>"
}
},
"documentation":"<p>Represents a sample of performance data.</p>"
},
"SampleType":{
"type":"string",
"enum":[
"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":{
"type":"list",
"member":{"shape":"Sample"}
},
"ScheduleRunConfiguration":{
"type":"structure",
"members":{
"extraDataPackageArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.</p>"
},
"networkProfileArn":{
"shape":"AmazonResourceName",
"documentation":"<p>Reserved for internal use.</p>"
},
"locale":{
"shape":"String",
"documentation":"<p>Information about the locale that is used for the run.</p>"
},
"location":{
"shape":"Location",
"documentation":"<p>Information about the location that is used for the run.</p>"
},
"radios":{
"shape":"Radios",
"documentation":"<p>Information about the radio states for the run.</p>"
},
"auxiliaryApps":{
"shape":"AmazonResourceNames",
"documentation":"<p>A list of auxiliary apps for the run.</p>"
"documentation":"<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>"
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The suite's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>A message about the unique problems' result.</p>"
},
"problems":{
"shape":"Problems",
"documentation":"<p>Information about the problems.</p>"
}
},
"documentation":"<p>A collection of one or more problems, grouped by their result.</p>"
},
"UniqueProblems":{
"type":"list",
"member":{"shape":"UniqueProblem"}
},
"UniqueProblemsByExecutionResultMap":{
"type":"map",
"key":{"shape":"ExecutionResult"},
"value":{"shape":"UniqueProblems"}
},
"UpdateDevicePoolRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>A string representing the name of the device pool you wish to update.</p>"
},
"description":{
"shape":"Message",
"documentation":"<p>A description of the device pool you wish to update.</p>"
},
"rules":{
"shape":"Rules",
"documentation":"<p>Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.</p>"
}
},
"documentation":"<p>Represents a request to the update device pool operation.</p>"
},
"UpdateDevicePoolResult":{
"type":"structure",
"members":{
"devicePool":{"shape":"DevicePool"}
},
"documentation":"<p>Represents the result of an update device pool request.</p>"
},
"UpdateProjectRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the project whose name you wish to update.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>A string representing the new name of the project that you are updating.</p>"
}
},
"documentation":"<p>Represents a request to the update project operation.</p>"
},
"UpdateProjectResult":{
"type":"structure",
"members":{
"project":{"shape":"Project"}
},
"documentation":"<p>Represents the result of an update project request.</p>"
},
"Upload":{
"type":"structure",
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The upload's ARN.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>The upload's file name.</p>"
},
"created":{
"shape":"DateTime",
"documentation":"<p>When the upload was created.</p>"
"documentation":"<p>The upload's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> </ul>"
"documentation":"<p>The upload's status.</p> <p>Must be one of the following values:</p> <ul> <li> <p>FAILED: A failed status.</p> </li> <li> <p>INITIALIZED: An initialized status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SUCCEEDED: A succeeded status.</p> </li> </ul>"
"documentation":"<p>The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.</p>"
},
"metadata":{
"shape":"Metadata",
"documentation":"<p>The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.</p>"
},
"contentType":{
"shape":"ContentType",
"documentation":"<p>The upload's content type (for example, \"application/octet-stream\").</p>"
},
"message":{
"shape":"Message",
"documentation":"<p>A message about the upload's result.</p>"
}
},
"documentation":"<p>An app or a set of one or more tests to upload or that have been uploaded.</p>"
"documentation":"<p>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.</p>"