aws-sdk-for-zig/codegen/models/devicefarm.2015-06-23.json

9093 lines
444 KiB
JSON
Raw Permalink Normal View History

2021-05-30 01:17:45 +00:00
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.devicefarm#AWSAccountNumber": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 2,
"max": 16
}
}
},
"com.amazonaws.devicefarm#AccountSettings": {
"type": "structure",
"members": {
"awsAccountNumber": {
"target": "com.amazonaws.devicefarm#AWSAccountNumber",
"traits": {
"smithy.api#documentation": "<p>The AWS account number specified in the <code>AccountSettings</code>\n container.</p>"
}
},
"unmeteredDevices": {
"target": "com.amazonaws.devicefarm#PurchasedDevicesMap",
"traits": {
"smithy.api#documentation": "<p>Returns the unmetered devices you have purchased or want to purchase.</p>"
}
},
"unmeteredRemoteAccessDevices": {
"target": "com.amazonaws.devicefarm#PurchasedDevicesMap",
"traits": {
"smithy.api#documentation": "<p>Returns the unmetered remote access devices you have purchased or want to\n purchase.</p>"
}
},
"maxJobTimeoutMinutes": {
"target": "com.amazonaws.devicefarm#JobTimeoutMinutes",
"traits": {
"smithy.api#documentation": "<p>The maximum number of minutes a test run executes before it times out.</p>"
}
},
"trialMinutes": {
"target": "com.amazonaws.devicefarm#TrialMinutes",
"traits": {
"smithy.api#documentation": "<p>Information about an AWS account's usage of free trial device minutes.</p>"
}
},
"maxSlots": {
"target": "com.amazonaws.devicefarm#MaxSlotMap",
"traits": {
"smithy.api#documentation": "<p>The maximum number of device slots that the AWS account can purchase. Each maximum\n is expressed as an <code>offering-id:number</code> pair, where the\n <code>offering-id</code> represents one of the IDs returned by the\n <code>ListOfferings</code> command.</p>"
}
},
"defaultJobTimeoutMinutes": {
"target": "com.amazonaws.devicefarm#JobTimeoutMinutes",
"traits": {
"smithy.api#documentation": "<p>The default number of minutes (at the account level) a test run executes before it times out. The\n default value is 150 minutes.</p>"
}
},
"skipAppResign": {
"target": "com.amazonaws.devicefarm#SkipAppResign",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.</p>\n <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device\n Farm FAQs</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A container for account-level settings in AWS Device Farm.</p>"
}
},
"com.amazonaws.devicefarm#AccountsCleanup": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#AmazonResourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 32,
"max": 1011
},
"smithy.api#pattern": "^arn:.+"
}
},
"com.amazonaws.devicefarm#AmazonResourceNames": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#AmazonResourceName"
}
},
"com.amazonaws.devicefarm#AndroidPaths": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#String"
}
},
"com.amazonaws.devicefarm#AppPackagesCleanup": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#ArgumentException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>Any additional information about the exception.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An invalid argument was specified.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.devicefarm#Artifact": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The artifact's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The artifact's name.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#ArtifactType",
"traits": {
"smithy.api#documentation": "<p>The artifact's type.</p>\n <p>Allowed values include the following:</p>\n <ul>\n <li>\n <p>UNKNOWN</p>\n </li>\n <li>\n <p>SCREENSHOT</p>\n </li>\n <li>\n <p>DEVICE_LOG</p>\n </li>\n <li>\n <p>MESSAGE_LOG</p>\n </li>\n <li>\n <p>VIDEO_LOG</p>\n </li>\n <li>\n <p>RESULT_LOG</p>\n </li>\n <li>\n <p>SERVICE_LOG</p>\n </li>\n <li>\n <p>WEBKIT_LOG</p>\n </li>\n <li>\n <p>INSTRUMENTATION_OUTPUT</p>\n </li>\n <li>\n <p>EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz test.</p>\n </li>\n <li>\n <p>CALABASH_JSON_OUTPUT</p>\n </li>\n <li>\n <p>CALABASH_PRETTY_OUTPUT</p>\n </li>\n <li>\n <p>CALABASH_STANDARD_OUTPUT</p>\n </li>\n <li>\n <p>CALABASH_JAVA_XML_OUTPUT</p>\n </li>\n <li>\n <p>AUTOMATION_OUTPUT</p>\n </li>\n <li>\n <p>APPIUM_SERVER_OUTPUT</p>\n </li>\n <li>\n <p>APPIUM_JAVA_OUTPUT</p>\n </li>\n <li>\n <p>APPIUM_JAVA_XML_OUTPUT</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_OUTPUT</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_XML_OUTPUT</p>\n </li>\n <li>\n <p>EXPLORER_EVENT_LOG</p>\n </li>\n <li>\n <p>EXPLORER_SUMMARY_LOG</p>\n </li>\n <li>\n <p>APPLICATION_CRASH_REPORT</p>\n </li>\n <li>\n <p>XCTEST_LOG</p>\n </li>\n <li>\n <p>VIDEO</p>\n </li>\n <li>\n <p>CUSTOMER_ARTIFACT</p>\n </li>\n <li>\n <p>CUSTOMER_ARTIFACT_LOG</p>\n </li>\n <li>\n <p>TESTSPEC_OUTPUT</p>\n </li>\n </ul>"
}
},
"extension": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The artifact's file extension.</p>"
}
},
"url": {
"target": "com.amazonaws.devicefarm#URL",
"traits": {
"smithy.api#documentation": "<p>The presigned Amazon S3 URL that can be used with a GET request to download the artifact's\n file.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the output of a test. Examples of artifacts include logs and\n screenshots.</p>"
}
},
"com.amazonaws.devicefarm#ArtifactCategory": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "SCREENSHOT",
"name": "SCREENSHOT"
},
{
"value": "FILE",
"name": "FILE"
},
{
"value": "LOG",
"name": "LOG"
}
]
}
},
"com.amazonaws.devicefarm#ArtifactType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "UNKNOWN",
"name": "UNKNOWN"
},
{
"value": "SCREENSHOT",
"name": "SCREENSHOT"
},
{
"value": "DEVICE_LOG",
"name": "DEVICE_LOG"
},
{
"value": "MESSAGE_LOG",
"name": "MESSAGE_LOG"
},
{
"value": "VIDEO_LOG",
"name": "VIDEO_LOG"
},
{
"value": "RESULT_LOG",
"name": "RESULT_LOG"
},
{
"value": "SERVICE_LOG",
"name": "SERVICE_LOG"
},
{
"value": "WEBKIT_LOG",
"name": "WEBKIT_LOG"
},
{
"value": "INSTRUMENTATION_OUTPUT",
"name": "INSTRUMENTATION_OUTPUT"
},
{
"value": "EXERCISER_MONKEY_OUTPUT",
"name": "EXERCISER_MONKEY_OUTPUT"
},
{
"value": "CALABASH_JSON_OUTPUT",
"name": "CALABASH_JSON_OUTPUT"
},
{
"value": "CALABASH_PRETTY_OUTPUT",
"name": "CALABASH_PRETTY_OUTPUT"
},
{
"value": "CALABASH_STANDARD_OUTPUT",
"name": "CALABASH_STANDARD_OUTPUT"
},
{
"value": "CALABASH_JAVA_XML_OUTPUT",
"name": "CALABASH_JAVA_XML_OUTPUT"
},
{
"value": "AUTOMATION_OUTPUT",
"name": "AUTOMATION_OUTPUT"
},
{
"value": "APPIUM_SERVER_OUTPUT",
"name": "APPIUM_SERVER_OUTPUT"
},
{
"value": "APPIUM_JAVA_OUTPUT",
"name": "APPIUM_JAVA_OUTPUT"
},
{
"value": "APPIUM_JAVA_XML_OUTPUT",
"name": "APPIUM_JAVA_XML_OUTPUT"
},
{
"value": "APPIUM_PYTHON_OUTPUT",
"name": "APPIUM_PYTHON_OUTPUT"
},
{
"value": "APPIUM_PYTHON_XML_OUTPUT",
"name": "APPIUM_PYTHON_XML_OUTPUT"
},
{
"value": "EXPLORER_EVENT_LOG",
"name": "EXPLORER_EVENT_LOG"
},
{
"value": "EXPLORER_SUMMARY_LOG",
"name": "EXPLORER_SUMMARY_LOG"
},
{
"value": "APPLICATION_CRASH_REPORT",
"name": "APPLICATION_CRASH_REPORT"
},
{
"value": "XCTEST_LOG",
"name": "XCTEST_LOG"
},
{
"value": "VIDEO",
"name": "VIDEO"
},
{
"value": "CUSTOMER_ARTIFACT",
"name": "CUSTOMER_ARTIFACT"
},
{
"value": "CUSTOMER_ARTIFACT_LOG",
"name": "CUSTOMER_ARTIFACT_LOG"
},
{
"value": "TESTSPEC_OUTPUT",
"name": "TESTSPEC_OUTPUT"
}
]
}
},
"com.amazonaws.devicefarm#Artifacts": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Artifact"
}
},
"com.amazonaws.devicefarm#BillingMethod": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "METERED",
"name": "METERED"
},
{
"value": "UNMETERED",
"name": "UNMETERED"
}
]
}
},
"com.amazonaws.devicefarm#Boolean": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#CPU": {
"type": "structure",
"members": {
"frequency": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The CPU's frequency.</p>"
}
},
"architecture": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The CPU's architecture (for example, x86 or ARM).</p>"
}
},
"clock": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2\n GHz CPU is expressed as 1200000000.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide\n CPU usage.</p>"
}
},
"com.amazonaws.devicefarm#CannotDeleteException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message"
}
},
"traits": {
"smithy.api#documentation": "<p>The requested object could not be deleted.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.devicefarm#ClientId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 64
}
}
},
"com.amazonaws.devicefarm#ContentType": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 64
}
}
},
"com.amazonaws.devicefarm#Counters": {
"type": "structure",
"members": {
"total": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The total number of entities.</p>"
}
},
"passed": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of passed entities.</p>"
}
},
"failed": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of failed entities.</p>"
}
},
"warned": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of warned entities.</p>"
}
},
"errored": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of errored entities.</p>"
}
},
"stopped": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of stopped entities.</p>"
}
},
"skipped": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of skipped entities.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents entity counters.</p>"
}
},
"com.amazonaws.devicefarm#CreateDevicePool": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateDevicePoolRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateDevicePoolResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a device pool.</p>"
}
},
"com.amazonaws.devicefarm#CreateDevicePoolRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the project for the device pool.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The device pool's name.</p>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The device pool's description.</p>"
}
},
"rules": {
"target": "com.amazonaws.devicefarm#Rules",
"traits": {
"smithy.api#documentation": "<p>The device pool's rules.</p>",
"smithy.api#required": {}
}
},
"maxDevices": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are\n available and meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many\n devices meet these constraints, your device pool might contain fewer devices than the value for this\n parameter.</p>\n <p>By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the create device pool operation.</p>"
}
},
"com.amazonaws.devicefarm#CreateDevicePoolResult": {
"type": "structure",
"members": {
"devicePool": {
"target": "com.amazonaws.devicefarm#DevicePool",
"traits": {
"smithy.api#documentation": "<p>The newly created device pool.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a create device pool request.</p>"
}
},
"com.amazonaws.devicefarm#CreateInstanceProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateInstanceProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateInstanceProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a profile that can be applied to one or more private fleet device\n instances.</p>"
}
},
"com.amazonaws.devicefarm#CreateInstanceProfileRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name of your instance profile.</p>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The description of your instance profile.</p>"
}
},
"packageCleanup": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, Device Farm removes app packages after a test run. The default value is\n <code>false</code> for private devices.</p>"
}
},
"excludeAppPackagesFromCleanup": {
"target": "com.amazonaws.devicefarm#PackageIds",
"traits": {
"smithy.api#documentation": "<p>An array of strings that specifies the list of app packages that should not be cleaned up from the device\n after a test run.</p>\n <p>The list of packages is considered only if you set <code>packageCleanup</code> to\n <code>true</code>.</p>"
}
},
"rebootAfterUse": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is\n <code>true</code>.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateInstanceProfileResult": {
"type": "structure",
"members": {
"instanceProfile": {
"target": "com.amazonaws.devicefarm#InstanceProfile",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your instance profile.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateNetworkProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateNetworkProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateNetworkProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a network profile.</p>"
}
},
"com.amazonaws.devicefarm#CreateNetworkProfileRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project for which you want to create a\n network profile.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name for the new network profile.</p>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The description of the network profile.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#NetworkProfileType",
"traits": {
"smithy.api#documentation": "<p>The type of network profile to create. Valid values are listed here.</p>"
}
},
"uplinkBandwidthBits": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The data throughput rate in bits per second, as an integer from 0 to\n 104857600.</p>"
}
},
"downlinkBandwidthBits": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The data throughput rate in bits per second, as an integer from 0 to\n 104857600.</p>"
}
},
"uplinkDelayMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.</p>"
}
},
"downlinkDelayMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.</p>"
}
},
"uplinkJitterMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.</p>"
}
},
"downlinkJitterMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.</p>"
}
},
"uplinkLossPercent": {
"target": "com.amazonaws.devicefarm#PercentInteger",
"traits": {
"smithy.api#documentation": "<p>Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.</p>"
}
},
"downlinkLossPercent": {
"target": "com.amazonaws.devicefarm#PercentInteger",
"traits": {
"smithy.api#documentation": "<p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateNetworkProfileResult": {
"type": "structure",
"members": {
"networkProfile": {
"target": "com.amazonaws.devicefarm#NetworkProfile",
"traits": {
"smithy.api#documentation": "<p>The network profile that is returned by the create network profile\n request.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
},
{
"target": "com.amazonaws.devicefarm#TagOperationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a project.</p>"
}
},
"com.amazonaws.devicefarm#CreateProjectRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The project's name.</p>",
"smithy.api#required": {}
}
},
"defaultJobTimeoutMinutes": {
"target": "com.amazonaws.devicefarm#JobTimeoutMinutes",
"traits": {
"smithy.api#documentation": "<p>Sets the execution timeout value (in minutes) for a project. All test runs in this project use the\n specified execution timeout value unless overridden when scheduling a run.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the create project operation.</p>"
}
},
"com.amazonaws.devicefarm#CreateProjectResult": {
"type": "structure",
"members": {
"project": {
"target": "com.amazonaws.devicefarm#Project",
"traits": {
"smithy.api#documentation": "<p>The newly created project.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a create project request.</p>"
}
},
"com.amazonaws.devicefarm#CreateRemoteAccessSession": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateRemoteAccessSessionRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateRemoteAccessSessionResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Specifies and starts a remote access session.</p>"
}
},
"com.amazonaws.devicefarm#CreateRemoteAccessSessionConfiguration": {
"type": "structure",
"members": {
"billingMethod": {
"target": "com.amazonaws.devicefarm#BillingMethod",
"traits": {
"smithy.api#documentation": "<p>The billing method for the remote access session.</p>"
}
},
"vpceConfigurationArns": {
"target": "com.amazonaws.devicefarm#AmazonResourceNames",
"traits": {
"smithy.api#documentation": "<p>An array of ARNs included in the VPC endpoint configuration.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration settings for a remote access session, including billing\n method.</p>"
}
},
"com.amazonaws.devicefarm#CreateRemoteAccessSessionRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project for which you want to create a remote\n access session.</p>",
"smithy.api#required": {}
}
},
"deviceArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the device for which you want to create a remote access session.</p>",
"smithy.api#required": {}
}
},
"instanceArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the device instance for which you want to create a\n remote access session.</p>"
}
},
"sshPublicKey": {
"target": "com.amazonaws.devicefarm#SshPublicKey",
"traits": {
"smithy.api#documentation": "<p>Ignored. The public key of the <code>ssh</code> key pair you want to use for connecting to remote\n devices in your remote debugging session. This key is required only if <code>remoteDebugEnabled</code> is\n set to <code>true</code>.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"remoteDebugEnabled": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>Set to <code>true</code> if you want to access devices remotely for debugging in\n your remote access session.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"remoteRecordEnabled": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>Set to <code>true</code> to enable remote recording for the remote access\n session.</p>"
}
},
"remoteRecordAppArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access\n session.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the remote access session to create.</p>"
}
},
"clientId": {
"target": "com.amazonaws.devicefarm#ClientId",
"traits": {
"smithy.api#documentation": "<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should\n pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This\n identifier is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"configuration": {
"target": "com.amazonaws.devicefarm#CreateRemoteAccessSessionConfiguration",
"traits": {
"smithy.api#documentation": "<p>The configuration information for the remote access session request.</p>"
}
},
"interactionMode": {
"target": "com.amazonaws.devicefarm#InteractionMode",
"traits": {
"smithy.api#documentation": "<p>The interaction mode of the remote access session. Valid values are:</p>\n <ul>\n <li>\n <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and\n rotating the screen. You cannot run XCUITest framework-based tests in this\n mode.</p>\n </li>\n <li>\n <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This\n mode has the fastest test execution speed. You can run XCUITest framework-based tests in this\n mode.</p>\n </li>\n <li>\n <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest\n framework-based tests and watch the screen in this mode.</p>\n </li>\n </ul>"
}
},
"skipAppResign": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.</p>\n <p>For more information on how Device Farm modifies your uploads during tests, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Creates and submits a request to start a remote access session.</p>"
}
},
"com.amazonaws.devicefarm#CreateRemoteAccessSessionResult": {
"type": "structure",
"members": {
"remoteAccessSession": {
"target": "com.amazonaws.devicefarm#RemoteAccessSession",
"traits": {
"smithy.api#documentation": "<p>A container that describes the remote access session when the request to create a\n remote access session is sent.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the server response from a request to create a remote access\n session.</p>"
}
},
"com.amazonaws.devicefarm#CreateTestGridProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateTestGridProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateTestGridProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a Selenium testing project. Projects are used to track <a>TestGridSession</a>\n instances.</p>"
}
},
"com.amazonaws.devicefarm#CreateTestGridProjectRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.devicefarm#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Human-readable name of the Selenium testing project.</p>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.devicefarm#ResourceDescription",
"traits": {
"smithy.api#documentation": "<p>Human-readable description of the project.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateTestGridProjectResult": {
"type": "structure",
"members": {
"testGridProject": {
"target": "com.amazonaws.devicefarm#TestGridProject",
"traits": {
"smithy.api#documentation": "<p>ARN of the Selenium testing project that was created.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateTestGridUrl": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateTestGridUrlRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateTestGridUrlResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a signed, short-term URL that can be passed to a Selenium <code>RemoteWebDriver</code>\n constructor.</p>"
}
},
"com.amazonaws.devicefarm#CreateTestGridUrlRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>ARN (from <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>) to associate\n with the short-term URL. </p>",
"smithy.api#required": {}
}
},
"expiresInSeconds": {
"target": "com.amazonaws.devicefarm#TestGridUrlExpiresInSecondsInput",
"traits": {
"smithy.api#documentation": "<p>Lifetime, in seconds, of the URL.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#CreateTestGridUrlResult": {
"type": "structure",
"members": {
"url": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>A signed URL, expiring in <a>CreateTestGridUrlRequest$expiresInSeconds</a> seconds, to be passed\n to a <code>RemoteWebDriver</code>. </p>"
}
},
"expires": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The number of seconds the URL from <a>CreateTestGridUrlResult$url</a> stays active.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateUpload": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateUploadRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateUploadResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Uploads an app or test scripts.</p>"
}
},
"com.amazonaws.devicefarm#CreateUploadRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the project for the upload.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The upload's file name. The name should not contain any forward slashes (<code>/</code>). If you are\n uploading an iOS app, the file name must end with the <code>.ipa</code> extension. If you are uploading an\n Android app, the file name must end with the <code>.apk</code> extension. For all others, the file name must\n end with the <code>.zip</code> file extension.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.devicefarm#UploadType",
"traits": {
"smithy.api#documentation": "<p>The upload's upload type.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>ANDROID_APP</p>\n </li>\n <li>\n <p>IOS_APP</p>\n </li>\n <li>\n <p>WEB_APP</p>\n </li>\n <li>\n <p>EXTERNAL_DATA</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_NODE_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_RUBY_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY_TEST_PACKAGE</p>\n </li>\n <li>\n <p>CALABASH_TEST_PACKAGE</p>\n </li>\n <li>\n <p>INSTRUMENTATION_TEST_PACKAGE</p>\n </li>\n <li>\n <p>UIAUTOMATION_TEST_PACKAGE</p>\n </li>\n <li>\n <p>UIAUTOMATOR_TEST_PACKAGE</p>\n </li>\n <li>\n <p>XCTEST_TEST_PACKAGE</p>\n </li>\n <li>\n <p>XCTEST_UI_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_NODE_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_RUBY_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY_TEST_SPEC</p>\n </li>\n <li>\n <p>INSTRUMENTATION_TEST_SPEC</p>\n </li>\n <li>\n <p>XCTEST_UI_TEST_SPEC</p>\n </li>\n </ul>\n <p> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS\n Device Farm throws an <code>ArgumentException</code> error.</p>",
"smithy.api#required": {}
}
},
"contentType": {
"target": "com.amazonaws.devicefarm#ContentType",
"traits": {
"smithy.api#documentation": "<p>The upload's content type (for example, <code>application/octet-stream</code>).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the create upload operation.</p>"
}
},
"com.amazonaws.devicefarm#CreateUploadResult": {
"type": "structure",
"members": {
"upload": {
"target": "com.amazonaws.devicefarm#Upload",
"traits": {
"smithy.api#documentation": "<p>The newly created upload.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a create upload request.</p>"
}
},
"com.amazonaws.devicefarm#CreateVPCEConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#CreateVPCEConfigurationRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#CreateVPCEConfigurationResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud\n (VPC) endpoint.</p>"
}
},
"com.amazonaws.devicefarm#CreateVPCEConfigurationRequest": {
"type": "structure",
"members": {
"vpceConfigurationName": {
"target": "com.amazonaws.devicefarm#VPCEConfigurationName",
"traits": {
"smithy.api#documentation": "<p>The friendly name you give to your VPC endpoint configuration, to manage your\n configurations more easily.</p>",
"smithy.api#required": {}
}
},
"vpceServiceName": {
"target": "com.amazonaws.devicefarm#VPCEServiceName",
"traits": {
"smithy.api#documentation": "<p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>",
"smithy.api#required": {}
}
},
"serviceDnsName": {
"target": "com.amazonaws.devicefarm#ServiceDnsName",
"traits": {
"smithy.api#documentation": "<p>The DNS name of the service running in your VPC that you want Device Farm to\n test.</p>",
"smithy.api#required": {}
}
},
"vpceConfigurationDescription": {
"target": "com.amazonaws.devicefarm#VPCEConfigurationDescription",
"traits": {
"smithy.api#documentation": "<p>An optional description that provides details about your VPC endpoint configuration.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CreateVPCEConfigurationResult": {
"type": "structure",
"members": {
"vpceConfiguration": {
"target": "com.amazonaws.devicefarm#VPCEConfiguration",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your VPC endpoint configuration.</p>"
}
}
}
},
"com.amazonaws.devicefarm#CurrencyCode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "USD",
"name": "USD"
}
]
}
},
"com.amazonaws.devicefarm#CustomerArtifactPaths": {
"type": "structure",
"members": {
"iosPaths": {
"target": "com.amazonaws.devicefarm#IosPaths",
"traits": {
"smithy.api#documentation": "<p>Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests\n are pulled from.</p>"
}
},
"androidPaths": {
"target": "com.amazonaws.devicefarm#AndroidPaths",
"traits": {
"smithy.api#documentation": "<p>Comma-separated list of paths on the Android device where the artifacts generated by the customer's\n tests are pulled from.</p>"
}
},
"deviceHostPaths": {
"target": "com.amazonaws.devicefarm#DeviceHostPaths",
"traits": {
"smithy.api#documentation": "<p>Comma-separated list of paths in the test execution environment where the artifacts generated by the\n customer's tests are pulled from.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the\n device or in the test environment, are pulled from.</p>\n <p>Specify <code>deviceHostPaths</code> and optionally specify either\n <code>iosPaths</code> or <code>androidPaths</code>.</p>\n <p>For web app tests, you can specify both <code>iosPaths</code> and\n <code>androidPaths</code>.</p>"
}
},
"com.amazonaws.devicefarm#DateTime": {
"type": "timestamp"
},
"com.amazonaws.devicefarm#DeleteDevicePool": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteDevicePoolRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteDevicePoolResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a device pool given the pool ARN. Does not allow deletion of curated pools\n owned by the system.</p>"
}
},
"com.amazonaws.devicefarm#DeleteDevicePoolRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the delete device pool operation.</p>"
}
},
"com.amazonaws.devicefarm#DeleteDevicePoolResult": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a delete device pool request.</p>"
}
},
"com.amazonaws.devicefarm#DeleteInstanceProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteInstanceProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteInstanceProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a profile that can be applied to one or more private device instances.</p>"
}
},
"com.amazonaws.devicefarm#DeleteInstanceProfileRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the instance profile you are requesting to\n delete.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#DeleteInstanceProfileResult": {
"type": "structure",
"members": {}
},
"com.amazonaws.devicefarm#DeleteNetworkProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteNetworkProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteNetworkProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a network profile.</p>"
}
},
"com.amazonaws.devicefarm#DeleteNetworkProfileRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the network profile to delete.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#DeleteNetworkProfileResult": {
"type": "structure",
"members": {}
},
"com.amazonaws.devicefarm#DeleteProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an AWS Device Farm project, given the project ARN.</p>\n <p> Deleting this resource does not stop an in-progress run.</p>"
}
},
"com.amazonaws.devicefarm#DeleteProjectRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the delete project operation.</p>"
}
},
"com.amazonaws.devicefarm#DeleteProjectResult": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a delete project request.</p>"
}
},
"com.amazonaws.devicefarm#DeleteRemoteAccessSession": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteRemoteAccessSessionRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteRemoteAccessSessionResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a completed remote access session and its results.</p>"
}
},
"com.amazonaws.devicefarm#DeleteRemoteAccessSessionRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the session for which you want to delete remote\n access.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to delete the specified remote access session.</p>"
}
},
"com.amazonaws.devicefarm#DeleteRemoteAccessSessionResult": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>The response from the server when a request is made to delete the remote access\n session.</p>"
}
},
"com.amazonaws.devicefarm#DeleteRun": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteRunRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteRunResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the run, given the run ARN.</p>\n <p> Deleting this resource does not stop an in-progress run.</p>"
}
},
"com.amazonaws.devicefarm#DeleteRunRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the run to delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the delete run operation.</p>"
}
},
"com.amazonaws.devicefarm#DeleteRunResult": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a delete run request.</p>"
}
},
"com.amazonaws.devicefarm#DeleteTestGridProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteTestGridProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteTestGridProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#CannotDeleteException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p> Deletes a Selenium testing project and all content generated under it. </p>\n <important>\n <p>You cannot undo this operation.</p>\n </important>\n <note>\n <p>You cannot delete a project if it has active sessions.</p>\n </note>"
}
},
"com.amazonaws.devicefarm#DeleteTestGridProjectRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the project to delete, from <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#DeleteTestGridProjectResult": {
"type": "structure",
"members": {}
},
"com.amazonaws.devicefarm#DeleteUpload": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteUploadRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteUploadResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an upload given the upload ARN.</p>"
}
},
"com.amazonaws.devicefarm#DeleteUploadRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the delete upload operation.</p>"
}
},
"com.amazonaws.devicefarm#DeleteUploadResult": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a delete upload request.</p>"
}
},
"com.amazonaws.devicefarm#DeleteVPCEConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#DeleteVPCEConfigurationRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#DeleteVPCEConfigurationResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InvalidOperationException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.</p>"
}
},
"com.amazonaws.devicefarm#DeleteVPCEConfigurationRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to\n delete.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#DeleteVPCEConfigurationResult": {
"type": "structure",
"members": {}
},
"com.amazonaws.devicefarm#Device": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The device's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The device's display name.</p>"
}
},
"manufacturer": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The device's manufacturer name.</p>"
}
},
"model": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The device's model name.</p>"
}
},
"modelId": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The device's model ID.</p>"
}
},
"formFactor": {
"target": "com.amazonaws.devicefarm#DeviceFormFactor",
"traits": {
"smithy.api#documentation": "<p>The device's form factor.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PHONE</p>\n </li>\n <li>\n <p>TABLET</p>\n </li>\n </ul>"
}
},
"platform": {
"target": "com.amazonaws.devicefarm#DevicePlatform",
"traits": {
"smithy.api#documentation": "<p>The device's platform.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>ANDROID</p>\n </li>\n <li>\n <p>IOS</p>\n </li>\n </ul>"
}
},
"os": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The device's operating system type.</p>"
}
},
"cpu": {
"target": "com.amazonaws.devicefarm#CPU",
"traits": {
"smithy.api#documentation": "<p>Information about the device's CPU.</p>"
}
},
"resolution": {
"target": "com.amazonaws.devicefarm#Resolution",
"traits": {
"smithy.api#documentation": "<p>The resolution of the device.</p>"
}
},
"heapSize": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The device's heap size, expressed in bytes.</p>"
}
},
"memory": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The device's total memory size, expressed in bytes.</p>"
}
},
"image": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The device's image name.</p>"
}
},
"carrier": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The device's carrier.</p>"
}
},
"radio": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The device's radio.</p>"
}
},
"remoteAccessEnabled": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether remote access has been enabled for the specified\n device.</p>"
}
},
"remoteDebugEnabled": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the\n device.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"fleetType": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.</p>"
}
},
"fleetName": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The name of the fleet to which this device belongs.</p>"
}
},
"instances": {
"target": "com.amazonaws.devicefarm#DeviceInstances",
"traits": {
"smithy.api#documentation": "<p>The instances that belong to this device.</p>"
}
},
"availability": {
"target": "com.amazonaws.devicefarm#DeviceAvailability",
"traits": {
"smithy.api#documentation": "<p>Indicates how likely a device is available for a test run. Currently available in the <a>ListDevices</a> and GetDevice API methods.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a device type that an app is tested against.</p>"
}
},
"com.amazonaws.devicefarm#DeviceAttribute": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ARN",
"name": "ARN"
},
{
"value": "PLATFORM",
"name": "PLATFORM"
},
{
"value": "FORM_FACTOR",
"name": "FORM_FACTOR"
},
{
"value": "MANUFACTURER",
"name": "MANUFACTURER"
},
{
"value": "REMOTE_ACCESS_ENABLED",
"name": "REMOTE_ACCESS_ENABLED"
},
{
"value": "REMOTE_DEBUG_ENABLED",
"name": "REMOTE_DEBUG_ENABLED"
},
{
"value": "APPIUM_VERSION",
"name": "APPIUM_VERSION"
},
{
"value": "INSTANCE_ARN",
"name": "INSTANCE_ARN"
},
{
"value": "INSTANCE_LABELS",
"name": "INSTANCE_LABELS"
},
{
"value": "FLEET_TYPE",
"name": "FLEET_TYPE"
},
{
"value": "OS_VERSION",
"name": "OS_VERSION"
},
{
"value": "MODEL",
"name": "MODEL"
},
{
"value": "AVAILABILITY",
"name": "AVAILABILITY"
}
]
}
},
"com.amazonaws.devicefarm#DeviceAvailability": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "TEMPORARY_NOT_AVAILABLE",
"name": "TEMPORARY_NOT_AVAILABLE"
},
{
"value": "BUSY",
"name": "BUSY"
},
{
"value": "AVAILABLE",
"name": "AVAILABLE"
},
{
"value": "HIGHLY_AVAILABLE",
"name": "HIGHLY_AVAILABLE"
}
]
}
},
"com.amazonaws.devicefarm#DeviceFarmArn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 32,
"max": 1011
},
"smithy.api#pattern": "^arn:aws:devicefarm:.+"
}
},
"com.amazonaws.devicefarm#DeviceFarm_20150623": {
"type": "service",
"version": "2015-06-23",
"operations": [
{
"target": "com.amazonaws.devicefarm#CreateDevicePool"
},
{
"target": "com.amazonaws.devicefarm#CreateInstanceProfile"
},
{
"target": "com.amazonaws.devicefarm#CreateNetworkProfile"
},
{
"target": "com.amazonaws.devicefarm#CreateProject"
},
{
"target": "com.amazonaws.devicefarm#CreateRemoteAccessSession"
},
{
"target": "com.amazonaws.devicefarm#CreateTestGridProject"
},
{
"target": "com.amazonaws.devicefarm#CreateTestGridUrl"
},
{
"target": "com.amazonaws.devicefarm#CreateUpload"
},
{
"target": "com.amazonaws.devicefarm#CreateVPCEConfiguration"
},
{
"target": "com.amazonaws.devicefarm#DeleteDevicePool"
},
{
"target": "com.amazonaws.devicefarm#DeleteInstanceProfile"
},
{
"target": "com.amazonaws.devicefarm#DeleteNetworkProfile"
},
{
"target": "com.amazonaws.devicefarm#DeleteProject"
},
{
"target": "com.amazonaws.devicefarm#DeleteRemoteAccessSession"
},
{
"target": "com.amazonaws.devicefarm#DeleteRun"
},
{
"target": "com.amazonaws.devicefarm#DeleteTestGridProject"
},
{
"target": "com.amazonaws.devicefarm#DeleteUpload"
},
{
"target": "com.amazonaws.devicefarm#DeleteVPCEConfiguration"
},
{
"target": "com.amazonaws.devicefarm#GetAccountSettings"
},
{
"target": "com.amazonaws.devicefarm#GetDevice"
},
{
"target": "com.amazonaws.devicefarm#GetDeviceInstance"
},
{
"target": "com.amazonaws.devicefarm#GetDevicePool"
},
{
"target": "com.amazonaws.devicefarm#GetDevicePoolCompatibility"
},
{
"target": "com.amazonaws.devicefarm#GetInstanceProfile"
},
{
"target": "com.amazonaws.devicefarm#GetJob"
},
{
"target": "com.amazonaws.devicefarm#GetNetworkProfile"
},
{
"target": "com.amazonaws.devicefarm#GetOfferingStatus"
},
{
"target": "com.amazonaws.devicefarm#GetProject"
},
{
"target": "com.amazonaws.devicefarm#GetRemoteAccessSession"
},
{
"target": "com.amazonaws.devicefarm#GetRun"
},
{
"target": "com.amazonaws.devicefarm#GetSuite"
},
{
"target": "com.amazonaws.devicefarm#GetTest"
},
{
"target": "com.amazonaws.devicefarm#GetTestGridProject"
},
{
"target": "com.amazonaws.devicefarm#GetTestGridSession"
},
{
"target": "com.amazonaws.devicefarm#GetUpload"
},
{
"target": "com.amazonaws.devicefarm#GetVPCEConfiguration"
},
{
"target": "com.amazonaws.devicefarm#InstallToRemoteAccessSession"
},
{
"target": "com.amazonaws.devicefarm#ListArtifacts"
},
{
"target": "com.amazonaws.devicefarm#ListDeviceInstances"
},
{
"target": "com.amazonaws.devicefarm#ListDevicePools"
},
{
"target": "com.amazonaws.devicefarm#ListDevices"
},
{
"target": "com.amazonaws.devicefarm#ListInstanceProfiles"
},
{
"target": "com.amazonaws.devicefarm#ListJobs"
},
{
"target": "com.amazonaws.devicefarm#ListNetworkProfiles"
},
{
"target": "com.amazonaws.devicefarm#ListOfferingPromotions"
},
{
"target": "com.amazonaws.devicefarm#ListOfferings"
},
{
"target": "com.amazonaws.devicefarm#ListOfferingTransactions"
},
{
"target": "com.amazonaws.devicefarm#ListProjects"
},
{
"target": "com.amazonaws.devicefarm#ListRemoteAccessSessions"
},
{
"target": "com.amazonaws.devicefarm#ListRuns"
},
{
"target": "com.amazonaws.devicefarm#ListSamples"
},
{
"target": "com.amazonaws.devicefarm#ListSuites"
},
{
"target": "com.amazonaws.devicefarm#ListTagsForResource"
},
{
"target": "com.amazonaws.devicefarm#ListTestGridProjects"
},
{
"target": "com.amazonaws.devicefarm#ListTestGridSessionActions"
},
{
"target": "com.amazonaws.devicefarm#ListTestGridSessionArtifacts"
},
{
"target": "com.amazonaws.devicefarm#ListTestGridSessions"
},
{
"target": "com.amazonaws.devicefarm#ListTests"
},
{
"target": "com.amazonaws.devicefarm#ListUniqueProblems"
},
{
"target": "com.amazonaws.devicefarm#ListUploads"
},
{
"target": "com.amazonaws.devicefarm#ListVPCEConfigurations"
},
{
"target": "com.amazonaws.devicefarm#PurchaseOffering"
},
{
"target": "com.amazonaws.devicefarm#RenewOffering"
},
{
"target": "com.amazonaws.devicefarm#ScheduleRun"
},
{
"target": "com.amazonaws.devicefarm#StopJob"
},
{
"target": "com.amazonaws.devicefarm#StopRemoteAccessSession"
},
{
"target": "com.amazonaws.devicefarm#StopRun"
},
{
"target": "com.amazonaws.devicefarm#TagResource"
},
{
"target": "com.amazonaws.devicefarm#UntagResource"
},
{
"target": "com.amazonaws.devicefarm#UpdateDeviceInstance"
},
{
"target": "com.amazonaws.devicefarm#UpdateDevicePool"
},
{
"target": "com.amazonaws.devicefarm#UpdateInstanceProfile"
},
{
"target": "com.amazonaws.devicefarm#UpdateNetworkProfile"
},
{
"target": "com.amazonaws.devicefarm#UpdateProject"
},
{
"target": "com.amazonaws.devicefarm#UpdateTestGridProject"
},
{
"target": "com.amazonaws.devicefarm#UpdateUpload"
},
{
"target": "com.amazonaws.devicefarm#UpdateVPCEConfiguration"
}
],
"traits": {
"aws.api#service": {
"sdkId": "Device Farm",
"arnNamespace": "devicefarm",
"cloudFormationName": "DeviceFarm",
"cloudTrailEventSource": "devicefarm.amazonaws.com",
"endpointPrefix": "devicefarm"
},
"aws.auth#sigv4": {
"name": "devicefarm"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<p>Welcome to the AWS Device Farm API documentation, which contains APIs for:</p>\n <ul>\n <li>\n <p>Testing on desktop browsers</p>\n <p> Device Farm makes it possible for you to test your web applications on desktop browsers using\n Selenium. The APIs for desktop browser testing contain <code>TestGrid</code> in their names. For\n more information, see <a href=\"https://docs.aws.amazon.com/devicefarm/latest/testgrid/\">Testing Web\n Applications on Selenium with Device Farm</a>.</p>\n </li>\n <li>\n <p>Testing on real mobile devices</p>\n <p>Device Farm makes it possible for you to test apps on physical phones, tablets, and other\n devices in the cloud. For more information, see the <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/\">Device Farm Developer Guide</a>.</p>\n </li>\n </ul>",
"smithy.api#title": "AWS Device Farm",
"smithy.api#xmlNamespace": {
"uri": "http://devicefarm.amazonaws.com/doc/2015-06-23/"
}
}
},
"com.amazonaws.devicefarm#DeviceFilter": {
"type": "structure",
"members": {
"attribute": {
"target": "com.amazonaws.devicefarm#DeviceFilterAttribute",
"traits": {
"smithy.api#documentation": "<p>The aspect of a device such as platform or model used as the selection criteria in a\n device filter.</p>\n <p>The supported operators for each attribute are provided in the following list.</p>\n <dl>\n <dt>ARN</dt>\n <dd>\n <p>The Amazon Resource Name (ARN) of the device (for example,\n <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p>\n <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>PLATFORM</dt>\n <dd>\n <p>The device platform. Valid values are ANDROID or IOS.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n </dd>\n <dt>OS_VERSION</dt>\n <dd>\n <p>The operating system version (for example, 10.3.2).</p>\n <p>Supported operators: <code>EQUALS</code>, <code>GREATER_THAN</code>,\n <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>,\n <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>,\n <code>NOT_IN</code>\n </p>\n </dd>\n <dt>MODEL</dt>\n <dd>\n <p>The device model (for example, iPad 5th Gen).</p>\n <p>Supported operators: <code>CONTAINS</code>, <code>EQUALS</code>,\n <code>IN</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>AVAILABILITY</dt>\n <dd>\n <p>The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n </dd>\n <dt>FORM_FACTOR</dt>\n <dd>\n <p>The device form factor. Valid values are PHONE or TABLET.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n </dd>\n <dt>MANUFACTURER</dt>\n <dd>\n <p>The device manufacturer (for example, Apple).</p>\n <p>Supported operators: <code>EQUALS</code>, <code>IN</code>,\n <code>NOT_IN</code>\n </p>\n </dd>\n <dt>REMOTE_ACCESS_ENABLED</dt>\n <dd>\n <p>Whether the device is enabled for remote access. Valid values are TRUE or\n FALSE.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n </dd>\n <dt>REMOTE_DEBUG_ENABLED</dt>\n <dd>\n <p>Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n <p>Because remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer\n supported</a>, this filter is ignored.</p>\n </dd>\n <dt>INSTANCE_ARN</dt>\n <dd>\n <p>The Amazon Resource Name (ARN) of the device instance.</p>\n <p>Supported operators: <code>EQUALS</code>, <code>IN</code>,\n <code>NOT_IN</code>\n </p>\n </dd>\n <dt>INSTANCE_LABELS</dt>\n <dd>\n <p>The label of the device instance.</p>\n <p>Supported operators: <code>CONTAINS</code>\n </p>\n </dd>\n <dt>FLEET_TYPE</dt>\n <dd>\n <p>The fleet type. Valid values are PUBLIC or PRIVATE.</p>\n <p>Support
}
},
"operator": {
"target": "com.amazonaws.devicefarm#RuleOperator",
"traits": {
"smithy.api#documentation": "<p>Specifies how Device Farm compares the filter's attribute to the value. See the attribute\n descriptions.</p>"
}
},
"values": {
"target": "com.amazonaws.devicefarm#DeviceFilterValues",
"traits": {
"smithy.api#documentation": "<p>An array of one or more filter values used in a device filter.</p>\n <p class=\"title\">\n <b>Operator Values</b>\n </p>\n <ul>\n <li>\n <p>The IN and NOT_IN operators can take a values array that has more than one\n element.</p>\n </li>\n <li>\n <p>The other operators require an array with a single element.</p>\n </li>\n </ul>\n <p class=\"title\">\n <b>Attribute Values</b>\n </p>\n <ul>\n <li>\n <p>The PLATFORM attribute can be set to ANDROID or IOS.</p>\n </li>\n <li>\n <p>The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or\n TEMPORARY_NOT_AVAILABLE.</p>\n </li>\n <li>\n <p>The FORM_FACTOR attribute can be set to PHONE or TABLET.</p>\n </li>\n <li>\n <p>The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a device filter used to select a set of devices to be included in a test\n run. This data structure is passed in as the <code>deviceSelectionConfiguration</code>\n parameter to <code>ScheduleRun</code>. For an example of the JSON request syntax, see\n <a>ScheduleRun</a>.</p>\n <p>It is also passed in as the <code>filters</code> parameter to\n <code>ListDevices</code>. For an example of the JSON request syntax, see <a>ListDevices</a>.</p>"
}
},
"com.amazonaws.devicefarm#DeviceFilterAttribute": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ARN",
"name": "ARN"
},
{
"value": "PLATFORM",
"name": "PLATFORM"
},
{
"value": "OS_VERSION",
"name": "OS_VERSION"
},
{
"value": "MODEL",
"name": "MODEL"
},
{
"value": "AVAILABILITY",
"name": "AVAILABILITY"
},
{
"value": "FORM_FACTOR",
"name": "FORM_FACTOR"
},
{
"value": "MANUFACTURER",
"name": "MANUFACTURER"
},
{
"value": "REMOTE_ACCESS_ENABLED",
"name": "REMOTE_ACCESS_ENABLED"
},
{
"value": "REMOTE_DEBUG_ENABLED",
"name": "REMOTE_DEBUG_ENABLED"
},
{
"value": "INSTANCE_ARN",
"name": "INSTANCE_ARN"
},
{
"value": "INSTANCE_LABELS",
"name": "INSTANCE_LABELS"
},
{
"value": "FLEET_TYPE",
"name": "FLEET_TYPE"
}
]
}
},
"com.amazonaws.devicefarm#DeviceFilterValues": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#String"
}
},
"com.amazonaws.devicefarm#DeviceFilters": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#DeviceFilter"
}
},
"com.amazonaws.devicefarm#DeviceFormFactor": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PHONE",
"name": "PHONE"
},
{
"value": "TABLET",
"name": "TABLET"
}
]
}
},
"com.amazonaws.devicefarm#DeviceHostPaths": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#String"
}
},
"com.amazonaws.devicefarm#DeviceInstance": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the device instance.</p>"
}
},
"deviceArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the device.</p>"
}
},
"labels": {
"target": "com.amazonaws.devicefarm#InstanceLabels",
"traits": {
"smithy.api#documentation": "<p>An array of strings that describe the device instance.</p>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#InstanceStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the device instance. Valid values are listed here.</p>"
}
},
"udid": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>Unique device identifier for the device instance.</p>"
}
},
"instanceProfile": {
"target": "com.amazonaws.devicefarm#InstanceProfile",
"traits": {
"smithy.api#documentation": "<p>A object that contains information about the instance profile.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the device instance.</p>"
}
},
"com.amazonaws.devicefarm#DeviceInstances": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#DeviceInstance"
}
},
"com.amazonaws.devicefarm#DeviceMinutes": {
"type": "structure",
"members": {
"total": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>When specified, represents the total minutes used by the resource to run\n tests.</p>"
}
},
"metered": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>When specified, represents only the sum of metered minutes used by the resource to\n run tests.</p>"
}
},
"unmetered": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>When specified, represents only the sum of unmetered minutes used by the resource\n to run tests.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the total (metered or unmetered) minutes used by the resource to run\n tests. Contains the sum of minutes consumed by all children.</p>"
}
},
"com.amazonaws.devicefarm#DevicePlatform": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ANDROID",
"name": "ANDROID"
},
{
"value": "IOS",
"name": "IOS"
}
]
}
},
"com.amazonaws.devicefarm#DevicePool": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The device pool's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The device pool's name.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The device pool's description.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#DevicePoolType",
"traits": {
"smithy.api#documentation": "<p>The device pool's type.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>CURATED: A device pool that is created and managed by AWS Device\n Farm.</p>\n </li>\n <li>\n <p>PRIVATE: A device pool that is created and managed by the device pool\n developer.</p>\n </li>\n </ul>"
}
},
"rules": {
"target": "com.amazonaws.devicefarm#Rules",
"traits": {
"smithy.api#documentation": "<p>Information about the device pool's rules.</p>"
}
},
"maxDevices": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are\n available and meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many\n devices meet these constraints, your device pool might contain fewer devices than the value for this\n parameter.</p>\n <p>By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a collection of device types.</p>"
}
},
"com.amazonaws.devicefarm#DevicePoolCompatibilityResult": {
"type": "structure",
"members": {
"device": {
"target": "com.amazonaws.devicefarm#Device",
"traits": {
"smithy.api#documentation": "<p>The device (phone or tablet) to return information about.</p>"
}
},
"compatible": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the result was compatible with the device pool.</p>"
}
},
"incompatibilityMessages": {
"target": "com.amazonaws.devicefarm#IncompatibilityMessages",
"traits": {
"smithy.api#documentation": "<p>Information about the compatibility.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a device pool compatibility result.</p>"
}
},
"com.amazonaws.devicefarm#DevicePoolCompatibilityResults": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#DevicePoolCompatibilityResult"
}
},
"com.amazonaws.devicefarm#DevicePoolType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CURATED",
"name": "CURATED"
},
{
"value": "PRIVATE",
"name": "PRIVATE"
}
]
}
},
"com.amazonaws.devicefarm#DevicePools": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#DevicePool"
}
},
"com.amazonaws.devicefarm#DeviceSelectionConfiguration": {
"type": "structure",
"members": {
"filters": {
"target": "com.amazonaws.devicefarm#DeviceFilters",
"traits": {
"smithy.api#documentation": "<p>Used to dynamically select a set of devices for a test run. A filter is made up of an\n attribute, an operator, and one or more values.</p>\n <ul>\n <li>\n <p>\n <b>Attribute</b>\n </p>\n <p>The aspect of a device such as platform or model used as the selection\n criteria in a device filter.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>ARN: The Amazon Resource Name (ARN) of the device (for example,\n <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p>\n </li>\n <li>\n <p>PLATFORM: The device platform. Valid values are ANDROID or\n IOS.</p>\n </li>\n <li>\n <p>OS_VERSION: The operating system version (for example,\n 10.3.2).</p>\n </li>\n <li>\n <p>MODEL: The device model (for example, iPad 5th Gen).</p>\n </li>\n <li>\n <p>AVAILABILITY: The current availability of the device. Valid values\n are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or\n TEMPORARY_NOT_AVAILABLE.</p>\n </li>\n <li>\n <p>FORM_FACTOR: The device form factor. Valid values are PHONE or\n TABLET.</p>\n </li>\n <li>\n <p>MANUFACTURER: The device manufacturer (for example,\n Apple).</p>\n </li>\n <li>\n <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote\n access. Valid values are TRUE or FALSE.</p>\n </li>\n <li>\n <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values\n are TRUE or FALSE. Because remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>, this filter is ignored.</p>\n </li>\n <li>\n <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device\n instance.</p>\n </li>\n <li>\n <p>INSTANCE_LABELS: The label of the device instance.</p>\n </li>\n <li>\n <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <b>Operator</b>\n </p>\n <p>The filter operator.</p>\n <ul>\n <li>\n <p>The EQUALS operator is available for every attribute except\n INSTANCE_LABELS.</p>\n </li>\n <li>\n <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL\n attributes.</p>\n </li>\n <li>\n <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION,\n MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p>\n </li>\n <li>\n <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and\n GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION\n attribute.</p>\n </li>\n <
"smithy.api#required": {}
}
},
"maxDevices": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of devices to be included in a test run.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the device filters used in a test run and the maximum number of devices to be included in the\n run. It is passed in as the <code>deviceSelectionConfiguration</code> request parameter in <a>ScheduleRun</a>.</p>"
}
},
"com.amazonaws.devicefarm#DeviceSelectionResult": {
"type": "structure",
"members": {
"filters": {
"target": "com.amazonaws.devicefarm#DeviceFilters",
"traits": {
"smithy.api#documentation": "<p>The filters in a device selection result.</p>"
}
},
"matchedDevicesCount": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of devices that matched the device filter selection criteria.</p>"
}
},
"maxDevices": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of devices to be selected by a device filter and included in a test\n run.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the run results requested by the device selection configuration and how many devices were\n returned. For an example of the JSON response syntax, see <a>ScheduleRun</a>.</p>"
}
},
"com.amazonaws.devicefarm#Devices": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Device"
}
},
"com.amazonaws.devicefarm#Double": {
"type": "double",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#ExceptionMessage": {
"type": "string"
},
"com.amazonaws.devicefarm#ExecutionConfiguration": {
"type": "structure",
"members": {
"jobTimeoutMinutes": {
"target": "com.amazonaws.devicefarm#JobTimeoutMinutes",
"traits": {
"smithy.api#documentation": "<p>The number of minutes a test run executes before it times out.</p>"
}
},
"accountsCleanup": {
"target": "com.amazonaws.devicefarm#AccountsCleanup",
"traits": {
"smithy.api#documentation": "<p>True if account cleanup is enabled at the beginning of the test. Otherwise, false.</p>"
}
},
"appPackagesCleanup": {
"target": "com.amazonaws.devicefarm#AppPackagesCleanup",
"traits": {
"smithy.api#documentation": "<p>True if app package cleanup is enabled at the beginning of the test. Otherwise, false.</p>"
}
},
"videoCapture": {
"target": "com.amazonaws.devicefarm#VideoCapture",
"traits": {
"smithy.api#documentation": "<p>Set to true to enable video capture. Otherwise, set to false. The default is true.</p>"
}
},
"skipAppResign": {
"target": "com.amazonaws.devicefarm#SkipAppResign",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.</p>\n <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device\n Farm FAQs</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents configuration information about a test run, such as the execution\n timeout (in minutes).</p>"
}
},
"com.amazonaws.devicefarm#ExecutionResult": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PENDING",
"name": "PENDING"
},
{
"value": "PASSED",
"name": "PASSED"
},
{
"value": "WARNED",
"name": "WARNED"
},
{
"value": "FAILED",
"name": "FAILED"
},
{
"value": "SKIPPED",
"name": "SKIPPED"
},
{
"value": "ERRORED",
"name": "ERRORED"
},
{
"value": "STOPPED",
"name": "STOPPED"
}
]
}
},
"com.amazonaws.devicefarm#ExecutionResultCode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PARSING_FAILED",
"name": "PARSING_FAILED"
},
{
"value": "VPC_ENDPOINT_SETUP_FAILED",
"name": "VPC_ENDPOINT_SETUP_FAILED"
}
]
}
},
"com.amazonaws.devicefarm#ExecutionStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PENDING",
"name": "PENDING"
},
{
"value": "PENDING_CONCURRENCY",
"name": "PENDING_CONCURRNECY"
},
{
"value": "PENDING_DEVICE",
"name": "PENDING_DEVICE"
},
{
"value": "PROCESSING",
"name": "PROCESSING"
},
{
"value": "SCHEDULING",
"name": "SCHEDULING"
},
{
"value": "PREPARING",
"name": "PREPARING"
},
{
"value": "RUNNING",
"name": "RUNNING"
},
{
"value": "COMPLETED",
"name": "COMPLETED"
},
{
"value": "STOPPING",
"name": "STOPPING"
}
]
}
},
"com.amazonaws.devicefarm#Filter": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 8192
}
}
},
"com.amazonaws.devicefarm#GetAccountSettings": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetAccountSettingsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetAccountSettingsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the\n account.</p>"
}
},
"com.amazonaws.devicefarm#GetAccountSettingsRequest": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>Represents the request sent to retrieve the account settings.</p>"
}
},
"com.amazonaws.devicefarm#GetAccountSettingsResult": {
"type": "structure",
"members": {
"accountSettings": {
"target": "com.amazonaws.devicefarm#AccountSettings",
"traits": {
"smithy.api#documentation": "<p>The account settings.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the account settings return values from the\n <code>GetAccountSettings</code> request.</p>"
}
},
"com.amazonaws.devicefarm#GetDevice": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetDeviceRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetDeviceResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about a unique device type.</p>"
}
},
"com.amazonaws.devicefarm#GetDeviceInstance": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetDeviceInstanceRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetDeviceInstanceResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about a device instance that belongs to a private device fleet.</p>"
}
},
"com.amazonaws.devicefarm#GetDeviceInstanceRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the instance you're requesting information\n about.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#GetDeviceInstanceResult": {
"type": "structure",
"members": {
"deviceInstance": {
"target": "com.amazonaws.devicefarm#DeviceInstance",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your device instance.</p>"
}
}
}
},
"com.amazonaws.devicefarm#GetDevicePool": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetDevicePoolRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetDevicePoolResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about a device pool.</p>"
}
},
"com.amazonaws.devicefarm#GetDevicePoolCompatibility": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetDevicePoolCompatibilityRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetDevicePoolCompatibilityResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about compatibility with a device pool.</p>"
}
},
"com.amazonaws.devicefarm#GetDevicePoolCompatibilityRequest": {
"type": "structure",
"members": {
"devicePoolArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The device pool's ARN.</p>",
"smithy.api#required": {}
}
},
"appArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the app that is associated with the specified device pool.</p>"
}
},
"testType": {
"target": "com.amazonaws.devicefarm#TestType",
"traits": {
"smithy.api#documentation": "<p>The test type for the specified device pool.</p>\n <p>Allowed values include the following:</p>\n <ul>\n <li>\n <p>BUILTIN_FUZZ.</p>\n </li>\n <li>\n <p>BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with\n it and capturing screenshots at the same time.</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT.</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG.</p>\n </li>\n <li>\n <p>APPIUM_PYTHON.</p>\n </li>\n <li>\n <p>APPIUM_NODE.</p>\n </li>\n <li>\n <p>APPIUM_RUBY.</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT.</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG.</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON.</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE.</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY.</p>\n </li>\n <li>\n <p>CALABASH.</p>\n </li>\n <li>\n <p>INSTRUMENTATION.</p>\n </li>\n <li>\n <p>UIAUTOMATION.</p>\n </li>\n <li>\n <p>UIAUTOMATOR.</p>\n </li>\n <li>\n <p>XCTEST.</p>\n </li>\n <li>\n <p>XCTEST_UI.</p>\n </li>\n </ul>"
}
},
"test": {
"target": "com.amazonaws.devicefarm#ScheduleRunTest",
"traits": {
"smithy.api#documentation": "<p>Information about the uploaded test to be run against the device pool.</p>"
}
},
"configuration": {
"target": "com.amazonaws.devicefarm#ScheduleRunConfiguration",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the settings for a run.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get device pool compatibility operation.</p>"
}
},
"com.amazonaws.devicefarm#GetDevicePoolCompatibilityResult": {
"type": "structure",
"members": {
"compatibleDevices": {
"target": "com.amazonaws.devicefarm#DevicePoolCompatibilityResults",
"traits": {
"smithy.api#documentation": "<p>Information about compatible devices.</p>"
}
},
"incompatibleDevices": {
"target": "com.amazonaws.devicefarm#DevicePoolCompatibilityResults",
"traits": {
"smithy.api#documentation": "<p>Information about incompatible devices.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of describe device pool compatibility request.</p>"
}
},
"com.amazonaws.devicefarm#GetDevicePoolRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The device pool's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get device pool operation.</p>"
}
},
"com.amazonaws.devicefarm#GetDevicePoolResult": {
"type": "structure",
"members": {
"devicePool": {
"target": "com.amazonaws.devicefarm#DevicePool",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the requested device pool.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get device pool request.</p>"
}
},
"com.amazonaws.devicefarm#GetDeviceRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The device type's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get device request.</p>"
}
},
"com.amazonaws.devicefarm#GetDeviceResult": {
"type": "structure",
"members": {
"device": {
"target": "com.amazonaws.devicefarm#Device",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the requested device.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get device request.</p>"
}
},
"com.amazonaws.devicefarm#GetInstanceProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetInstanceProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetInstanceProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about the specified instance profile.</p>"
}
},
"com.amazonaws.devicefarm#GetInstanceProfileRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of an instance profile.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#GetInstanceProfileResult": {
"type": "structure",
"members": {
"instanceProfile": {
"target": "com.amazonaws.devicefarm#InstanceProfile",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about an instance profile.</p>"
}
}
}
},
"com.amazonaws.devicefarm#GetJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetJobRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetJobResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about a job.</p>"
}
},
"com.amazonaws.devicefarm#GetJobRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The job's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get job operation.</p>"
}
},
"com.amazonaws.devicefarm#GetJobResult": {
"type": "structure",
"members": {
"job": {
"target": "com.amazonaws.devicefarm#Job",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the requested job.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get job request.</p>"
}
},
"com.amazonaws.devicefarm#GetNetworkProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetNetworkProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetNetworkProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about a network profile.</p>"
}
},
"com.amazonaws.devicefarm#GetNetworkProfileRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the network profile to return information about.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#GetNetworkProfileResult": {
"type": "structure",
"members": {
"networkProfile": {
"target": "com.amazonaws.devicefarm#NetworkProfile",
"traits": {
"smithy.api#documentation": "<p>The network profile.</p>"
}
}
}
},
"com.amazonaws.devicefarm#GetOfferingStatus": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetOfferingStatusRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetOfferingStatusResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotEligibleException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the current status and future status of all offerings purchased by an AWS account. The response\n indicates how many offerings are currently available and the offerings that will be available in the next\n period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the\n operation. If you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken"
}
}
},
"com.amazonaws.devicefarm#GetOfferingStatusRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to retrieve the offering status for the specified customer\n or account.</p>"
}
},
"com.amazonaws.devicefarm#GetOfferingStatusResult": {
"type": "structure",
"members": {
"current": {
"target": "com.amazonaws.devicefarm#OfferingStatusMap",
"traits": {
"smithy.api#documentation": "<p>When specified, gets the offering status for the current period.</p>"
}
},
"nextPeriod": {
"target": "com.amazonaws.devicefarm#OfferingStatusMap",
"traits": {
"smithy.api#documentation": "<p>When specified, gets the offering status for the next period.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Returns the status result for a device offering.</p>"
}
},
"com.amazonaws.devicefarm#GetProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about a project.</p>"
}
},
"com.amazonaws.devicefarm#GetProjectRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The project's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get project operation.</p>"
}
},
"com.amazonaws.devicefarm#GetProjectResult": {
"type": "structure",
"members": {
"project": {
"target": "com.amazonaws.devicefarm#Project",
"traits": {
"smithy.api#documentation": "<p>The project to get information about.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get project request.</p>"
}
},
"com.amazonaws.devicefarm#GetRemoteAccessSession": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetRemoteAccessSessionRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetRemoteAccessSessionResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a link to a currently running remote access session.</p>"
}
},
"com.amazonaws.devicefarm#GetRemoteAccessSessionRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the remote access session about which you want to\n get session information.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to get information about the specified remote access\n session.</p>"
}
},
"com.amazonaws.devicefarm#GetRemoteAccessSessionResult": {
"type": "structure",
"members": {
"remoteAccessSession": {
"target": "com.amazonaws.devicefarm#RemoteAccessSession",
"traits": {
"smithy.api#documentation": "<p>A container that lists detailed information about the remote access\n session.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the response from the server that lists detailed information about the\n remote access session.</p>"
}
},
"com.amazonaws.devicefarm#GetRun": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetRunRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetRunResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about a run.</p>"
}
},
"com.amazonaws.devicefarm#GetRunRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The run's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get run operation.</p>"
}
},
"com.amazonaws.devicefarm#GetRunResult": {
"type": "structure",
"members": {
"run": {
"target": "com.amazonaws.devicefarm#Run",
"traits": {
"smithy.api#documentation": "<p>The run to get results from.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get run request.</p>"
}
},
"com.amazonaws.devicefarm#GetSuite": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetSuiteRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetSuiteResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about a suite.</p>"
}
},
"com.amazonaws.devicefarm#GetSuiteRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The suite's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get suite operation.</p>"
}
},
"com.amazonaws.devicefarm#GetSuiteResult": {
"type": "structure",
"members": {
"suite": {
"target": "com.amazonaws.devicefarm#Suite",
"traits": {
"smithy.api#documentation": "<p>A collection of one or more tests.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get suite request.</p>"
}
},
"com.amazonaws.devicefarm#GetTest": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetTestRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetTestResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about a test.</p>"
}
},
"com.amazonaws.devicefarm#GetTestGridProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetTestGridProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetTestGridProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves information about a Selenium testing project.</p>"
}
},
"com.amazonaws.devicefarm#GetTestGridProjectRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the Selenium testing project, from either <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#GetTestGridProjectResult": {
"type": "structure",
"members": {
"testGridProject": {
"target": "com.amazonaws.devicefarm#TestGridProject",
"traits": {
"smithy.api#documentation": "<p>A <a>TestGridProject</a>.</p>"
}
}
}
},
"com.amazonaws.devicefarm#GetTestGridSession": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetTestGridSessionRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetTestGridSessionResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>A session is an instance of a browser created through a <code>RemoteWebDriver</code> with the URL from <a>CreateTestGridUrlResult$url</a>. You can use the following to look up sessions:</p>\n <ul>\n <li>\n <p>The session ARN (<a>GetTestGridSessionRequest$sessionArn</a>).</p>\n </li>\n <li>\n <p>The project ARN and a session ID (<a>GetTestGridSessionRequest$projectArn</a> and <a>GetTestGridSessionRequest$sessionId</a>).</p>\n </li>\n </ul>\n <p></p>"
}
},
"com.amazonaws.devicefarm#GetTestGridSessionRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The ARN for the project that this session belongs to. See <a>CreateTestGridProject</a> and <a>ListTestGridProjects</a>.</p>"
}
},
"sessionId": {
"target": "com.amazonaws.devicefarm#ResourceId",
"traits": {
"smithy.api#documentation": "<p>An ID associated with this session.</p>"
}
},
"sessionArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>An ARN that uniquely identifies a <a>TestGridSession</a>.</p>"
}
}
}
},
"com.amazonaws.devicefarm#GetTestGridSessionResult": {
"type": "structure",
"members": {
"testGridSession": {
"target": "com.amazonaws.devicefarm#TestGridSession",
"traits": {
"smithy.api#documentation": "<p>The <a>TestGridSession</a> that was requested.</p>"
}
}
}
},
"com.amazonaws.devicefarm#GetTestRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The test's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get test operation.</p>"
}
},
"com.amazonaws.devicefarm#GetTestResult": {
"type": "structure",
"members": {
"test": {
"target": "com.amazonaws.devicefarm#Test",
"traits": {
"smithy.api#documentation": "<p>A test condition that is evaluated.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get test request.</p>"
}
},
"com.amazonaws.devicefarm#GetUpload": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetUploadRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetUploadResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about an upload.</p>"
}
},
"com.amazonaws.devicefarm#GetUploadRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The upload's ARN.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the get upload operation.</p>"
}
},
"com.amazonaws.devicefarm#GetUploadResult": {
"type": "structure",
"members": {
"upload": {
"target": "com.amazonaws.devicefarm#Upload",
"traits": {
"smithy.api#documentation": "<p>An app or a set of one or more tests to upload or that have been\n uploaded.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a get upload request.</p>"
}
},
"com.amazonaws.devicefarm#GetVPCEConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#GetVPCEConfigurationRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#GetVPCEConfigurationResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about the configuration settings for your Amazon Virtual Private\n Cloud (VPC) endpoint.</p>"
}
},
"com.amazonaws.devicefarm#GetVPCEConfigurationRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to\n describe.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#GetVPCEConfigurationResult": {
"type": "structure",
"members": {
"vpceConfiguration": {
"target": "com.amazonaws.devicefarm#VPCEConfiguration",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your VPC endpoint configuration.</p>"
}
}
}
},
"com.amazonaws.devicefarm#HostAddress": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 1024
}
}
},
"com.amazonaws.devicefarm#IdempotencyException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>Any additional information about the exception.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An entity with the same name already exists.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.devicefarm#IncompatibilityMessage": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the incompatibility.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#DeviceAttribute",
"traits": {
"smithy.api#documentation": "<p>The type of incompatibility.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>ARN</p>\n </li>\n <li>\n <p>FORM_FACTOR (for example, phone or tablet)</p>\n </li>\n <li>\n <p>MANUFACTURER</p>\n </li>\n <li>\n <p>PLATFORM (for example, Android or iOS)</p>\n </li>\n <li>\n <p>REMOTE_ACCESS_ENABLED</p>\n </li>\n <li>\n <p>APPIUM_VERSION</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents information about incompatibility.</p>"
}
},
"com.amazonaws.devicefarm#IncompatibilityMessages": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#IncompatibilityMessage"
}
},
"com.amazonaws.devicefarm#InstallToRemoteAccessSession": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#InstallToRemoteAccessSessionRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#InstallToRemoteAccessSessionResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Installs an application to the device in a remote access session. For Android\n applications, the file must be in .apk format. For iOS applications, the file must be in\n .ipa format.</p>"
}
},
"com.amazonaws.devicefarm#InstallToRemoteAccessSessionRequest": {
"type": "structure",
"members": {
"remoteAccessSessionArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the remote access session about which you are\n requesting information.</p>",
"smithy.api#required": {}
}
},
"appArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the app about which you are requesting information.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to install an Android application (in .apk format) or an iOS\n application (in .ipa format) as part of a remote access session.</p>"
}
},
"com.amazonaws.devicefarm#InstallToRemoteAccessSessionResult": {
"type": "structure",
"members": {
"appUpload": {
"target": "com.amazonaws.devicefarm#Upload",
"traits": {
"smithy.api#documentation": "<p>An app to upload or that has been uploaded.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the response from the server after AWS Device Farm makes a request to\n install to a remote access session.</p>"
}
},
"com.amazonaws.devicefarm#InstanceLabels": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#String"
}
},
"com.amazonaws.devicefarm#InstanceProfile": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the instance profile.</p>"
}
},
"packageCleanup": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, Device Farm removes app packages after a test run. The default value is\n <code>false</code> for private devices.</p>"
}
},
"excludeAppPackagesFromCleanup": {
"target": "com.amazonaws.devicefarm#PackageIds",
"traits": {
"smithy.api#documentation": "<p>An array of strings containing the list of app packages that should not be cleaned up from the device\n after a test run completes.</p>\n <p>The list of packages is considered only if you set <code>packageCleanup</code> to\n <code>true</code>.</p>"
}
},
"rebootAfterUse": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is\n <code>true</code>.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the instance profile.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The description of the instance profile.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the instance profile.</p>"
}
},
"com.amazonaws.devicefarm#InstanceProfiles": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#InstanceProfile"
}
},
"com.amazonaws.devicefarm#InstanceStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "IN_USE",
"name": "IN_USE"
},
{
"value": "PREPARING",
"name": "PREPARING"
},
{
"value": "AVAILABLE",
"name": "AVAILABLE"
},
{
"value": "NOT_AVAILABLE",
"name": "NOT_AVAILABLE"
}
]
}
},
"com.amazonaws.devicefarm#Integer": {
"type": "integer",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#InteractionMode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "INTERACTIVE",
"name": "INTERACTIVE"
},
{
"value": "NO_VIDEO",
"name": "NO_VIDEO"
},
{
"value": "VIDEO_ONLY",
"name": "VIDEO_ONLY"
}
],
"smithy.api#length": {
"min": 0,
"max": 64
}
}
},
"com.amazonaws.devicefarm#InternalServiceException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message"
}
},
"traits": {
"smithy.api#documentation": "<p>An internal exception was raised in the service. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you see this\n error. </p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
}
},
"com.amazonaws.devicefarm#InvalidOperationException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message"
}
},
"traits": {
"smithy.api#documentation": "<p>There was an error with the update request, or you do not have sufficient permissions\n to update this VPC endpoint configuration.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.devicefarm#IosPaths": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#String"
}
},
"com.amazonaws.devicefarm#Job": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The job's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The job's name.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#TestType",
"traits": {
"smithy.api#documentation": "<p>The job's type.</p>\n <p>Allowed values include the following:</p>\n <ul>\n <li>\n <p>BUILTIN_FUZZ</p>\n </li>\n <li>\n <p>BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with\n it and capturing screenshots at the same time.</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_NODE</p>\n </li>\n <li>\n <p>APPIUM_RUBY</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY</p>\n </li>\n <li>\n <p>CALABASH</p>\n </li>\n <li>\n <p>INSTRUMENTATION</p>\n </li>\n <li>\n <p>UIAUTOMATION</p>\n </li>\n <li>\n <p>UIAUTOMATOR</p>\n </li>\n <li>\n <p>XCTEST</p>\n </li>\n <li>\n <p>XCTEST_UI</p>\n </li>\n </ul>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>When the job was created.</p>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#ExecutionStatus",
"traits": {
"smithy.api#documentation": "<p>The job's status.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PENDING_CONCURRENCY</p>\n </li>\n <li>\n <p>PENDING_DEVICE</p>\n </li>\n <li>\n <p>PROCESSING</p>\n </li>\n <li>\n <p>SCHEDULING</p>\n </li>\n <li>\n <p>PREPARING</p>\n </li>\n <li>\n <p>RUNNING</p>\n </li>\n <li>\n <p>COMPLETED</p>\n </li>\n <li>\n <p>STOPPING</p>\n </li>\n </ul>"
}
},
"result": {
"target": "com.amazonaws.devicefarm#ExecutionResult",
"traits": {
"smithy.api#documentation": "<p>The job's result.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PASSED</p>\n </li>\n <li>\n <p>WARNED</p>\n </li>\n <li>\n <p>FAILED</p>\n </li>\n <li>\n <p>SKIPPED</p>\n </li>\n <li>\n <p>ERRORED</p>\n </li>\n <li>\n <p>STOPPED</p>\n </li>\n </ul>"
}
},
"started": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The job's start time.</p>"
}
},
"stopped": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The job's stop time.</p>"
}
},
"counters": {
"target": "com.amazonaws.devicefarm#Counters",
"traits": {
"smithy.api#documentation": "<p>The job's result counters.</p>"
}
},
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the job's result.</p>"
}
},
"device": {
"target": "com.amazonaws.devicefarm#Device",
"traits": {
"smithy.api#documentation": "<p>The device (phone or tablet).</p>"
}
},
"instanceArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the instance.</p>"
}
},
"deviceMinutes": {
"target": "com.amazonaws.devicefarm#DeviceMinutes",
"traits": {
"smithy.api#documentation": "<p>Represents the total (metered or unmetered) minutes used by the job.</p>"
}
},
"videoEndpoint": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The endpoint for streaming device video.</p>"
}
},
"videoCapture": {
"target": "com.amazonaws.devicefarm#VideoCapture",
"traits": {
"smithy.api#documentation": "<p>This value is set to true if video capture is enabled. Otherwise, it is set to false.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a device.</p>"
}
},
"com.amazonaws.devicefarm#JobTimeoutMinutes": {
"type": "integer",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#Jobs": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Job"
}
},
"com.amazonaws.devicefarm#LimitExceededException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>Any additional information about the exception.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A limit was exceeded.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.devicefarm#ListArtifacts": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListArtifactsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListArtifactsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about artifacts.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "artifacts"
}
}
},
"com.amazonaws.devicefarm#ListArtifactsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The run, job, suite, or test ARN.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.devicefarm#ArtifactCategory",
"traits": {
"smithy.api#documentation": "<p>The artifacts' type.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>FILE</p>\n </li>\n <li>\n <p>LOG</p>\n </li>\n <li>\n <p>SCREENSHOT</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list artifacts operation.</p>"
}
},
"com.amazonaws.devicefarm#ListArtifactsResult": {
"type": "structure",
"members": {
"artifacts": {
"target": "com.amazonaws.devicefarm#Artifacts",
"traits": {
"smithy.api#documentation": "<p>Information about the artifacts.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list artifacts operation.</p>"
}
},
"com.amazonaws.devicefarm#ListDeviceInstances": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListDeviceInstancesRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListDeviceInstancesResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about the private device instances associated with one or more AWS\n accounts.</p>"
}
},
"com.amazonaws.devicefarm#ListDeviceInstancesRequest": {
"type": "structure",
"members": {
"maxResults": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>An integer that specifies the maximum number of items you want to return in the API response.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListDeviceInstancesResult": {
"type": "structure",
"members": {
"deviceInstances": {
"target": "com.amazonaws.devicefarm#DeviceInstances",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your device instances.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that can be used in the next call to this operation to return the next\n set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListDevicePools": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListDevicePoolsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListDevicePoolsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about device pools.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "devicePools"
}
}
},
"com.amazonaws.devicefarm#ListDevicePoolsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The project ARN.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.devicefarm#DevicePoolType",
"traits": {
"smithy.api#documentation": "<p>The device pools' type.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>CURATED: A device pool that is created and managed by AWS Device\n Farm.</p>\n </li>\n <li>\n <p>PRIVATE: A device pool that is created and managed by the device pool\n developer.</p>\n </li>\n </ul>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list device pools request.</p>"
}
},
"com.amazonaws.devicefarm#ListDevicePoolsResult": {
"type": "structure",
"members": {
"devicePools": {
"target": "com.amazonaws.devicefarm#DevicePools",
"traits": {
"smithy.api#documentation": "<p>Information about the device pools.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list device pools request.</p>"
}
},
"com.amazonaws.devicefarm#ListDevices": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListDevicesRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListDevicesResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about unique device types.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "devices"
}
}
},
"com.amazonaws.devicefarm#ListDevicesRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
},
"filters": {
"target": "com.amazonaws.devicefarm#DeviceFilters",
"traits": {
"smithy.api#documentation": "<p>Used to select a set of devices. A filter is made up of an attribute, an operator, and\n one or more values.</p>\n <ul>\n <li>\n <p>Attribute: The aspect of a device such as platform or model used as the\n selection criteria in a device filter.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>ARN: The Amazon Resource Name (ARN) of the device (for example,\n <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p>\n </li>\n <li>\n <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p>\n </li>\n <li>\n <p>OS_VERSION: The operating system version (for example, 10.3.2).</p>\n </li>\n <li>\n <p>MODEL: The device model (for example, iPad 5th Gen).</p>\n </li>\n <li>\n <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p>\n </li>\n <li>\n <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p>\n </li>\n <li>\n <p>MANUFACTURER: The device manufacturer (for example, Apple).</p>\n </li>\n <li>\n <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values\n are TRUE or FALSE.</p>\n </li>\n <li>\n <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values\n are TRUE or FALSE. Because remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>, this attribute is ignored.</p>\n </li>\n <li>\n <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device\n instance.</p>\n </li>\n <li>\n <p>INSTANCE_LABELS: The label of the device instance.</p>\n </li>\n <li>\n <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>Operator: The filter operator.</p>\n <ul>\n <li>\n <p>The EQUALS operator is available for every attribute except\n INSTANCE_LABELS.</p>\n </li>\n <li>\n <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL\n attributes.</p>\n </li>\n <li>\n <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION,\n MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p>\n </li>\n <li>\n <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and\n GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION\n attribute.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>Values: An array of one or more filter values.</p>\n <ul>\n <li>\n <p>The IN and NOT_IN operators take a values array that has one or more\n elements.</p>\n
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list devices request.</p>"
}
},
"com.amazonaws.devicefarm#ListDevicesResult": {
"type": "structure",
"members": {
"devices": {
"target": "com.amazonaws.devicefarm#Devices",
"traits": {
"smithy.api#documentation": "<p>Information about the devices.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list devices operation.</p>"
}
},
"com.amazonaws.devicefarm#ListInstanceProfiles": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListInstanceProfilesRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListInstanceProfilesResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about all the instance profiles in an AWS account.</p>"
}
},
"com.amazonaws.devicefarm#ListInstanceProfilesRequest": {
"type": "structure",
"members": {
"maxResults": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>An integer that specifies the maximum number of items you want to return in the API response.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListInstanceProfilesResult": {
"type": "structure",
"members": {
"instanceProfiles": {
"target": "com.amazonaws.devicefarm#InstanceProfiles",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your instance profiles.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that can be used in the next call to this operation to return the next\n set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListJobs": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListJobsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListJobsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about jobs for a given test run.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "jobs"
}
}
},
"com.amazonaws.devicefarm#ListJobsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The run's Amazon Resource Name (ARN).</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list jobs operation.</p>"
}
},
"com.amazonaws.devicefarm#ListJobsResult": {
"type": "structure",
"members": {
"jobs": {
"target": "com.amazonaws.devicefarm#Jobs",
"traits": {
"smithy.api#documentation": "<p>Information about the jobs.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list jobs request.</p>"
}
},
"com.amazonaws.devicefarm#ListNetworkProfiles": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListNetworkProfilesRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListNetworkProfilesResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the list of available network profiles.</p>"
}
},
"com.amazonaws.devicefarm#ListNetworkProfilesRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project for which you want to list network\n profiles.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.devicefarm#NetworkProfileType",
"traits": {
"smithy.api#documentation": "<p>The type of network profile to return information about. Valid values are listed here.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListNetworkProfilesResult": {
"type": "structure",
"members": {
"networkProfiles": {
"target": "com.amazonaws.devicefarm#NetworkProfiles",
"traits": {
"smithy.api#documentation": "<p>A list of the available network profiles.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListOfferingPromotions": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListOfferingPromotionsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListOfferingPromotionsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotEligibleException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of offering promotions. Each offering promotion record contains the ID and description\n of the promotion. The API returns a <code>NotEligible</code> error if the caller is not permitted to invoke\n the operation. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you must be able to invoke this operation.</p>"
}
},
"com.amazonaws.devicefarm#ListOfferingPromotionsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListOfferingPromotionsResult": {
"type": "structure",
"members": {
"offeringPromotions": {
"target": "com.amazonaws.devicefarm#OfferingPromotions",
"traits": {
"smithy.api#documentation": "<p>Information about the offering promotions.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier to be used in the next call to this operation, to return the next set\n of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListOfferingTransactions": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListOfferingTransactionsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListOfferingTransactionsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotEligibleException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS\n account. The list is paginated and ordered by a descending timestamp (most recent transactions are first).\n The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. If\n you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "offeringTransactions"
}
}
},
"com.amazonaws.devicefarm#ListOfferingTransactionsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to list the offering transaction history.</p>"
}
},
"com.amazonaws.devicefarm#ListOfferingTransactionsResult": {
"type": "structure",
"members": {
"offeringTransactions": {
"target": "com.amazonaws.devicefarm#OfferingTransactions",
"traits": {
"smithy.api#documentation": "<p>The audit log of subscriptions you have purchased and modified through AWS Device\n Farm.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Returns the transaction log of the specified offerings.</p>"
}
},
"com.amazonaws.devicefarm#ListOfferings": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListOfferingsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListOfferingsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotEligibleException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of products or offerings that the user can manage through the API. Each offering record\n indicates the recurring price per unit and the frequency for that offering. The API returns a\n <code>NotEligible</code> error if the user is not permitted to invoke the operation. If you must be\n able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "offerings"
}
}
},
"com.amazonaws.devicefarm#ListOfferingsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to list all offerings.</p>"
}
},
"com.amazonaws.devicefarm#ListOfferingsResult": {
"type": "structure",
"members": {
"offerings": {
"target": "com.amazonaws.devicefarm#Offerings",
"traits": {
"smithy.api#documentation": "<p>A value that represents the list offering results.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the return values of the list of offerings.</p>"
}
},
"com.amazonaws.devicefarm#ListProjects": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListProjectsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListProjectsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about projects.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "projects"
}
}
},
"com.amazonaws.devicefarm#ListProjectsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm\n returns a list of all projects for the AWS account. You can also specify a project\n ARN.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list projects operation.</p>"
}
},
"com.amazonaws.devicefarm#ListProjectsResult": {
"type": "structure",
"members": {
"projects": {
"target": "com.amazonaws.devicefarm#Projects",
"traits": {
"smithy.api#documentation": "<p>Information about the projects.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list projects request.</p>"
}
},
"com.amazonaws.devicefarm#ListRemoteAccessSessions": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListRemoteAccessSessionsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListRemoteAccessSessionsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of all currently running remote access sessions.</p>"
}
},
"com.amazonaws.devicefarm#ListRemoteAccessSessionsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project about which you are requesting\n information.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to return information about the remote access\n session.</p>"
}
},
"com.amazonaws.devicefarm#ListRemoteAccessSessionsResult": {
"type": "structure",
"members": {
"remoteAccessSessions": {
"target": "com.amazonaws.devicefarm#RemoteAccessSessions",
"traits": {
"smithy.api#documentation": "<p>A container that represents the metadata from the service about each remote access session you are\n requesting.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the response from the server after AWS Device Farm makes a request to\n return information about the remote access session.</p>"
}
},
"com.amazonaws.devicefarm#ListRuns": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListRunsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListRunsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about runs, given an AWS Device Farm project ARN.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "runs"
}
}
},
"com.amazonaws.devicefarm#ListRunsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project for which you want to list\n runs.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list runs operation.</p>"
}
},
"com.amazonaws.devicefarm#ListRunsResult": {
"type": "structure",
"members": {
"runs": {
"target": "com.amazonaws.devicefarm#Runs",
"traits": {
"smithy.api#documentation": "<p>Information about the runs.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list runs request.</p>"
}
},
"com.amazonaws.devicefarm#ListSamples": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListSamplesRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListSamplesResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about samples, given an AWS Device Farm job ARN.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "samples"
}
}
},
"com.amazonaws.devicefarm#ListSamplesRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the job used to list samples.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list samples operation.</p>"
}
},
"com.amazonaws.devicefarm#ListSamplesResult": {
"type": "structure",
"members": {
"samples": {
"target": "com.amazonaws.devicefarm#Samples",
"traits": {
"smithy.api#documentation": "<p>Information about the samples.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list samples request.</p>"
}
},
"com.amazonaws.devicefarm#ListSuites": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListSuitesRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListSuitesResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about test suites for a given job.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "suites"
}
}
},
"com.amazonaws.devicefarm#ListSuitesRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The job's Amazon Resource Name (ARN).</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list suites operation.</p>"
}
},
"com.amazonaws.devicefarm#ListSuitesResult": {
"type": "structure",
"members": {
"suites": {
"target": "com.amazonaws.devicefarm#Suites",
"traits": {
"smithy.api#documentation": "<p>Information about the suites.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list suites request.</p>"
}
},
"com.amazonaws.devicefarm#ListTagsForResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListTagsForResourceRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListTagsForResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#TagOperationException"
}
],
"traits": {
"smithy.api#documentation": "<p>List the tags for an AWS Device Farm resource.</p>"
}
},
"com.amazonaws.devicefarm#ListTagsForResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags\n with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>,\n <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>,\n <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and\n <code>VPCE_CONFIGURATION</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#ListTagsForResourceResponse": {
"type": "structure",
"members": {
"Tags": {
"target": "com.amazonaws.devicefarm#TagList",
"traits": {
"smithy.api#documentation": "<p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum\n character length of 128 characters. Tag values can have a maximum length of 256 characters.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridProjects": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListTestGridProjectsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListTestGridProjectsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets a list of all Selenium testing projects in your account.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResult"
}
}
},
"com.amazonaws.devicefarm#ListTestGridProjectsRequest": {
"type": "structure",
"members": {
"maxResult": {
"target": "com.amazonaws.devicefarm#MaxPageSize",
"traits": {
"smithy.api#documentation": "<p>Return no more than this number of results.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>From a response, used to continue a paginated listing. </p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridProjectsResult": {
"type": "structure",
"members": {
"testGridProjects": {
"target": "com.amazonaws.devicefarm#TestGridProjects",
"traits": {
"smithy.api#documentation": "<p>The list of TestGridProjects, based on a <a>ListTestGridProjectsRequest</a>.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>Used for pagination. Pass into <a>ListTestGridProjects</a> to get more results in a paginated\n request.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionActions": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListTestGridSessionActionsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListTestGridSessionActionsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of the actions taken in a <a>TestGridSession</a>.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResult"
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionActionsRequest": {
"type": "structure",
"members": {
"sessionArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the session to retrieve.</p>",
"smithy.api#required": {}
}
},
"maxResult": {
"target": "com.amazonaws.devicefarm#MaxPageSize",
"traits": {
"smithy.api#documentation": "<p>The maximum number of sessions to return per response.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>Pagination token.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionActionsResult": {
"type": "structure",
"members": {
"actions": {
"target": "com.amazonaws.devicefarm#TestGridSessionActions",
"traits": {
"smithy.api#documentation": "<p>The action taken by the session.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>Pagination token.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionArtifacts": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListTestGridSessionArtifactsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListTestGridSessionArtifactsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of artifacts created during the session.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResult"
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionArtifactsRequest": {
"type": "structure",
"members": {
"sessionArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of a <a>TestGridSession</a>. </p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.devicefarm#TestGridSessionArtifactCategory",
"traits": {
"smithy.api#documentation": "<p>Limit results to a specified type of artifact.</p>"
}
},
"maxResult": {
"target": "com.amazonaws.devicefarm#MaxPageSize",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to be returned by a request.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>Pagination token.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionArtifactsResult": {
"type": "structure",
"members": {
"artifacts": {
"target": "com.amazonaws.devicefarm#TestGridSessionArtifacts",
"traits": {
"smithy.api#documentation": "<p>A list of test grid session artifacts for a <a>TestGridSession</a>.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>Pagination token.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessions": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListTestGridSessionsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListTestGridSessionsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of sessions for a <a>TestGridProject</a>.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResult"
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionsRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>ARN of a <a>TestGridProject</a>.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.devicefarm#TestGridSessionStatus",
"traits": {
"smithy.api#documentation": "<p>Return only sessions in this state.</p>"
}
},
"creationTimeAfter": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>Return only sessions created after this time.</p>"
}
},
"creationTimeBefore": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>Return only sessions created before this time.</p>"
}
},
"endTimeAfter": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>Return only sessions that ended after this time.</p>"
}
},
"endTimeBefore": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>Return only sessions that ended before this time.</p>"
}
},
"maxResult": {
"target": "com.amazonaws.devicefarm#MaxPageSize",
"traits": {
"smithy.api#documentation": "<p>Return only this many results at a time.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>Pagination token.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTestGridSessionsResult": {
"type": "structure",
"members": {
"testGridSessions": {
"target": "com.amazonaws.devicefarm#TestGridSessions",
"traits": {
"smithy.api#documentation": "<p>The sessions that match the criteria in a <a>ListTestGridSessionsRequest</a>. </p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>Pagination token.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListTests": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListTestsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListTestsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about tests in a given test suite.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "tests"
}
}
},
"com.amazonaws.devicefarm#ListTestsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The test suite's Amazon Resource Name (ARN).</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list tests operation.</p>"
}
},
"com.amazonaws.devicefarm#ListTestsResult": {
"type": "structure",
"members": {
"tests": {
"target": "com.amazonaws.devicefarm#Tests",
"traits": {
"smithy.api#documentation": "<p>Information about the tests.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list tests request.</p>"
}
},
"com.amazonaws.devicefarm#ListUniqueProblems": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListUniqueProblemsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListUniqueProblemsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about unique problems, such as exceptions or crashes.</p>\n <p>Unique problems are defined as a single instance of an error across a run, job, or suite. For example,\n if a call in your application consistently raises an exception (<code>OutOfBoundsException in\n MyActivity.java:386</code>), <code>ListUniqueProblems</code> returns a single entry instead of many\n individual entries for that exception.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "uniqueProblems"
}
}
},
"com.amazonaws.devicefarm#ListUniqueProblemsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The unique problems' ARNs.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list unique problems operation.</p>"
}
},
"com.amazonaws.devicefarm#ListUniqueProblemsResult": {
"type": "structure",
"members": {
"uniqueProblems": {
"target": "com.amazonaws.devicefarm#UniqueProblemsByExecutionResultMap",
"traits": {
"smithy.api#documentation": "<p>Information about the unique problems.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PASSED</p>\n </li>\n <li>\n <p>WARNED</p>\n </li>\n <li>\n <p>FAILED</p>\n </li>\n <li>\n <p>SKIPPED</p>\n </li>\n <li>\n <p>ERRORED</p>\n </li>\n <li>\n <p>STOPPED</p>\n </li>\n </ul>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list unique problems request.</p>"
}
},
"com.amazonaws.devicefarm#ListUploads": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListUploadsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListUploadsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about uploads, given an AWS Device Farm project ARN.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "uploads"
}
}
},
"com.amazonaws.devicefarm#ListUploadsRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project for which you want to list\n uploads.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.devicefarm#UploadType",
"traits": {
"smithy.api#documentation": "<p>The type of upload.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>ANDROID_APP</p>\n </li>\n <li>\n <p>IOS_APP</p>\n </li>\n <li>\n <p>WEB_APP</p>\n </li>\n <li>\n <p>EXTERNAL_DATA</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_NODE_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_RUBY_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY_TEST_PACKAGE</p>\n </li>\n <li>\n <p>CALABASH_TEST_PACKAGE</p>\n </li>\n <li>\n <p>INSTRUMENTATION_TEST_PACKAGE</p>\n </li>\n <li>\n <p>UIAUTOMATION_TEST_PACKAGE</p>\n </li>\n <li>\n <p>UIAUTOMATOR_TEST_PACKAGE</p>\n </li>\n <li>\n <p>XCTEST_TEST_PACKAGE</p>\n </li>\n <li>\n <p>XCTEST_UI_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_NODE_TEST_SPEC</p>\n </li>\n <li>\n <p> APPIUM_RUBY_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY_TEST_SPEC</p>\n </li>\n <li>\n <p>INSTRUMENTATION_TEST_SPEC</p>\n </li>\n <li>\n <p>XCTEST_UI_TEST_SPEC</p>\n </li>\n </ul>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the list uploads operation.</p>"
}
},
"com.amazonaws.devicefarm#ListUploadsResult": {
"type": "structure",
"members": {
"uploads": {
"target": "com.amazonaws.devicefarm#Uploads",
"traits": {
"smithy.api#documentation": "<p>Information about the uploads.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a list uploads request.</p>"
}
},
"com.amazonaws.devicefarm#ListVPCEConfigurations": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ListVPCEConfigurationsRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ListVPCEConfigurationsResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about all Amazon Virtual Private Cloud (VPC) endpoint\n configurations in the AWS account.</p>"
}
},
"com.amazonaws.devicefarm#ListVPCEConfigurationsRequest": {
"type": "structure",
"members": {
"maxResults": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>An integer that specifies the maximum number of items you want to return in the API response.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#ListVPCEConfigurationsResult": {
"type": "structure",
"members": {
"vpceConfigurations": {
"target": "com.amazonaws.devicefarm#VPCEConfigurations",
"traits": {
"smithy.api#documentation": "<p>An array of <code>VPCEConfiguration</code> objects that contain information about your VPC endpoint\n configuration.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.devicefarm#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.</p>"
}
}
}
},
"com.amazonaws.devicefarm#Location": {
"type": "structure",
"members": {
"latitude": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>The latitude.</p>",
"smithy.api#required": {}
}
},
"longitude": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>The longitude.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for\n example, 47.6204, -122.3491).</p>\n <p>Elevation is currently not supported.</p>"
}
},
"com.amazonaws.devicefarm#Long": {
"type": "long",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#MaxPageSize": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 1,
"max": 1000
}
}
},
"com.amazonaws.devicefarm#MaxSlotMap": {
"type": "map",
"key": {
"target": "com.amazonaws.devicefarm#String"
},
"value": {
"target": "com.amazonaws.devicefarm#Integer"
}
},
"com.amazonaws.devicefarm#Message": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 16384
}
}
},
"com.amazonaws.devicefarm#Metadata": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 8192
}
}
},
"com.amazonaws.devicefarm#MonetaryAmount": {
"type": "structure",
"members": {
"amount": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>The numerical amount of an offering or transaction.</p>"
}
},
"currencyCode": {
"target": "com.amazonaws.devicefarm#CurrencyCode",
"traits": {
"smithy.api#documentation": "<p>The currency code of a monetary amount. For example, <code>USD</code> means U.S. dollars.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A number that represents the monetary amount for an offering or transaction.</p>"
}
},
"com.amazonaws.devicefarm#Name": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 256
}
}
},
"com.amazonaws.devicefarm#NetworkProfile": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the network profile.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the network profile.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The description of the network profile.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#NetworkProfileType",
"traits": {
"smithy.api#documentation": "<p>The type of network profile. Valid values are listed here.</p>"
}
},
"uplinkBandwidthBits": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The data throughput rate in bits per second, as an integer from 0 to\n 104857600.</p>"
}
},
"downlinkBandwidthBits": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The data throughput rate in bits per second, as an integer from 0 to\n 104857600.</p>"
}
},
"uplinkDelayMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.</p>"
}
},
"downlinkDelayMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.</p>"
}
},
"uplinkJitterMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.</p>"
}
},
"downlinkJitterMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.</p>"
}
},
"uplinkLossPercent": {
"target": "com.amazonaws.devicefarm#PercentInteger",
"traits": {
"smithy.api#documentation": "<p>Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.</p>"
}
},
"downlinkLossPercent": {
"target": "com.amazonaws.devicefarm#PercentInteger",
"traits": {
"smithy.api#documentation": "<p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An array of settings that describes characteristics of a network profile.</p>"
}
},
"com.amazonaws.devicefarm#NetworkProfileType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CURATED",
"name": "CURATED"
},
{
"value": "PRIVATE",
"name": "PRIVATE"
}
]
}
},
"com.amazonaws.devicefarm#NetworkProfiles": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#NetworkProfile"
}
},
"com.amazonaws.devicefarm#NotEligibleException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The HTTP response code of a Not Eligible exception.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Exception gets thrown when a user is not eligible to perform the specified\n transaction.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.devicefarm#NotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>Any additional information about the exception.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The specified entity was not found.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.devicefarm#Offering": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.devicefarm#OfferingIdentifier",
"traits": {
"smithy.api#documentation": "<p>The ID that corresponds to a device offering.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A string that describes the offering.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#OfferingType",
"traits": {
"smithy.api#documentation": "<p>The type of offering (for example, <code>RECURRING</code>) for a device.</p>"
}
},
"platform": {
"target": "com.amazonaws.devicefarm#DevicePlatform",
"traits": {
"smithy.api#documentation": "<p>The platform of the device (for example, <code>ANDROID</code> or <code>IOS</code>).</p>"
}
},
"recurringCharges": {
"target": "com.amazonaws.devicefarm#RecurringCharges",
"traits": {
"smithy.api#documentation": "<p>Specifies whether there are recurring charges for the offering.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the metadata of a device offering.</p>"
}
},
"com.amazonaws.devicefarm#OfferingIdentifier": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 32
}
}
},
"com.amazonaws.devicefarm#OfferingPromotion": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.devicefarm#OfferingPromotionIdentifier",
"traits": {
"smithy.api#documentation": "<p>The ID of the offering promotion.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A string that describes the offering promotion.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents information about an offering promotion.</p>"
}
},
"com.amazonaws.devicefarm#OfferingPromotionIdentifier": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 4
}
}
},
"com.amazonaws.devicefarm#OfferingPromotions": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#OfferingPromotion"
}
},
"com.amazonaws.devicefarm#OfferingStatus": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.devicefarm#OfferingTransactionType",
"traits": {
"smithy.api#documentation": "<p>The type specified for the offering status.</p>"
}
},
"offering": {
"target": "com.amazonaws.devicefarm#Offering",
"traits": {
"smithy.api#documentation": "<p>Represents the metadata of an offering status.</p>"
}
},
"quantity": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of available devices in the offering.</p>"
}
},
"effectiveOn": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The date on which the offering is effective.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The status of the offering.</p>"
}
},
"com.amazonaws.devicefarm#OfferingStatusMap": {
"type": "map",
"key": {
"target": "com.amazonaws.devicefarm#OfferingIdentifier"
},
"value": {
"target": "com.amazonaws.devicefarm#OfferingStatus"
}
},
"com.amazonaws.devicefarm#OfferingTransaction": {
"type": "structure",
"members": {
"offeringStatus": {
"target": "com.amazonaws.devicefarm#OfferingStatus",
"traits": {
"smithy.api#documentation": "<p>The status of an offering transaction.</p>"
}
},
"transactionId": {
"target": "com.amazonaws.devicefarm#TransactionIdentifier",
"traits": {
"smithy.api#documentation": "<p>The transaction ID of the offering transaction.</p>"
}
},
"offeringPromotionId": {
"target": "com.amazonaws.devicefarm#OfferingPromotionIdentifier",
"traits": {
"smithy.api#documentation": "<p>The ID that corresponds to a device offering promotion.</p>"
}
},
"createdOn": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The date on which an offering transaction was created.</p>"
}
},
"cost": {
"target": "com.amazonaws.devicefarm#MonetaryAmount",
"traits": {
"smithy.api#documentation": "<p>The cost of an offering transaction.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the metadata of an offering transaction.</p>"
}
},
"com.amazonaws.devicefarm#OfferingTransactionType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PURCHASE",
"name": "PURCHASE"
},
{
"value": "RENEW",
"name": "RENEW"
},
{
"value": "SYSTEM",
"name": "SYSTEM"
}
]
}
},
"com.amazonaws.devicefarm#OfferingTransactions": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#OfferingTransaction"
}
},
"com.amazonaws.devicefarm#OfferingType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "RECURRING",
"name": "RECURRING"
}
]
}
},
"com.amazonaws.devicefarm#Offerings": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Offering"
}
},
"com.amazonaws.devicefarm#PackageIds": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#String"
}
},
"com.amazonaws.devicefarm#PaginationToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 4,
"max": 1024
}
}
},
"com.amazonaws.devicefarm#PercentInteger": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 100
}
}
},
"com.amazonaws.devicefarm#Problem": {
"type": "structure",
"members": {
"run": {
"target": "com.amazonaws.devicefarm#ProblemDetail",
"traits": {
"smithy.api#documentation": "<p>Information about the associated run.</p>"
}
},
"job": {
"target": "com.amazonaws.devicefarm#ProblemDetail",
"traits": {
"smithy.api#documentation": "<p>Information about the associated job.</p>"
}
},
"suite": {
"target": "com.amazonaws.devicefarm#ProblemDetail",
"traits": {
"smithy.api#documentation": "<p>Information about the associated suite.</p>"
}
},
"test": {
"target": "com.amazonaws.devicefarm#ProblemDetail",
"traits": {
"smithy.api#documentation": "<p>Information about the associated test.</p>"
}
},
"device": {
"target": "com.amazonaws.devicefarm#Device",
"traits": {
"smithy.api#documentation": "<p>Information about the associated device.</p>"
}
},
"result": {
"target": "com.amazonaws.devicefarm#ExecutionResult",
"traits": {
"smithy.api#documentation": "<p>The problem's result.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PASSED</p>\n </li>\n <li>\n <p>WARNED</p>\n </li>\n <li>\n <p>FAILED</p>\n </li>\n <li>\n <p>SKIPPED</p>\n </li>\n <li>\n <p>ERRORED</p>\n </li>\n <li>\n <p>STOPPED</p>\n </li>\n </ul>"
}
},
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the problem's result.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a specific warning or failure.</p>"
}
},
"com.amazonaws.devicefarm#ProblemDetail": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The problem detail's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The problem detail's name.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about a problem detail.</p>"
}
},
"com.amazonaws.devicefarm#Problems": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Problem"
}
},
"com.amazonaws.devicefarm#Project": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The project's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The project's name.</p>"
}
},
"defaultJobTimeoutMinutes": {
"target": "com.amazonaws.devicefarm#JobTimeoutMinutes",
"traits": {
"smithy.api#documentation": "<p>The default number of minutes (at the project level) a test run executes before it times out. The\n default value is 150 minutes.</p>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>When the project was created.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents an operating-system neutral workspace for running and managing\n tests.</p>"
}
},
"com.amazonaws.devicefarm#Projects": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Project"
}
},
"com.amazonaws.devicefarm#PurchaseOffering": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#PurchaseOfferingRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#PurchaseOfferingResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotEligibleException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased\n quantity for an offering, unless the renewal was overridden. The API returns a <code>NotEligible</code>\n error if the user is not permitted to invoke the operation. If you must be able to invoke this operation,\n contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>"
}
},
"com.amazonaws.devicefarm#PurchaseOfferingRequest": {
"type": "structure",
"members": {
"offeringId": {
"target": "com.amazonaws.devicefarm#OfferingIdentifier",
"traits": {
"smithy.api#documentation": "<p>The ID of the offering.</p>"
}
},
"quantity": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of device slots to purchase in an offering request.</p>"
}
},
"offeringPromotionId": {
"target": "com.amazonaws.devicefarm#OfferingPromotionIdentifier",
"traits": {
"smithy.api#documentation": "<p>The ID of the offering promotion to be applied to the purchase.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request for a purchase offering.</p>"
}
},
"com.amazonaws.devicefarm#PurchaseOfferingResult": {
"type": "structure",
"members": {
"offeringTransaction": {
"target": "com.amazonaws.devicefarm#OfferingTransaction",
"traits": {
"smithy.api#documentation": "<p>Represents the offering transaction for the purchase result.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of the purchase offering (for example, success or failure).</p>"
}
},
"com.amazonaws.devicefarm#PurchasedDevicesMap": {
"type": "map",
"key": {
"target": "com.amazonaws.devicefarm#DevicePlatform"
},
"value": {
"target": "com.amazonaws.devicefarm#Integer"
}
},
"com.amazonaws.devicefarm#Radios": {
"type": "structure",
"members": {
"wifi": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.</p>"
}
},
"bluetooth": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if Bluetooth is enabled at the beginning of the test. Otherwise, false.</p>"
}
},
"nfc": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if NFC is enabled at the beginning of the test. Otherwise, false.</p>"
}
},
"gps": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if GPS is enabled at the beginning of the test. Otherwise, false.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the set of radios and their states on a device. Examples of radios\n include Wi-Fi, GPS, Bluetooth, and NFC.</p>"
}
},
"com.amazonaws.devicefarm#RecurringCharge": {
"type": "structure",
"members": {
"cost": {
"target": "com.amazonaws.devicefarm#MonetaryAmount",
"traits": {
"smithy.api#documentation": "<p>The cost of the recurring charge.</p>"
}
},
"frequency": {
"target": "com.amazonaws.devicefarm#RecurringChargeFrequency",
"traits": {
"smithy.api#documentation": "<p>The frequency in which charges recur.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Specifies whether charges for devices are recurring.</p>"
}
},
"com.amazonaws.devicefarm#RecurringChargeFrequency": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "MONTHLY",
"name": "MONTHLY"
}
]
}
},
"com.amazonaws.devicefarm#RecurringCharges": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#RecurringCharge"
}
},
"com.amazonaws.devicefarm#RemoteAccessSession": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the remote access session.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the remote access session.</p>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The date and time the remote access session was created.</p>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#ExecutionStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the remote access session. Can be any of the following:</p>\n <ul>\n <li>\n <p>PENDING.</p>\n </li>\n <li>\n <p>PENDING_CONCURRENCY.</p>\n </li>\n <li>\n <p>PENDING_DEVICE.</p>\n </li>\n <li>\n <p>PROCESSING.</p>\n </li>\n <li>\n <p>SCHEDULING.</p>\n </li>\n <li>\n <p>PREPARING.</p>\n </li>\n <li>\n <p>RUNNING.</p>\n </li>\n <li>\n <p>COMPLETED.</p>\n </li>\n <li>\n <p>STOPPING.</p>\n </li>\n </ul>"
}
},
"result": {
"target": "com.amazonaws.devicefarm#ExecutionResult",
"traits": {
"smithy.api#documentation": "<p>The result of the remote access session. Can be any of the following:</p>\n <ul>\n <li>\n <p>PENDING.</p>\n </li>\n <li>\n <p>PASSED.</p>\n </li>\n <li>\n <p>WARNED.</p>\n </li>\n <li>\n <p>FAILED.</p>\n </li>\n <li>\n <p>SKIPPED.</p>\n </li>\n <li>\n <p>ERRORED.</p>\n </li>\n <li>\n <p>STOPPED.</p>\n </li>\n </ul>"
}
},
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the remote access session.</p>"
}
},
"started": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The date and time the remote access session was started.</p>"
}
},
"stopped": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The date and time the remote access session was stopped.</p>"
}
},
"device": {
"target": "com.amazonaws.devicefarm#Device",
"traits": {
"smithy.api#documentation": "<p>The device (phone or tablet) used in the remote access session.</p>"
}
},
"instanceArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the instance.</p>"
}
},
"remoteDebugEnabled": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote\n access session.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"remoteRecordEnabled": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>This flag is set to <code>true</code> if remote recording is enabled for the remote\n access session.</p>"
}
},
"remoteRecordAppArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN for the app to be recorded in the remote access session.</p>"
}
},
"hostAddress": {
"target": "com.amazonaws.devicefarm#HostAddress",
"traits": {
"smithy.api#documentation": "<p>IP address of the EC2 host where you need to connect to remotely debug devices.\n Only returned if remote debugging is enabled for the remote access session.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"clientId": {
"target": "com.amazonaws.devicefarm#ClientId",
"traits": {
"smithy.api#documentation": "<p>Unique identifier of your client for the remote access session. Only returned if\n remote debugging is enabled for the remote access session.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"billingMethod": {
"target": "com.amazonaws.devicefarm#BillingMethod",
"traits": {
"smithy.api#documentation": "<p>The billing method of the remote access session. Possible values include <code>METERED</code> or\n <code>UNMETERED</code>. For more information about metered devices, see <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm\n terminology</a>.</p>"
}
},
"deviceMinutes": {
"target": "com.amazonaws.devicefarm#DeviceMinutes",
"traits": {
"smithy.api#documentation": "<p>The number of minutes a device is used in a remote access session (including setup\n and teardown minutes).</p>"
}
},
"endpoint": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The endpoint for the remote access sesssion.</p>"
}
},
"deviceUdid": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>Unique device identifier for the remote device. Only returned if remote debugging\n is enabled for the remote access session.</p>\n <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no\n longer supported</a>.</p>"
}
},
"interactionMode": {
"target": "com.amazonaws.devicefarm#InteractionMode",
"traits": {
"smithy.api#documentation": "<p>The interaction mode of the remote access session. Valid values are:</p>\n <ul>\n <li>\n <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and\n rotating the screen. You cannot run XCUITest framework-based tests in this\n mode.</p>\n </li>\n <li>\n <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This\n mode has the fastest test execution speed. You can run XCUITest framework-based tests in this\n mode.</p>\n </li>\n <li>\n <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest\n framework-based tests and watch the screen in this mode.</p>\n </li>\n </ul>"
}
},
"skipAppResign": {
"target": "com.amazonaws.devicefarm#SkipAppResign",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.</p>\n <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device\n Farm FAQs</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents information about the remote access session.</p>"
}
},
"com.amazonaws.devicefarm#RemoteAccessSessions": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#RemoteAccessSession"
}
},
"com.amazonaws.devicefarm#RenewOffering": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#RenewOfferingRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#RenewOfferingResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotEligibleException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Explicitly sets the quantity of devices to renew for an offering, starting from the\n <code>effectiveDate</code> of the next period. The API returns a <code>NotEligible</code> error if the\n user is not permitted to invoke the operation. If you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>"
}
},
"com.amazonaws.devicefarm#RenewOfferingRequest": {
"type": "structure",
"members": {
"offeringId": {
"target": "com.amazonaws.devicefarm#OfferingIdentifier",
"traits": {
"smithy.api#documentation": "<p>The ID of a request to renew an offering.</p>"
}
},
"quantity": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The quantity requested in an offering renewal.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A request that represents an offering renewal.</p>"
}
},
"com.amazonaws.devicefarm#RenewOfferingResult": {
"type": "structure",
"members": {
"offeringTransaction": {
"target": "com.amazonaws.devicefarm#OfferingTransaction",
"traits": {
"smithy.api#documentation": "<p>Represents the status of the offering transaction for the renewal.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a renewal offering.</p>"
}
},
"com.amazonaws.devicefarm#Resolution": {
"type": "structure",
"members": {
"width": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The screen resolution's width, expressed in pixels.</p>"
}
},
"height": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The screen resolution's height, expressed in pixels.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the screen resolution of a device in height and width, expressed in\n pixels.</p>"
}
},
"com.amazonaws.devicefarm#ResourceDescription": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2048
},
"smithy.api#pattern": ".*\\S.*"
}
},
"com.amazonaws.devicefarm#ResourceId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 128
},
"smithy.api#pattern": ".*\\S.*"
}
},
"com.amazonaws.devicefarm#ResourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": ".*\\S.*"
}
},
"com.amazonaws.devicefarm#Rule": {
"type": "structure",
"members": {
"attribute": {
"target": "com.amazonaws.devicefarm#DeviceAttribute",
"traits": {
"smithy.api#documentation": "<p>The rule's stringified attribute. For example, specify the value as\n <code>\"\\\"abc\\\"\"</code>.</p>\n <p>The supported operators for each attribute are provided in the following\n list.</p>\n <dl>\n <dt>APPIUM_VERSION</dt>\n <dd>\n <p>The Appium version for the test.</p>\n <p>Supported operators: <code>CONTAINS</code>\n </p>\n </dd>\n <dt>ARN</dt>\n <dd>\n <p>The Amazon Resource Name (ARN) of the device (for example,\n <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>.</p>\n <p>Supported operators: <code>EQUALS</code>,\n <code>IN</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>AVAILABILITY</dt>\n <dd>\n <p>The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n </dd>\n <dt>FLEET_TYPE</dt>\n <dd>\n <p>The fleet type. Valid values are PUBLIC or PRIVATE.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n </dd>\n <dt>FORM_FACTOR</dt>\n <dd>\n <p>The device form factor. Valid values are PHONE or TABLET.</p>\n <p>Supported operators: <code>EQUALS</code>,\n <code>IN</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>INSTANCE_ARN</dt>\n <dd>\n <p>The Amazon Resource Name (ARN) of the device instance.</p>\n <p>Supported operators: <code>IN</code>,\n <code>NOT_IN</code>\n </p>\n </dd>\n <dt>INSTANCE_LABELS</dt>\n <dd>\n <p>The label of the device instance.</p>\n <p>Supported operators: <code>CONTAINS</code>\n </p>\n </dd>\n <dt>MANUFACTURER</dt>\n <dd>\n <p>The device manufacturer (for example, Apple).</p>\n <p>Supported operators: <code>EQUALS</code>,\n <code>IN</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>MODEL</dt>\n <dd>\n <p>The device model, such as Apple iPad Air 2 or Google Pixel.</p>\n <p>Supported operators: <code>CONTAINS</code>,\n <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>OS_VERSION</dt>\n <dd>\n <p>The operating system version (for example, 10.3.2).</p>\n <p>Supported operators: <code>EQUALS</code>,\n <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>,\n <code>IN</code>, <code>LESS_THAN</code>,\n <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>PLATFORM</dt>\n <dd>\n <p>The device platform. Valid values are ANDROID or IOS.</p>\n <p>Supported operators: <code>EQUALS</code>,\n <code>IN</code>, <code>NOT_IN</code>\n </p>\n </dd>\n <dt>REMOTE_ACCESS_ENABLED</dt>\n <dd>\n <p>Whether the device is enabled for remote access. Valid values are TRUE\n or FALSE.</p>\n <p>Supported operators: <code>EQUALS</code>\n </p>\n </dd>\n <dt>REMOTE_DEBUG_E
}
},
"operator": {
"target": "com.amazonaws.devicefarm#RuleOperator",
"traits": {
"smithy.api#documentation": "<p>Specifies how Device Farm compares the rule's attribute to the value. For the\n operators that are supported by each attribute, see the attribute\n descriptions.</p>"
}
},
"value": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The rule's value.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a condition for a device pool.</p>"
}
},
"com.amazonaws.devicefarm#RuleOperator": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "EQUALS",
"name": "EQUALS"
},
{
"value": "LESS_THAN",
"name": "LESS_THAN"
},
{
"value": "LESS_THAN_OR_EQUALS",
"name": "LESS_THAN_OR_EQUALS"
},
{
"value": "GREATER_THAN",
"name": "GREATER_THAN"
},
{
"value": "GREATER_THAN_OR_EQUALS",
"name": "GREATER_THAN_OR_EQUALS"
},
{
"value": "IN",
"name": "IN"
},
{
"value": "NOT_IN",
"name": "NOT_IN"
},
{
"value": "CONTAINS",
"name": "CONTAINS"
}
]
}
},
"com.amazonaws.devicefarm#Rules": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Rule"
}
},
"com.amazonaws.devicefarm#Run": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The run's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The run's name.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#TestType",
"traits": {
"smithy.api#documentation": "<p>The run's type.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>BUILTIN_FUZZ</p>\n </li>\n <li>\n <p>BUILTIN_EXPLORER</p>\n <note>\n <p>For Android, an app explorer that traverses an Android app, interacting with it and capturing\n screenshots at the same time.</p>\n </note>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_NODE</p>\n </li>\n <li>\n <p>APPIUM_RUBY</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY</p>\n </li>\n <li>\n <p>CALABASH</p>\n </li>\n <li>\n <p>INSTRUMENTATION</p>\n </li>\n <li>\n <p>UIAUTOMATION</p>\n </li>\n <li>\n <p>UIAUTOMATOR</p>\n </li>\n <li>\n <p>XCTEST</p>\n </li>\n <li>\n <p>XCTEST_UI</p>\n </li>\n </ul>"
}
},
"platform": {
"target": "com.amazonaws.devicefarm#DevicePlatform",
"traits": {
"smithy.api#documentation": "<p>The run's platform.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>ANDROID</p>\n </li>\n <li>\n <p>IOS</p>\n </li>\n </ul>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>When the run was created.</p>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#ExecutionStatus",
"traits": {
"smithy.api#documentation": "<p>The run's status.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PENDING_CONCURRENCY</p>\n </li>\n <li>\n <p>PENDING_DEVICE</p>\n </li>\n <li>\n <p>PROCESSING</p>\n </li>\n <li>\n <p>SCHEDULING</p>\n </li>\n <li>\n <p>PREPARING</p>\n </li>\n <li>\n <p>RUNNING</p>\n </li>\n <li>\n <p>COMPLETED</p>\n </li>\n <li>\n <p>STOPPING</p>\n </li>\n </ul>"
}
},
"result": {
"target": "com.amazonaws.devicefarm#ExecutionResult",
"traits": {
"smithy.api#documentation": "<p>The run's result.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PASSED</p>\n </li>\n <li>\n <p>WARNED</p>\n </li>\n <li>\n <p>FAILED</p>\n </li>\n <li>\n <p>SKIPPED</p>\n </li>\n <li>\n <p>ERRORED</p>\n </li>\n <li>\n <p>STOPPED</p>\n </li>\n </ul>"
}
},
"started": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The run's start time.</p>"
}
},
"stopped": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The run's stop time.</p>"
}
},
"counters": {
"target": "com.amazonaws.devicefarm#Counters",
"traits": {
"smithy.api#documentation": "<p>The run's result counters.</p>"
}
},
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the run's result.</p>"
}
},
"totalJobs": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The total number of jobs for the run.</p>"
}
},
"completedJobs": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The total number of completed jobs.</p>"
}
},
"billingMethod": {
"target": "com.amazonaws.devicefarm#BillingMethod",
"traits": {
"smithy.api#documentation": "<p>Specifies the billing method for a test run: <code>metered</code> or\n <code>unmetered</code>. If the parameter is not specified, the default value is\n <code>metered</code>.</p>\n <note>\n <p>If you have unmetered device slots, you must set this to <code>unmetered</code> to use them.\n Otherwise, the run is counted toward metered device minutes.</p>\n </note>"
}
},
"deviceMinutes": {
"target": "com.amazonaws.devicefarm#DeviceMinutes",
"traits": {
"smithy.api#documentation": "<p>Represents the total (metered or unmetered) minutes used by the test run.</p>"
}
},
"networkProfile": {
"target": "com.amazonaws.devicefarm#NetworkProfile",
"traits": {
"smithy.api#documentation": "<p>The network profile being used for a test run.</p>"
}
},
"parsingResultUrl": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package.\n If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points\n to.</p>"
}
},
"resultCode": {
"target": "com.amazonaws.devicefarm#ExecutionResultCode",
"traits": {
"smithy.api#documentation": "<p>Supporting field for the result field. Set only if <code>result</code> is <code>SKIPPED</code>.\n <code>PARSING_FAILED</code> if the result is skipped because of test package parsing failure.</p>"
}
},
"seed": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same\n seed value between tests ensures identical event sequences.</p>"
}
},
"appUpload": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>An app to upload or that has been uploaded.</p>"
}
},
"eventCount": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz\n test should perform.</p>"
}
},
"jobTimeoutMinutes": {
"target": "com.amazonaws.devicefarm#JobTimeoutMinutes",
"traits": {
"smithy.api#documentation": "<p>The number of minutes the job executes before it times out.</p>"
}
},
"devicePoolArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the device pool for the run.</p>"
}
},
"locale": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>Information about the locale that is used for the run.</p>"
}
},
"radios": {
"target": "com.amazonaws.devicefarm#Radios",
"traits": {
"smithy.api#documentation": "<p>Information about the radio states for the run.</p>"
}
},
"location": {
"target": "com.amazonaws.devicefarm#Location",
"traits": {
"smithy.api#documentation": "<p>Information about the location that is used for the run.</p>"
}
},
"customerArtifactPaths": {
"target": "com.amazonaws.devicefarm#CustomerArtifactPaths",
"traits": {
"smithy.api#documentation": "<p>Output <code>CustomerArtifactPaths</code> object for the test run.</p>"
}
},
"webUrl": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The Device Farm console URL for the recording of the run.</p>"
}
},
"skipAppResign": {
"target": "com.amazonaws.devicefarm#SkipAppResign",
"traits": {
"smithy.api#documentation": "<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.</p>\n <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device\n Farm FAQs</i>.</p>"
}
},
"testSpecArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the YAML-formatted test specification for the run.</p>"
}
},
"deviceSelectionResult": {
"target": "com.amazonaws.devicefarm#DeviceSelectionResult",
"traits": {
"smithy.api#documentation": "<p>The results of a device filter used to select the devices for a test run.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a test run on a set of devices with a given app package, test parameters, and so\n on.</p>"
}
},
"com.amazonaws.devicefarm#Runs": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Run"
}
},
"com.amazonaws.devicefarm#Sample": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The sample's ARN.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#SampleType",
"traits": {
"smithy.api#documentation": "<p>The sample's type.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>CPU: A CPU sample type. This is expressed as the app processing CPU time\n (including child processes) as reported by process, as a percentage.</p>\n </li>\n <li>\n <p>MEMORY: A memory usage sample type. This is expressed as the total\n proportional set size of an app process, in kilobytes.</p>\n </li>\n <li>\n <p>NATIVE_AVG_DRAWTIME</p>\n </li>\n <li>\n <p>NATIVE_FPS</p>\n </li>\n <li>\n <p>NATIVE_FRAMES</p>\n </li>\n <li>\n <p>NATIVE_MAX_DRAWTIME</p>\n </li>\n <li>\n <p>NATIVE_MIN_DRAWTIME</p>\n </li>\n <li>\n <p>OPENGL_AVG_DRAWTIME</p>\n </li>\n <li>\n <p>OPENGL_FPS</p>\n </li>\n <li>\n <p>OPENGL_FRAMES</p>\n </li>\n <li>\n <p>OPENGL_MAX_DRAWTIME</p>\n </li>\n <li>\n <p>OPENGL_MIN_DRAWTIME</p>\n </li>\n <li>\n <p>RX</p>\n </li>\n <li>\n <p>RX_RATE: The total number of bytes per second (TCP and UDP) that are sent,\n by app process.</p>\n </li>\n <li>\n <p>THREADS: A threads sample type. This is expressed as the total number of\n threads per app process.</p>\n </li>\n <li>\n <p>TX</p>\n </li>\n <li>\n <p>TX_RATE: The total number of bytes per second (TCP and UDP) that are\n received, by app process.</p>\n </li>\n </ul>"
}
},
"url": {
"target": "com.amazonaws.devicefarm#URL",
"traits": {
"smithy.api#documentation": "<p>The presigned Amazon S3 URL that can be used with a GET request to download the sample's\n file.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a sample of performance data.</p>"
}
},
"com.amazonaws.devicefarm#SampleType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CPU",
"name": "CPU"
},
{
"value": "MEMORY",
"name": "MEMORY"
},
{
"value": "THREADS",
"name": "THREADS"
},
{
"value": "RX_RATE",
"name": "RX_RATE"
},
{
"value": "TX_RATE",
"name": "TX_RATE"
},
{
"value": "RX",
"name": "RX"
},
{
"value": "TX",
"name": "TX"
},
{
"value": "NATIVE_FRAMES",
"name": "NATIVE_FRAMES"
},
{
"value": "NATIVE_FPS",
"name": "NATIVE_FPS"
},
{
"value": "NATIVE_MIN_DRAWTIME",
"name": "NATIVE_MIN_DRAWTIME"
},
{
"value": "NATIVE_AVG_DRAWTIME",
"name": "NATIVE_AVG_DRAWTIME"
},
{
"value": "NATIVE_MAX_DRAWTIME",
"name": "NATIVE_MAX_DRAWTIME"
},
{
"value": "OPENGL_FRAMES",
"name": "OPENGL_FRAMES"
},
{
"value": "OPENGL_FPS",
"name": "OPENGL_FPS"
},
{
"value": "OPENGL_MIN_DRAWTIME",
"name": "OPENGL_MIN_DRAWTIME"
},
{
"value": "OPENGL_AVG_DRAWTIME",
"name": "OPENGL_AVG_DRAWTIME"
},
{
"value": "OPENGL_MAX_DRAWTIME",
"name": "OPENGL_MAX_DRAWTIME"
}
]
}
},
"com.amazonaws.devicefarm#Samples": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Sample"
}
},
"com.amazonaws.devicefarm#ScheduleRun": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#ScheduleRunRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#ScheduleRunResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#IdempotencyException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Schedules a run.</p>"
}
},
"com.amazonaws.devicefarm#ScheduleRunConfiguration": {
"type": "structure",
"members": {
"extraDataPackageArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to\n external data for Android or the app's sandbox for iOS.</p>"
}
},
"networkProfileArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Reserved for internal use.</p>"
}
},
"locale": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>Information about the locale that is used for the run.</p>"
}
},
"location": {
"target": "com.amazonaws.devicefarm#Location",
"traits": {
"smithy.api#documentation": "<p>Information about the location that is used for the run.</p>"
}
},
"vpceConfigurationArns": {
"target": "com.amazonaws.devicefarm#AmazonResourceNames",
"traits": {
"smithy.api#documentation": "<p>An array of ARNs for your VPC endpoint configurations.</p>"
}
},
"customerArtifactPaths": {
"target": "com.amazonaws.devicefarm#CustomerArtifactPaths",
"traits": {
"smithy.api#documentation": "<p>Input <code>CustomerArtifactPaths</code> object for the scheduled run\n configuration.</p>"
}
},
"radios": {
"target": "com.amazonaws.devicefarm#Radios",
"traits": {
"smithy.api#documentation": "<p>Information about the radio states for the run.</p>"
}
},
"auxiliaryApps": {
"target": "com.amazonaws.devicefarm#AmazonResourceNames",
"traits": {
"smithy.api#documentation": "<p>A list of upload ARNs for app packages to be installed with your app.</p>"
}
},
"billingMethod": {
"target": "com.amazonaws.devicefarm#BillingMethod",
"traits": {
"smithy.api#documentation": "<p>Specifies the billing method for a test run: <code>metered</code> or\n <code>unmetered</code>. If the parameter is not specified, the default value is\n <code>metered</code>.</p>\n <note>\n <p>If you have purchased unmetered device slots, you must set this parameter to <code>unmetered</code> to\n make use of them. Otherwise, your run counts against your metered time.</p>\n </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the settings for a run. Includes things like location, radio states,\n auxiliary apps, and network profiles.</p>"
}
},
"com.amazonaws.devicefarm#ScheduleRunRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the project for the run to be scheduled.</p>",
"smithy.api#required": {}
}
},
"appArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of an application package to run tests against, created with <a>CreateUpload</a>.\n See <a>ListUploads</a>.</p>"
}
},
"devicePoolArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the device pool for the run to be scheduled.</p>"
}
},
"deviceSelectionConfiguration": {
"target": "com.amazonaws.devicefarm#DeviceSelectionConfiguration",
"traits": {
"smithy.api#documentation": "<p>The filter criteria used to dynamically select a set of devices for a test run and the maximum number of\n devices to be included in the run.</p>\n <p>Either <b>\n <code>devicePoolArn</code>\n </b> or <b>\n <code>deviceSelectionConfiguration</code>\n </b> is required in a\n request.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name for the run to be scheduled.</p>"
}
},
"test": {
"target": "com.amazonaws.devicefarm#ScheduleRunTest",
"traits": {
"smithy.api#documentation": "<p>Information about the test for the run to be scheduled.</p>",
"smithy.api#required": {}
}
},
"configuration": {
"target": "com.amazonaws.devicefarm#ScheduleRunConfiguration",
"traits": {
"smithy.api#documentation": "<p>Information about the settings for the run to be scheduled.</p>"
}
},
"executionConfiguration": {
"target": "com.amazonaws.devicefarm#ExecutionConfiguration",
"traits": {
"smithy.api#documentation": "<p>Specifies configuration information about a test run, such as the execution timeout\n (in minutes).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the schedule run operation.</p>"
}
},
"com.amazonaws.devicefarm#ScheduleRunResult": {
"type": "structure",
"members": {
"run": {
"target": "com.amazonaws.devicefarm#Run",
"traits": {
"smithy.api#documentation": "<p>Information about the scheduled run.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of a schedule run request.</p>"
}
},
"com.amazonaws.devicefarm#ScheduleRunTest": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.devicefarm#TestType",
"traits": {
"smithy.api#documentation": "<p>The test's type.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>BUILTIN_FUZZ</p>\n </li>\n <li>\n <p>BUILTIN_EXPLORER. For Android, an app explorer that traverses an\n Android app, interacting with it and capturing screenshots at the same\n time.</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_NODE</p>\n </li>\n <li>\n <p>APPIUM_RUBY</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY</p>\n </li>\n <li>\n <p>CALABASH</p>\n </li>\n <li>\n <p>INSTRUMENTATION</p>\n </li>\n <li>\n <p>UIAUTOMATION</p>\n </li>\n <li>\n <p>UIAUTOMATOR</p>\n </li>\n <li>\n <p>XCTEST</p>\n </li>\n <li>\n <p>XCTEST_UI</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"testPackageArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the uploaded test to be run.</p>"
}
},
"testSpecArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the YAML-formatted test specification.</p>"
}
},
"filter": {
"target": "com.amazonaws.devicefarm#Filter",
"traits": {
"smithy.api#documentation": "<p>The test's filter.</p>"
}
},
"parameters": {
"target": "com.amazonaws.devicefarm#TestParameters",
"traits": {
"smithy.api#documentation": "<p>The test's parameters, such as test framework parameters and fixture settings.\n Parameters are represented by name-value pairs of strings.</p>\n <p>For all tests:</p>\n <ul>\n <li>\n <p>\n <code>app_performance_monitoring</code>: Performance monitoring is enabled by default.\n Set this parameter to false to disable it.</p>\n </li>\n </ul>\n <p>For Calabash tests:</p>\n <ul>\n <li>\n <p>profile: A cucumber profile (for example, <code>my_profile_name</code>).</p>\n </li>\n <li>\n <p>tags: You can limit execution to features or scenarios that have (or don't\n have) certain tags (for example, @smoke or @smoke,~@wip).</p>\n </li>\n </ul>\n <p>For Appium tests (all types):</p>\n <ul>\n <li>\n <p>appium_version: The Appium version. Currently supported values are 1.6.5\n (and later), latest, and default.</p>\n <ul>\n <li>\n \n <p>latest runs the latest Appium version supported by Device\n Farm (1.9.1).</p>\n </li>\n <li>\n <p>For default, Device Farm selects a compatible version of\n Appium for the device. The current behavior is to run 1.7.2 on Android\n devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.</p>\n </li>\n <li>\n <p>This behavior is subject to change.</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>For fuzz tests (Android only):</p>\n <ul>\n <li>\n <p>event_count: The number of events, between 1 and 10000, that the UI fuzz\n test should perform.</p>\n </li>\n <li>\n <p>throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should\n wait between events.</p>\n </li>\n <li>\n <p>seed: A seed to use for randomizing the UI fuzz test. Using the same seed\n value between tests ensures identical event sequences.</p>\n </li>\n </ul>\n <p>For Explorer tests:</p>\n <ul>\n <li>\n <p>username: A user name to use if the Explorer encounters a login form. If not supplied, no user\n name is inserted.</p>\n </li>\n <li>\n <p>password: A password to use if the Explorer encounters a login form. If not supplied, no\n password is inserted.</p>\n </li>\n </ul>\n <p>For Instrumentation:</p>\n <ul>\n <li>\n <p>filter: A test filter string. Examples:</p>\n <ul>\n <li>\n <p>Running a single test case: <code>com.android.abc.Test1</code>\n </p>\n </li>\n <li>\n <p>Running a single test: <code>com.android.abc.Test1#smoke</code>\n </p>\n </li>\n <li>\n <p>Running multiple tests:\n <code>com.android.abc.Test1,com.android.abc.Test2</code>\n </p>\n </li>\n </ul>\n </li>\n </ul>\n <p>For XCTest and XCTestUI:</p>\n <ul>\n <li>\n <p>filter: A test filter string. Examples:</p>\n <ul>\n <li>\n <p>Running a single test class: <code>LoginTests</code>\n </p>\n </li>\n <li>\n
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an\n example of the JSON request syntax, see <a>ScheduleRun</a>.</p>"
}
},
"com.amazonaws.devicefarm#ServiceAccountException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>Any additional information about the exception.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>There was a problem with the service account.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.devicefarm#ServiceDnsName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 2048
}
}
},
"com.amazonaws.devicefarm#SkipAppResign": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.devicefarm#SshPublicKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 8192
}
}
},
"com.amazonaws.devicefarm#StopJob": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#StopJobRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#StopJobResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device\n where tests have not started. You are not billed for this device. On the device where tests have started,\n setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown,\n and any tests that were in progress or already completed.</p>"
}
},
"com.amazonaws.devicefarm#StopJobRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#StopJobResult": {
"type": "structure",
"members": {
"job": {
"target": "com.amazonaws.devicefarm#Job",
"traits": {
"smithy.api#documentation": "<p>The job that was stopped.</p>"
}
}
}
},
"com.amazonaws.devicefarm#StopRemoteAccessSession": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#StopRemoteAccessSessionRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#StopRemoteAccessSessionResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Ends a specified remote access session.</p>"
}
},
"com.amazonaws.devicefarm#StopRemoteAccessSessionRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the remote access session to stop.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to stop the remote access session.</p>"
}
},
"com.amazonaws.devicefarm#StopRemoteAccessSessionResult": {
"type": "structure",
"members": {
"remoteAccessSession": {
"target": "com.amazonaws.devicefarm#RemoteAccessSession",
"traits": {
"smithy.api#documentation": "<p>A container that represents the metadata from the service about the remote access session you are\n stopping.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the response from the server that describes the remote access session\n when AWS Device Farm stops the session.</p>"
}
},
"com.amazonaws.devicefarm#StopRun": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#StopRunRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#StopRunResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices\n where tests have not started. You are not billed for these devices. On devices where tests have started\n executing, setup suite and teardown suite tests run to completion on those devices. You are billed for\n setup, teardown, and any tests that were in progress or already completed.</p>"
}
},
"com.amazonaws.devicefarm#StopRunRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the request to stop a specific run.</p>"
}
},
"com.amazonaws.devicefarm#StopRunResult": {
"type": "structure",
"members": {
"run": {
"target": "com.amazonaws.devicefarm#Run",
"traits": {
"smithy.api#documentation": "<p>The run that was stopped.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the results of your stop run attempt.</p>"
}
},
"com.amazonaws.devicefarm#String": {
"type": "string"
},
"com.amazonaws.devicefarm#Suite": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The suite's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The suite's name.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#TestType",
"traits": {
"smithy.api#documentation": "<p>The suite's type.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>BUILTIN_FUZZ</p>\n </li>\n <li>\n <p>BUILTIN_EXPLORER </p>\n <note>\n <p>Only available for Android; an app explorer that traverses an Android app, interacting with it\n and capturing screenshots at the same time.</p>\n </note>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_NODE</p>\n </li>\n <li>\n <p>APPIUM_RUBY</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY</p>\n </li>\n <li>\n <p>CALABASH</p>\n </li>\n <li>\n <p>INSTRUMENTATION</p>\n </li>\n <li>\n <p>UIAUTOMATION</p>\n </li>\n <li>\n <p>UIAUTOMATOR</p>\n </li>\n <li>\n <p>XCTEST</p>\n </li>\n <li>\n <p>XCTEST_UI</p>\n </li>\n </ul>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>When the suite was created.</p>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#ExecutionStatus",
"traits": {
"smithy.api#documentation": "<p>The suite's status.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PENDING_CONCURRENCY</p>\n </li>\n <li>\n <p>PENDING_DEVICE</p>\n </li>\n <li>\n <p>PROCESSING</p>\n </li>\n <li>\n <p>SCHEDULING</p>\n </li>\n <li>\n <p>PREPARING</p>\n </li>\n <li>\n <p>RUNNING</p>\n </li>\n <li>\n <p>COMPLETED</p>\n </li>\n <li>\n <p>STOPPING</p>\n </li>\n </ul>"
}
},
"result": {
"target": "com.amazonaws.devicefarm#ExecutionResult",
"traits": {
"smithy.api#documentation": "<p>The suite's result.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PASSED</p>\n </li>\n <li>\n <p>WARNED</p>\n </li>\n <li>\n <p>FAILED</p>\n </li>\n <li>\n <p>SKIPPED</p>\n </li>\n <li>\n <p>ERRORED</p>\n </li>\n <li>\n <p>STOPPED</p>\n </li>\n </ul>"
}
},
"started": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The suite's start time.</p>"
}
},
"stopped": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The suite's stop time.</p>"
}
},
"counters": {
"target": "com.amazonaws.devicefarm#Counters",
"traits": {
"smithy.api#documentation": "<p>The suite's result counters.</p>"
}
},
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the suite's result.</p>"
}
},
"deviceMinutes": {
"target": "com.amazonaws.devicefarm#DeviceMinutes",
"traits": {
"smithy.api#documentation": "<p>Represents the total (metered or unmetered) minutes used by the test\n suite.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a collection of one or more tests.</p>"
}
},
"com.amazonaws.devicefarm#Suites": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Suite"
}
},
"com.amazonaws.devicefarm#Tag": {
"type": "structure",
"members": {
"Key": {
"target": "com.amazonaws.devicefarm#TagKey",
"traits": {
"smithy.api#documentation": "<p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label that acts like a\n category for more specific tag values.</p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.devicefarm#TagValue",
"traits": {
"smithy.api#documentation": "<p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a descriptor in a\n tag category (key).</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a\n key and an optional value, both of which you define. Tag keys can have a maximum character length of 128\n characters. Tag values can have a maximum length of 256 characters. </p>"
}
},
"com.amazonaws.devicefarm#TagKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 128
}
}
},
"com.amazonaws.devicefarm#TagKeyList": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#TagKey"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 150
}
}
},
"com.amazonaws.devicefarm#TagList": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Tag"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 150
}
}
},
"com.amazonaws.devicefarm#TagOperationException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#ExceptionMessage"
},
"resourceName": {
"target": "com.amazonaws.devicefarm#AmazonResourceName"
}
},
"traits": {
"smithy.api#documentation": "<p>The operation was not successful. Try again.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.devicefarm#TagPolicyException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#ExceptionMessage"
},
"resourceName": {
"target": "com.amazonaws.devicefarm#AmazonResourceName"
}
},
"traits": {
"smithy.api#documentation": "<p>The request doesn't comply with the AWS Identity and Access Management (IAM) tag\n policy. Correct your request and then retry it.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.devicefarm#TagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#TagResourceRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#TagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#TagOperationException"
},
{
"target": "com.amazonaws.devicefarm#TagPolicyException"
},
{
"target": "com.amazonaws.devicefarm#TooManyTagsException"
}
],
"traits": {
"smithy.api#documentation": "<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags\n on a resource are not specified in the request parameters, they are not changed. When a resource is deleted,\n the tags associated with that resource are also deleted.</p>"
}
},
"com.amazonaws.devicefarm#TagResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags\n with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>,\n <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>,\n <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and\n <code>VPCE_CONFIGURATION</code>.</p>",
"smithy.api#required": {}
}
},
"Tags": {
"target": "com.amazonaws.devicefarm#TagList",
"traits": {
"smithy.api#documentation": "<p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum\n character length of 128 characters. Tag values can have a maximum length of 256 characters.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#TagResourceResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.devicefarm#TagValue": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 256
}
}
},
"com.amazonaws.devicefarm#Test": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The test's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The test's name.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#TestType",
"traits": {
"smithy.api#documentation": "<p>The test's type.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>BUILTIN_FUZZ</p>\n </li>\n <li>\n <p>BUILTIN_EXPLORER</p>\n <note>\n <p>For Android, an app explorer that traverses an Android app, interacting with it and capturing\n screenshots at the same time.</p>\n </note>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_NODE</p>\n </li>\n <li>\n <p>APPIUM_RUBY</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY</p>\n </li>\n <li>\n <p>CALABASH</p>\n </li>\n <li>\n <p>INSTRUMENTATION</p>\n </li>\n <li>\n <p>UIAUTOMATION</p>\n </li>\n <li>\n <p>UIAUTOMATOR</p>\n </li>\n <li>\n <p>XCTEST</p>\n </li>\n <li>\n <p>XCTEST_UI</p>\n </li>\n </ul>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>When the test was created.</p>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#ExecutionStatus",
"traits": {
"smithy.api#documentation": "<p>The test's status.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PENDING_CONCURRENCY</p>\n </li>\n <li>\n <p>PENDING_DEVICE</p>\n </li>\n <li>\n <p>PROCESSING</p>\n </li>\n <li>\n <p>SCHEDULING</p>\n </li>\n <li>\n <p>PREPARING</p>\n </li>\n <li>\n <p>RUNNING</p>\n </li>\n <li>\n <p>COMPLETED</p>\n </li>\n <li>\n <p>STOPPING</p>\n </li>\n </ul>"
}
},
"result": {
"target": "com.amazonaws.devicefarm#ExecutionResult",
"traits": {
"smithy.api#documentation": "<p>The test's result.</p>\n <p>Allowed values include:</p>\n <ul>\n <li>\n <p>PENDING</p>\n </li>\n <li>\n <p>PASSED</p>\n </li>\n <li>\n <p>WARNED</p>\n </li>\n <li>\n <p>FAILED</p>\n </li>\n <li>\n <p>SKIPPED</p>\n </li>\n <li>\n <p>ERRORED</p>\n </li>\n <li>\n <p>STOPPED</p>\n </li>\n </ul>"
}
},
"started": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The test's start time.</p>"
}
},
"stopped": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The test's stop time.</p>"
}
},
"counters": {
"target": "com.amazonaws.devicefarm#Counters",
"traits": {
"smithy.api#documentation": "<p>The test's result counters.</p>"
}
},
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the test's result.</p>"
}
},
"deviceMinutes": {
"target": "com.amazonaws.devicefarm#DeviceMinutes",
"traits": {
"smithy.api#documentation": "<p>Represents the total (metered or unmetered) minutes used by the test.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a condition that is evaluated.</p>"
}
},
"com.amazonaws.devicefarm#TestGridProject": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The ARN for the project.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>A human-readable name for the project.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>A human-readable description for the project.</p>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>When the project was created.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A Selenium testing project. Projects are used to collect and collate sessions.</p>"
}
},
"com.amazonaws.devicefarm#TestGridProjects": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#TestGridProject"
}
},
"com.amazonaws.devicefarm#TestGridSession": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the session.</p>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#TestGridSessionStatus",
"traits": {
"smithy.api#documentation": "<p>The state of the session.</p>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The time that the session was started.</p>"
}
},
"ended": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The time the session ended.</p>"
}
},
"billingMinutes": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>The number of billed minutes that were used for this session. </p>"
}
},
"seleniumProperties": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>A JSON object of options and parameters passed to the Selenium WebDriver.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A <a>TestGridSession</a> is a single instance of a browser launched from the URL provided by a\n call to <a>CreateTestGridUrl</a>.</p>"
}
},
"com.amazonaws.devicefarm#TestGridSessionAction": {
"type": "structure",
"members": {
"action": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The action taken by the session.</p>"
}
},
"started": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>The time that the session invoked the action.</p>"
}
},
"duration": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The time, in milliseconds, that the action took to complete in the browser.</p>"
}
},
"statusCode": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>HTTP status code returned to the browser when the action was taken.</p>"
}
},
"requestMethod": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>HTTP method that the browser used to make the request.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An action taken by a <a>TestGridSession</a> browser instance.</p>"
}
},
"com.amazonaws.devicefarm#TestGridSessionActions": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#TestGridSessionAction"
}
},
"com.amazonaws.devicefarm#TestGridSessionArtifact": {
"type": "structure",
"members": {
"filename": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>The file name of the artifact.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#TestGridSessionArtifactType",
"traits": {
"smithy.api#documentation": "<p>The kind of artifact.</p>"
}
},
"url": {
"target": "com.amazonaws.devicefarm#String",
"traits": {
"smithy.api#documentation": "<p>A semi-stable URL to the content of the object.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Artifacts are video and other files that are produced in the process of running a browser in an automated\n context. </p>\n <note>\n <p>Video elements might be broken up into multiple artifacts as they grow in size during creation. </p>\n </note>"
}
},
"com.amazonaws.devicefarm#TestGridSessionArtifactCategory": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "VIDEO",
"name": "VIDEO"
},
{
"value": "LOG",
"name": "LOG"
}
]
}
},
"com.amazonaws.devicefarm#TestGridSessionArtifactType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "UNKNOWN",
"name": "UNKNOWN"
},
{
"value": "VIDEO",
"name": "VIDEO"
},
{
"value": "SELENIUM_LOG",
"name": "SELENIUM_LOG"
}
]
}
},
"com.amazonaws.devicefarm#TestGridSessionArtifacts": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#TestGridSessionArtifact"
}
},
"com.amazonaws.devicefarm#TestGridSessionStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "CLOSED",
"name": "CLOSED"
},
{
"value": "ERRORED",
"name": "ERRORED"
}
]
}
},
"com.amazonaws.devicefarm#TestGridSessions": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#TestGridSession"
}
},
"com.amazonaws.devicefarm#TestGridUrlExpiresInSecondsInput": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 60,
"max": 86400
}
}
},
"com.amazonaws.devicefarm#TestParameters": {
"type": "map",
"key": {
"target": "com.amazonaws.devicefarm#String"
},
"value": {
"target": "com.amazonaws.devicefarm#String"
}
},
"com.amazonaws.devicefarm#TestType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "BUILTIN_FUZZ",
"name": "BUILTIN_FUZZ"
},
{
"value": "BUILTIN_EXPLORER",
"name": "BUILTIN_EXPLORER"
},
{
"value": "WEB_PERFORMANCE_PROFILE",
"name": "WEB_PERFORMANCE_PROFILE"
},
{
"value": "APPIUM_JAVA_JUNIT",
"name": "APPIUM_JAVA_JUNIT"
},
{
"value": "APPIUM_JAVA_TESTNG",
"name": "APPIUM_JAVA_TESTNG"
},
{
"value": "APPIUM_PYTHON",
"name": "APPIUM_PYTHON"
},
{
"value": "APPIUM_NODE",
"name": "APPIUM_NODE"
},
{
"value": "APPIUM_RUBY",
"name": "APPIUM_RUBY"
},
{
"value": "APPIUM_WEB_JAVA_JUNIT",
"name": "APPIUM_WEB_JAVA_JUNIT"
},
{
"value": "APPIUM_WEB_JAVA_TESTNG",
"name": "APPIUM_WEB_JAVA_TESTNG"
},
{
"value": "APPIUM_WEB_PYTHON",
"name": "APPIUM_WEB_PYTHON"
},
{
"value": "APPIUM_WEB_NODE",
"name": "APPIUM_WEB_NODE"
},
{
"value": "APPIUM_WEB_RUBY",
"name": "APPIUM_WEB_RUBY"
},
{
"value": "CALABASH",
"name": "CALABASH"
},
{
"value": "INSTRUMENTATION",
"name": "INSTRUMENTATION"
},
{
"value": "UIAUTOMATION",
"name": "UIAUTOMATION"
},
{
"value": "UIAUTOMATOR",
"name": "UIAUTOMATOR"
},
{
"value": "XCTEST",
"name": "XCTEST"
},
{
"value": "XCTEST_UI",
"name": "XCTEST_UI"
},
{
"value": "REMOTE_ACCESS_RECORD",
"name": "REMOTE_ACCESS_RECORD"
},
{
"value": "REMOTE_ACCESS_REPLAY",
"name": "REMOTE_ACCESS_REPLAY"
}
]
}
},
"com.amazonaws.devicefarm#Tests": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Test"
}
},
"com.amazonaws.devicefarm#TooManyTagsException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#ExceptionMessage"
},
"resourceName": {
"target": "com.amazonaws.devicefarm#AmazonResourceName"
}
},
"traits": {
"smithy.api#documentation": "<p>The list of tags on the repository is over the limit. The maximum number of tags that\n can be applied to a repository is 50. </p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.devicefarm#TransactionIdentifier": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 32
}
}
},
"com.amazonaws.devicefarm#TrialMinutes": {
"type": "structure",
"members": {
"total": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>The total number of free trial minutes that the account started with.</p>"
}
},
"remaining": {
"target": "com.amazonaws.devicefarm#Double",
"traits": {
"smithy.api#documentation": "<p>The number of free trial minutes remaining in the account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents information about free trial device minutes for an AWS\n account.</p>"
}
},
"com.amazonaws.devicefarm#URL": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 2048
}
}
},
"com.amazonaws.devicefarm#UniqueProblem": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the unique problems' result.</p>"
}
},
"problems": {
"target": "com.amazonaws.devicefarm#Problems",
"traits": {
"smithy.api#documentation": "<p>Information about the problems.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A collection of one or more problems, grouped by their result.</p>"
}
},
"com.amazonaws.devicefarm#UniqueProblems": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#UniqueProblem"
}
},
"com.amazonaws.devicefarm#UniqueProblemsByExecutionResultMap": {
"type": "map",
"key": {
"target": "com.amazonaws.devicefarm#ExecutionResult"
},
"value": {
"target": "com.amazonaws.devicefarm#UniqueProblems"
}
},
"com.amazonaws.devicefarm#UntagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UntagResourceRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UntagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#TagOperationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified tags from a resource.</p>"
}
},
"com.amazonaws.devicefarm#UntagResourceRequest": {
"type": "structure",
"members": {
"ResourceARN": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate\n tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>,\n <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>,\n <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and\n <code>VPCE_CONFIGURATION</code>.</p>",
"smithy.api#required": {}
}
},
"TagKeys": {
"target": "com.amazonaws.devicefarm#TagKeyList",
"traits": {
"smithy.api#documentation": "<p>The keys of the tags to be removed.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.devicefarm#UntagResourceResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.devicefarm#UpdateDeviceInstance": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateDeviceInstanceRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateDeviceInstanceResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates information about a private device instance.</p>"
}
},
"com.amazonaws.devicefarm#UpdateDeviceInstanceRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the device instance.</p>",
"smithy.api#required": {}
}
},
"profileArn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the profile that you want to associate with the device instance.</p>"
}
},
"labels": {
"target": "com.amazonaws.devicefarm#InstanceLabels",
"traits": {
"smithy.api#documentation": "<p>An array of strings that you want to associate with the device instance.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateDeviceInstanceResult": {
"type": "structure",
"members": {
"deviceInstance": {
"target": "com.amazonaws.devicefarm#DeviceInstance",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your device instance.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateDevicePool": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateDevicePoolRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateDevicePoolResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Modifies the name, description, and rules in a device pool given the attributes and\n the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a\n whole (or not at all).</p>"
}
},
"com.amazonaws.devicefarm#UpdateDevicePoolRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Device Farm device pool to update.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>A string that represents the name of the device pool to update.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A description of the device pool to update.</p>"
}
},
"rules": {
"target": "com.amazonaws.devicefarm#Rules",
"traits": {
"smithy.api#documentation": "<p>Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for\n your request, the update replaces the existing rules.</p>"
}
},
"maxDevices": {
"target": "com.amazonaws.devicefarm#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of devices that Device Farm can add to your device pool. Device Farm adds\n devices that are available and that meet the criteria that you assign for the\n <code>rules</code> parameter. Depending on how many devices meet these constraints,\n your device pool might contain fewer devices than the value for this parameter.</p>\n <p>By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.</p>\n <p>If you use this parameter in your request, you cannot use the\n <code>clearMaxDevices</code> parameter in the same request.</p>"
}
},
"clearMaxDevices": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>Sets whether the <code>maxDevices</code> parameter applies to your device pool. If you set this parameter\n to <code>true</code>, the <code>maxDevices</code> parameter does not apply, and Device Farm does not limit\n the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices\n that meet the criteria specified in the <code>rules</code> parameter.</p>\n <p>If you use this parameter in your request, you cannot use the <code>maxDevices</code>\n parameter in the same request.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the update device pool operation.</p>"
}
},
"com.amazonaws.devicefarm#UpdateDevicePoolResult": {
"type": "structure",
"members": {
"devicePool": {
"target": "com.amazonaws.devicefarm#DevicePool",
"traits": {
"smithy.api#documentation": "<p>The device pool you just updated.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of an update device pool request.</p>"
}
},
"com.amazonaws.devicefarm#UpdateInstanceProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateInstanceProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateInstanceProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates information about an existing private device instance profile.</p>"
}
},
"com.amazonaws.devicefarm#UpdateInstanceProfileRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the instance profile.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The updated name for your instance profile.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The updated description for your instance profile.</p>"
}
},
"packageCleanup": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>The updated choice for whether you want to specify package cleanup. The default value\n is <code>false</code> for private devices.</p>"
}
},
"excludeAppPackagesFromCleanup": {
"target": "com.amazonaws.devicefarm#PackageIds",
"traits": {
"smithy.api#documentation": "<p>An array of strings that specifies the list of app packages that should not be cleaned up from the device\n after a test run is over.</p>\n <p>The list of packages is only considered if you set <code>packageCleanup</code> to\n <code>true</code>.</p>"
}
},
"rebootAfterUse": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>The updated choice for whether you want to reboot the device after use. The default\n value is <code>true</code>.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateInstanceProfileResult": {
"type": "structure",
"members": {
"instanceProfile": {
"target": "com.amazonaws.devicefarm#InstanceProfile",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your instance profile.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateNetworkProfile": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateNetworkProfileRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateNetworkProfileResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates the network profile.</p>"
}
},
"com.amazonaws.devicefarm#UpdateNetworkProfileRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project for which you want to update network\n profile settings.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the network profile about which you are returning\n information.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>The description of the network profile about which you are returning\n information.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#NetworkProfileType",
"traits": {
"smithy.api#documentation": "<p>The type of network profile to return information about. Valid values are listed here.</p>"
}
},
"uplinkBandwidthBits": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The data throughput rate in bits per second, as an integer from 0 to\n 104857600.</p>"
}
},
"downlinkBandwidthBits": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>The data throughput rate in bits per second, as an integer from 0 to\n 104857600.</p>"
}
},
"uplinkDelayMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.</p>"
}
},
"downlinkDelayMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.</p>"
}
},
"uplinkJitterMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.</p>"
}
},
"downlinkJitterMs": {
"target": "com.amazonaws.devicefarm#Long",
"traits": {
"smithy.api#documentation": "<p>Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.</p>"
}
},
"uplinkLossPercent": {
"target": "com.amazonaws.devicefarm#PercentInteger",
"traits": {
"smithy.api#documentation": "<p>Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.</p>"
}
},
"downlinkLossPercent": {
"target": "com.amazonaws.devicefarm#PercentInteger",
"traits": {
"smithy.api#documentation": "<p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateNetworkProfileResult": {
"type": "structure",
"members": {
"networkProfile": {
"target": "com.amazonaws.devicefarm#NetworkProfile",
"traits": {
"smithy.api#documentation": "<p>A list of the available network profiles.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Modifies the specified project name, given the project ARN and a new\n name.</p>"
}
},
"com.amazonaws.devicefarm#UpdateProjectRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the project whose name to update.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>A string that represents the new name of the project that you are updating.</p>"
}
},
"defaultJobTimeoutMinutes": {
"target": "com.amazonaws.devicefarm#JobTimeoutMinutes",
"traits": {
"smithy.api#documentation": "<p>The number of minutes a test run in the project executes before it times out.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a request to the update project operation.</p>"
}
},
"com.amazonaws.devicefarm#UpdateProjectResult": {
"type": "structure",
"members": {
"project": {
"target": "com.amazonaws.devicefarm#Project",
"traits": {
"smithy.api#documentation": "<p>The project to update.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the result of an update project request.</p>"
}
},
"com.amazonaws.devicefarm#UpdateTestGridProject": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateTestGridProjectRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateTestGridProjectResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InternalServiceException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Change details of a project.</p>"
}
},
"com.amazonaws.devicefarm#UpdateTestGridProjectRequest": {
"type": "structure",
"members": {
"projectArn": {
"target": "com.amazonaws.devicefarm#DeviceFarmArn",
"traits": {
"smithy.api#documentation": "<p>ARN of the project to update.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#ResourceName",
"traits": {
"smithy.api#documentation": "<p>Human-readable name for the project.</p>"
}
},
"description": {
"target": "com.amazonaws.devicefarm#ResourceDescription",
"traits": {
"smithy.api#documentation": "<p>Human-readable description for the project.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateTestGridProjectResult": {
"type": "structure",
"members": {
"testGridProject": {
"target": "com.amazonaws.devicefarm#TestGridProject",
"traits": {
"smithy.api#documentation": "<p>The project, including updated information.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateUpload": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateUploadRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateUploadResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#LimitExceededException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates an uploaded test spec.</p>"
}
},
"com.amazonaws.devicefarm#UpdateUploadRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the uploaded test spec.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file\n name must end with the <code>.yaml</code> or <code>.yml</code> file extension.</p>"
}
},
"contentType": {
"target": "com.amazonaws.devicefarm#ContentType",
"traits": {
"smithy.api#documentation": "<p>The upload's content type (for example, <code>application/x-yaml</code>).</p>"
}
},
"editContent": {
"target": "com.amazonaws.devicefarm#Boolean",
"traits": {
"smithy.api#documentation": "<p>Set to true if the YAML file has changed and must be updated. Otherwise, set to false.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateUploadResult": {
"type": "structure",
"members": {
"upload": {
"target": "com.amazonaws.devicefarm#Upload",
"traits": {
"smithy.api#documentation": "<p>A test spec uploaded to Device Farm.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateVPCEConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.devicefarm#UpdateVPCEConfigurationRequest"
},
"output": {
"target": "com.amazonaws.devicefarm#UpdateVPCEConfigurationResult"
},
"errors": [
{
"target": "com.amazonaws.devicefarm#ArgumentException"
},
{
"target": "com.amazonaws.devicefarm#InvalidOperationException"
},
{
"target": "com.amazonaws.devicefarm#NotFoundException"
},
{
"target": "com.amazonaws.devicefarm#ServiceAccountException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.</p>"
}
},
"com.amazonaws.devicefarm#UpdateVPCEConfigurationRequest": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to\n update.</p>",
"smithy.api#required": {}
}
},
"vpceConfigurationName": {
"target": "com.amazonaws.devicefarm#VPCEConfigurationName",
"traits": {
"smithy.api#documentation": "<p>The friendly name you give to your VPC endpoint configuration to manage your configurations more\n easily.</p>"
}
},
"vpceServiceName": {
"target": "com.amazonaws.devicefarm#VPCEServiceName",
"traits": {
"smithy.api#documentation": "<p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>"
}
},
"serviceDnsName": {
"target": "com.amazonaws.devicefarm#ServiceDnsName",
"traits": {
"smithy.api#documentation": "<p>The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already\n be in use on the internet.</p>"
}
},
"vpceConfigurationDescription": {
"target": "com.amazonaws.devicefarm#VPCEConfigurationDescription",
"traits": {
"smithy.api#documentation": "<p>An optional description that provides details about your VPC endpoint configuration.</p>"
}
}
}
},
"com.amazonaws.devicefarm#UpdateVPCEConfigurationResult": {
"type": "structure",
"members": {
"vpceConfiguration": {
"target": "com.amazonaws.devicefarm#VPCEConfiguration",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about your VPC endpoint configuration.</p>"
}
}
}
},
"com.amazonaws.devicefarm#Upload": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The upload's ARN.</p>"
}
},
"name": {
"target": "com.amazonaws.devicefarm#Name",
"traits": {
"smithy.api#documentation": "<p>The upload's file name.</p>"
}
},
"created": {
"target": "com.amazonaws.devicefarm#DateTime",
"traits": {
"smithy.api#documentation": "<p>When the upload was created.</p>"
}
},
"type": {
"target": "com.amazonaws.devicefarm#UploadType",
"traits": {
"smithy.api#documentation": "<p>The upload's type.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>ANDROID_APP</p>\n </li>\n <li>\n <p>IOS_APP</p>\n </li>\n <li>\n <p>WEB_APP</p>\n </li>\n <li>\n <p>EXTERNAL_DATA</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_NODE_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_RUBY_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY_TEST_PACKAGE</p>\n </li>\n <li>\n <p>CALABASH_TEST_PACKAGE</p>\n </li>\n <li>\n <p>INSTRUMENTATION_TEST_PACKAGE</p>\n </li>\n <li>\n <p>UIAUTOMATION_TEST_PACKAGE</p>\n </li>\n <li>\n <p>UIAUTOMATOR_TEST_PACKAGE</p>\n </li>\n <li>\n <p>XCTEST_TEST_PACKAGE</p>\n </li>\n <li>\n <p>XCTEST_UI_TEST_PACKAGE</p>\n </li>\n <li>\n <p>APPIUM_JAVA_JUNIT_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_JAVA_TESTNG_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_PYTHON_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_NODE_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_RUBY_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_PYTHON_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_NODE_TEST_SPEC</p>\n </li>\n <li>\n <p>APPIUM_WEB_RUBY_TEST_SPEC</p>\n </li>\n <li>\n <p>INSTRUMENTATION_TEST_SPEC</p>\n </li>\n <li>\n <p>XCTEST_UI_TEST_SPEC</p>\n </li>\n </ul>"
}
},
"status": {
"target": "com.amazonaws.devicefarm#UploadStatus",
"traits": {
"smithy.api#documentation": "<p>The upload's status.</p>\n <p>Must be one of the following values:</p>\n <ul>\n <li>\n <p>FAILED</p>\n </li>\n <li>\n <p>INITIALIZED</p>\n </li>\n <li>\n <p>PROCESSING</p>\n </li>\n <li>\n <p>SUCCEEDED</p>\n </li>\n </ul>"
}
},
"url": {
"target": "com.amazonaws.devicefarm#URL",
"traits": {
"smithy.api#documentation": "<p>The presigned Amazon S3 URL that was used to store a file using a PUT request.</p>"
}
},
"metadata": {
"target": "com.amazonaws.devicefarm#Metadata",
"traits": {
"smithy.api#documentation": "<p>The upload's metadata. For example, for Android, this contains information that is\n parsed from the manifest and is displayed in the AWS Device Farm console after the\n associated app is uploaded.</p>"
}
},
"contentType": {
"target": "com.amazonaws.devicefarm#ContentType",
"traits": {
"smithy.api#documentation": "<p>The upload's content type (for example, <code>application/octet-stream</code>).</p>"
}
},
"message": {
"target": "com.amazonaws.devicefarm#Message",
"traits": {
"smithy.api#documentation": "<p>A message about the upload's result.</p>"
}
},
"category": {
"target": "com.amazonaws.devicefarm#UploadCategory",
"traits": {
"smithy.api#documentation": "<p>The upload's category. Allowed values include:</p>\n <ul>\n <li>\n <p>CURATED: An upload managed by AWS Device Farm.</p>\n </li>\n <li>\n <p>PRIVATE: An upload managed by the AWS Device Farm customer.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An app or a set of one or more tests to upload or that have been\n uploaded.</p>"
}
},
"com.amazonaws.devicefarm#UploadCategory": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CURATED",
"name": "CURATED"
},
{
"value": "PRIVATE",
"name": "PRIVATE"
}
]
}
},
"com.amazonaws.devicefarm#UploadStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "INITIALIZED",
"name": "INITIALIZED"
},
{
"value": "PROCESSING",
"name": "PROCESSING"
},
{
"value": "SUCCEEDED",
"name": "SUCCEEDED"
},
{
"value": "FAILED",
"name": "FAILED"
}
]
}
},
"com.amazonaws.devicefarm#UploadType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ANDROID_APP",
"name": "ANDROID_APP"
},
{
"value": "IOS_APP",
"name": "IOS_APP"
},
{
"value": "WEB_APP",
"name": "WEB_APP"
},
{
"value": "EXTERNAL_DATA",
"name": "EXTERNAL_DATA"
},
{
"value": "APPIUM_JAVA_JUNIT_TEST_PACKAGE",
"name": "APPIUM_JAVA_JUNIT_TEST_PACKAGE"
},
{
"value": "APPIUM_JAVA_TESTNG_TEST_PACKAGE",
"name": "APPIUM_JAVA_TESTNG_TEST_PACKAGE"
},
{
"value": "APPIUM_PYTHON_TEST_PACKAGE",
"name": "APPIUM_PYTHON_TEST_PACKAGE"
},
{
"value": "APPIUM_NODE_TEST_PACKAGE",
"name": "APPIUM_NODE_TEST_PACKAGE"
},
{
"value": "APPIUM_RUBY_TEST_PACKAGE",
"name": "APPIUM_RUBY_TEST_PACKAGE"
},
{
"value": "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE",
"name": "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE"
},
{
"value": "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE",
"name": "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE"
},
{
"value": "APPIUM_WEB_PYTHON_TEST_PACKAGE",
"name": "APPIUM_WEB_PYTHON_TEST_PACKAGE"
},
{
"value": "APPIUM_WEB_NODE_TEST_PACKAGE",
"name": "APPIUM_WEB_NODE_TEST_PACKAGE"
},
{
"value": "APPIUM_WEB_RUBY_TEST_PACKAGE",
"name": "APPIUM_WEB_RUBY_TEST_PACKAGE"
},
{
"value": "CALABASH_TEST_PACKAGE",
"name": "CALABASH_TEST_PACKAGE"
},
{
"value": "INSTRUMENTATION_TEST_PACKAGE",
"name": "INSTRUMENTATION_TEST_PACKAGE"
},
{
"value": "UIAUTOMATION_TEST_PACKAGE",
"name": "UIAUTOMATION_TEST_PACKAGE"
},
{
"value": "UIAUTOMATOR_TEST_PACKAGE",
"name": "UIAUTOMATOR_TEST_PACKAGE"
},
{
"value": "XCTEST_TEST_PACKAGE",
"name": "XCTEST_TEST_PACKAGE"
},
{
"value": "XCTEST_UI_TEST_PACKAGE",
"name": "XCTEST_UI_TEST_PACKAGE"
},
{
"value": "APPIUM_JAVA_JUNIT_TEST_SPEC",
"name": "APPIUM_JAVA_JUNIT_TEST_SPEC"
},
{
"value": "APPIUM_JAVA_TESTNG_TEST_SPEC",
"name": "APPIUM_JAVA_TESTNG_TEST_SPEC"
},
{
"value": "APPIUM_PYTHON_TEST_SPEC",
"name": "APPIUM_PYTHON_TEST_SPEC"
},
{
"value": "APPIUM_NODE_TEST_SPEC",
"name": "APPIUM_NODE_TEST_SPEC"
},
{
"value": "APPIUM_RUBY_TEST_SPEC",
"name": "APPIUM_RUBY_TEST_SPEC"
},
{
"value": "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC",
"name": "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC"
},
{
"value": "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC",
"name": "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC"
},
{
"value": "APPIUM_WEB_PYTHON_TEST_SPEC",
"name": "APPIUM_WEB_PYTHON_TEST_SPEC"
},
{
"value": "APPIUM_WEB_NODE_TEST_SPEC",
"name": "APPIUM_WEB_NODE_TEST_SPEC"
},
{
"value": "APPIUM_WEB_RUBY_TEST_SPEC",
"name": "APPIUM_WEB_RUBY_TEST_SPEC"
},
{
"value": "INSTRUMENTATION_TEST_SPEC",
"name": "INSTRUMENTATION_TEST_SPEC"
},
{
"value": "XCTEST_UI_TEST_SPEC",
"name": "XCTEST_UI_TEST_SPEC"
}
]
}
},
"com.amazonaws.devicefarm#Uploads": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#Upload"
}
},
"com.amazonaws.devicefarm#VPCEConfiguration": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.devicefarm#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration.</p>"
}
},
"vpceConfigurationName": {
"target": "com.amazonaws.devicefarm#VPCEConfigurationName",
"traits": {
"smithy.api#documentation": "<p>The friendly name you give to your VPC endpoint configuration to manage your configurations more\n easily.</p>"
}
},
"vpceServiceName": {
"target": "com.amazonaws.devicefarm#VPCEServiceName",
"traits": {
"smithy.api#documentation": "<p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>"
}
},
"serviceDnsName": {
"target": "com.amazonaws.devicefarm#ServiceDnsName",
"traits": {
"smithy.api#documentation": "<p>The DNS name that maps to the private IP address of the service you want to\n access.</p>"
}
},
"vpceConfigurationDescription": {
"target": "com.amazonaws.devicefarm#VPCEConfigurationDescription",
"traits": {
"smithy.api#documentation": "<p>An optional description that provides details about your VPC endpoint configuration.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.</p>"
}
},
"com.amazonaws.devicefarm#VPCEConfigurationDescription": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 2048
}
}
},
"com.amazonaws.devicefarm#VPCEConfigurationName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 1024
}
}
},
"com.amazonaws.devicefarm#VPCEConfigurations": {
"type": "list",
"member": {
"target": "com.amazonaws.devicefarm#VPCEConfiguration"
}
},
"com.amazonaws.devicefarm#VPCEServiceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 2048
}
}
},
"com.amazonaws.devicefarm#VideoCapture": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
}
}
}