{ "version": "2.0", "metadata": { "apiVersion": "2015-06-23", "endpointPrefix": "devicefarm", "jsonVersion": "1.1", "protocol": "json", "protocols": [ "json" ], "serviceFullName": "AWS Device Farm", "serviceId": "Device Farm", "signatureVersion": "v4", "targetPrefix": "DeviceFarm_20150623", "uid": "devicefarm-2015-06-23", "auth": [ "aws.auth#sigv4" ] }, "operations": { "CreateDevicePool": { "name": "CreateDevicePool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateDevicePoolRequest" }, "output": { "shape": "CreateDevicePoolResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Creates a device pool.

" }, "CreateInstanceProfile": { "name": "CreateInstanceProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateInstanceProfileRequest" }, "output": { "shape": "CreateInstanceProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "CreateNetworkProfile": { "name": "CreateNetworkProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNetworkProfileRequest" }, "output": { "shape": "CreateNetworkProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Creates a network profile.

" }, "CreateProject": { "name": "CreateProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateProjectRequest" }, "output": { "shape": "CreateProjectResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" }, { "shape": "TagOperationException" } ], "documentation": "

Creates a project.

" }, "CreateRemoteAccessSession": { "name": "CreateRemoteAccessSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateRemoteAccessSessionRequest" }, "output": { "shape": "CreateRemoteAccessSessionResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Specifies and starts a remote access session.

" }, "CreateTestGridProject": { "name": "CreateTestGridProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTestGridProjectRequest" }, "output": { "shape": "CreateTestGridProjectResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "LimitExceededException" }, { "shape": "InternalServiceException" } ], "documentation": "

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

" }, "CreateTestGridUrl": { "name": "CreateTestGridUrl", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTestGridUrlRequest" }, "output": { "shape": "CreateTestGridUrlResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "InternalServiceException" } ], "documentation": "

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.

" }, "CreateUpload": { "name": "CreateUpload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateUploadRequest" }, "output": { "shape": "CreateUploadResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Uploads an app or test scripts.

" }, "CreateVPCEConfiguration": { "name": "CreateVPCEConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVPCEConfigurationRequest" }, "output": { "shape": "CreateVPCEConfigurationResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "DeleteDevicePool": { "name": "DeleteDevicePool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteDevicePoolRequest" }, "output": { "shape": "DeleteDevicePoolResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "DeleteInstanceProfile": { "name": "DeleteInstanceProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteInstanceProfileRequest" }, "output": { "shape": "DeleteInstanceProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "DeleteNetworkProfile": { "name": "DeleteNetworkProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkProfileRequest" }, "output": { "shape": "DeleteNetworkProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Deletes a network profile.

" }, "DeleteProject": { "name": "DeleteProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteProjectRequest" }, "output": { "shape": "DeleteProjectResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Deletes an AWS Device Farm project, given the project ARN.

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

" }, "DeleteRemoteAccessSession": { "name": "DeleteRemoteAccessSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteRemoteAccessSessionRequest" }, "output": { "shape": "DeleteRemoteAccessSessionResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Deletes a completed remote access session and its results.

" }, "DeleteRun": { "name": "DeleteRun", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteRunRequest" }, "output": { "shape": "DeleteRunResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Deletes the run, given the run ARN.

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

" }, "DeleteTestGridProject": { "name": "DeleteTestGridProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTestGridProjectRequest" }, "output": { "shape": "DeleteTestGridProjectResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "CannotDeleteException" }, { "shape": "InternalServiceException" } ], "documentation": "

Deletes a Selenium testing project and all content generated under it.

You cannot undo this operation.

You cannot delete a project if it has active sessions.

" }, "DeleteUpload": { "name": "DeleteUpload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteUploadRequest" }, "output": { "shape": "DeleteUploadResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Deletes an upload given the upload ARN.

" }, "DeleteVPCEConfiguration": { "name": "DeleteVPCEConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVPCEConfigurationRequest" }, "output": { "shape": "DeleteVPCEConfigurationResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "ServiceAccountException" }, { "shape": "InvalidOperationException" } ], "documentation": "

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

" }, "GetAccountSettings": { "name": "GetAccountSettings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetAccountSettingsRequest" }, "output": { "shape": "GetAccountSettingsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.

" }, "GetDevice": { "name": "GetDevice", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDeviceRequest" }, "output": { "shape": "GetDeviceResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about a unique device type.

" }, "GetDeviceInstance": { "name": "GetDeviceInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDeviceInstanceRequest" }, "output": { "shape": "GetDeviceInstanceResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns information about a device instance that belongs to a private device fleet.

" }, "GetDevicePool": { "name": "GetDevicePool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDevicePoolRequest" }, "output": { "shape": "GetDevicePoolResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about a device pool.

" }, "GetDevicePoolCompatibility": { "name": "GetDevicePoolCompatibility", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDevicePoolCompatibilityRequest" }, "output": { "shape": "GetDevicePoolCompatibilityResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about compatibility with a device pool.

" }, "GetInstanceProfile": { "name": "GetInstanceProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetInstanceProfileRequest" }, "output": { "shape": "GetInstanceProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns information about the specified instance profile.

" }, "GetJob": { "name": "GetJob", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetJobRequest" }, "output": { "shape": "GetJobResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about a job.

" }, "GetNetworkProfile": { "name": "GetNetworkProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetNetworkProfileRequest" }, "output": { "shape": "GetNetworkProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns information about a network profile.

" }, "GetOfferingStatus": { "name": "GetOfferingStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetOfferingStatusRequest" }, "output": { "shape": "GetOfferingStatusResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "NotEligibleException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

" }, "GetProject": { "name": "GetProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetProjectRequest" }, "output": { "shape": "GetProjectResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about a project.

" }, "GetRemoteAccessSession": { "name": "GetRemoteAccessSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetRemoteAccessSessionRequest" }, "output": { "shape": "GetRemoteAccessSessionResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns a link to a currently running remote access session.

" }, "GetRun": { "name": "GetRun", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetRunRequest" }, "output": { "shape": "GetRunResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about a run.

" }, "GetSuite": { "name": "GetSuite", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetSuiteRequest" }, "output": { "shape": "GetSuiteResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about a suite.

" }, "GetTest": { "name": "GetTest", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTestRequest" }, "output": { "shape": "GetTestResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about a test.

" }, "GetTestGridProject": { "name": "GetTestGridProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTestGridProjectRequest" }, "output": { "shape": "GetTestGridProjectResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "InternalServiceException" } ], "documentation": "

Retrieves information about a Selenium testing project.

" }, "GetTestGridSession": { "name": "GetTestGridSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTestGridSessionRequest" }, "output": { "shape": "GetTestGridSessionResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "InternalServiceException" } ], "documentation": "

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url. You can use the following to look up sessions:

" }, "GetUpload": { "name": "GetUpload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetUploadRequest" }, "output": { "shape": "GetUploadResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about an upload.

" }, "GetVPCEConfiguration": { "name": "GetVPCEConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetVPCEConfigurationRequest" }, "output": { "shape": "GetVPCEConfigurationResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "InstallToRemoteAccessSession": { "name": "InstallToRemoteAccessSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InstallToRemoteAccessSessionRequest" }, "output": { "shape": "InstallToRemoteAccessSessionResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

" }, "ListArtifacts": { "name": "ListArtifacts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListArtifactsRequest" }, "output": { "shape": "ListArtifactsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about artifacts.

" }, "ListDeviceInstances": { "name": "ListDeviceInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDeviceInstancesRequest" }, "output": { "shape": "ListDeviceInstancesResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "ListDevicePools": { "name": "ListDevicePools", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDevicePoolsRequest" }, "output": { "shape": "ListDevicePoolsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about device pools.

" }, "ListDevices": { "name": "ListDevices", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListDevicesRequest" }, "output": { "shape": "ListDevicesResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about unique device types.

" }, "ListInstanceProfiles": { "name": "ListInstanceProfiles", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListInstanceProfilesRequest" }, "output": { "shape": "ListInstanceProfilesResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns information about all the instance profiles in an AWS account.

" }, "ListJobs": { "name": "ListJobs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListJobsRequest" }, "output": { "shape": "ListJobsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about jobs for a given test run.

" }, "ListNetworkProfiles": { "name": "ListNetworkProfiles", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListNetworkProfilesRequest" }, "output": { "shape": "ListNetworkProfilesResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns the list of available network profiles.

" }, "ListOfferingPromotions": { "name": "ListOfferingPromotions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListOfferingPromotionsRequest" }, "output": { "shape": "ListOfferingPromotionsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "NotEligibleException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you must be able to invoke this operation.

" }, "ListOfferingTransactions": { "name": "ListOfferingTransactions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListOfferingTransactionsRequest" }, "output": { "shape": "ListOfferingTransactionsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "NotEligibleException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

" }, "ListOfferings": { "name": "ListOfferings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListOfferingsRequest" }, "output": { "shape": "ListOfferingsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "NotEligibleException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

" }, "ListProjects": { "name": "ListProjects", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListProjectsRequest" }, "output": { "shape": "ListProjectsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about projects.

" }, "ListRemoteAccessSessions": { "name": "ListRemoteAccessSessions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListRemoteAccessSessionsRequest" }, "output": { "shape": "ListRemoteAccessSessionsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Returns a list of all currently running remote access sessions.

" }, "ListRuns": { "name": "ListRuns", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListRunsRequest" }, "output": { "shape": "ListRunsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about runs, given an AWS Device Farm project ARN.

" }, "ListSamples": { "name": "ListSamples", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListSamplesRequest" }, "output": { "shape": "ListSamplesResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about samples, given an AWS Device Farm job ARN.

" }, "ListSuites": { "name": "ListSuites", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListSuitesRequest" }, "output": { "shape": "ListSuitesResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about test suites for a given job.

" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "TagOperationException" } ], "documentation": "

List the tags for an AWS Device Farm resource.

" }, "ListTestGridProjects": { "name": "ListTestGridProjects", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTestGridProjectsRequest" }, "output": { "shape": "ListTestGridProjectsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "InternalServiceException" } ], "documentation": "

Gets a list of all Selenium testing projects in your account.

" }, "ListTestGridSessionActions": { "name": "ListTestGridSessionActions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTestGridSessionActionsRequest" }, "output": { "shape": "ListTestGridSessionActionsResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "InternalServiceException" } ], "documentation": "

Returns a list of the actions taken in a TestGridSession.

" }, "ListTestGridSessionArtifacts": { "name": "ListTestGridSessionArtifacts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTestGridSessionArtifactsRequest" }, "output": { "shape": "ListTestGridSessionArtifactsResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "InternalServiceException" } ], "documentation": "

Retrieves a list of artifacts created during the session.

" }, "ListTestGridSessions": { "name": "ListTestGridSessions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTestGridSessionsRequest" }, "output": { "shape": "ListTestGridSessionsResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "InternalServiceException" } ], "documentation": "

Retrieves a list of sessions for a TestGridProject.

" }, "ListTests": { "name": "ListTests", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTestsRequest" }, "output": { "shape": "ListTestsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about tests in a given test suite.

" }, "ListUniqueProblems": { "name": "ListUniqueProblems", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListUniqueProblemsRequest" }, "output": { "shape": "ListUniqueProblemsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about unique problems, such as exceptions or crashes.

Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call in your application consistently raises an exception (OutOfBoundsException in MyActivity.java:386), ListUniqueProblems returns a single entry instead of many individual entries for that exception.

" }, "ListUploads": { "name": "ListUploads", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListUploadsRequest" }, "output": { "shape": "ListUploadsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Gets information about uploads, given an AWS Device Farm project ARN.

" }, "ListVPCEConfigurations": { "name": "ListVPCEConfigurations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListVPCEConfigurationsRequest" }, "output": { "shape": "ListVPCEConfigurationsResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "PurchaseOffering": { "name": "PurchaseOffering", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PurchaseOfferingRequest" }, "output": { "shape": "PurchaseOfferingResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "NotEligibleException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

" }, "RenewOffering": { "name": "RenewOffering", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RenewOfferingRequest" }, "output": { "shape": "RenewOfferingResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "NotEligibleException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

" }, "ScheduleRun": { "name": "ScheduleRun", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ScheduleRunRequest" }, "output": { "shape": "ScheduleRunResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "IdempotencyException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Schedules a run.

" }, "StopJob": { "name": "StopJob", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopJobRequest" }, "output": { "shape": "StopJobResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.

" }, "StopRemoteAccessSession": { "name": "StopRemoteAccessSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopRemoteAccessSessionRequest" }, "output": { "shape": "StopRemoteAccessSessionResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Ends a specified remote access session.

" }, "StopRun": { "name": "StopRun", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopRunRequest" }, "output": { "shape": "StopRunResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.

" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "TagOperationException" }, { "shape": "TooManyTagsException" }, { "shape": "TagPolicyException" } ], "documentation": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "TagOperationException" } ], "documentation": "

Deletes the specified tags from a resource.

" }, "UpdateDeviceInstance": { "name": "UpdateDeviceInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateDeviceInstanceRequest" }, "output": { "shape": "UpdateDeviceInstanceResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Updates information about a private device instance.

" }, "UpdateDevicePool": { "name": "UpdateDevicePool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateDevicePoolRequest" }, "output": { "shape": "UpdateDevicePoolResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

" }, "UpdateInstanceProfile": { "name": "UpdateInstanceProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateInstanceProfileRequest" }, "output": { "shape": "UpdateInstanceProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Updates information about an existing private device instance profile.

" }, "UpdateNetworkProfile": { "name": "UpdateNetworkProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateNetworkProfileRequest" }, "output": { "shape": "UpdateNetworkProfileResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Updates the network profile.

" }, "UpdateProject": { "name": "UpdateProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateProjectRequest" }, "output": { "shape": "UpdateProjectResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

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

" }, "UpdateTestGridProject": { "name": "UpdateTestGridProject", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateTestGridProjectRequest" }, "output": { "shape": "UpdateTestGridProjectResult" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ArgumentException" }, { "shape": "LimitExceededException" }, { "shape": "InternalServiceException" } ], "documentation": "

Change details of a project.

" }, "UpdateUpload": { "name": "UpdateUpload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateUploadRequest" }, "output": { "shape": "UpdateUploadResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ServiceAccountException" } ], "documentation": "

Updates an uploaded test spec.

" }, "UpdateVPCEConfiguration": { "name": "UpdateVPCEConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateVPCEConfigurationRequest" }, "output": { "shape": "UpdateVPCEConfigurationResult" }, "errors": [ { "shape": "ArgumentException" }, { "shape": "NotFoundException" }, { "shape": "ServiceAccountException" }, { "shape": "InvalidOperationException" } ], "documentation": "

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

" } }, "shapes": { "AWSAccountNumber": { "type": "string", "max": 16, "min": 2 }, "AccountSettings": { "type": "structure", "members": { "awsAccountNumber": { "shape": "AWSAccountNumber", "documentation": "

The AWS account number specified in the AccountSettings container.

" }, "unmeteredDevices": { "shape": "PurchasedDevicesMap", "documentation": "

Returns the unmetered devices you have purchased or want to purchase.

" }, "unmeteredRemoteAccessDevices": { "shape": "PurchasedDevicesMap", "documentation": "

Returns the unmetered remote access devices you have purchased or want to purchase.

" }, "maxJobTimeoutMinutes": { "shape": "JobTimeoutMinutes", "documentation": "

The maximum number of minutes a test run executes before it times out.

" }, "trialMinutes": { "shape": "TrialMinutes", "documentation": "

Information about an AWS account's usage of free trial device minutes.

" }, "maxSlots": { "shape": "MaxSlotMap", "documentation": "

The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command.

" }, "defaultJobTimeoutMinutes": { "shape": "JobTimeoutMinutes", "documentation": "

The default number of minutes (at the account level) a test run executes before it times out. The default value is 150 minutes.

" }, "skipAppResign": { "shape": "SkipAppResign", "documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" } }, "documentation": "

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

" }, "AccountsCleanup": { "type": "boolean" }, "AmazonResourceName": { "type": "string", "max": 1011, "min": 32, "pattern": "^arn:aws:devicefarm:.+" }, "AmazonResourceNames": { "type": "list", "member": { "shape": "AmazonResourceName" } }, "AndroidPaths": { "type": "list", "member": { "shape": "String" } }, "AppPackagesCleanup": { "type": "boolean" }, "Artifact": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The artifact's ARN.

" }, "name": { "shape": "Name", "documentation": "

The artifact's name.

" }, "type": { "shape": "ArtifactType", "documentation": "

The artifact's type.

Allowed values include the following:

" }, "extension": { "shape": "String", "documentation": "

The artifact's file extension.

" }, "url": { "shape": "URL", "documentation": "

The presigned Amazon S3 URL that can be used with a GET request to download the artifact's file.

" } }, "documentation": "

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

" }, "ArtifactCategory": { "type": "string", "enum": [ "SCREENSHOT", "FILE", "LOG" ] }, "ArtifactType": { "type": "string", "enum": [ "UNKNOWN", "SCREENSHOT", "DEVICE_LOG", "MESSAGE_LOG", "VIDEO_LOG", "RESULT_LOG", "SERVICE_LOG", "WEBKIT_LOG", "INSTRUMENTATION_OUTPUT", "EXERCISER_MONKEY_OUTPUT", "CALABASH_JSON_OUTPUT", "CALABASH_PRETTY_OUTPUT", "CALABASH_STANDARD_OUTPUT", "CALABASH_JAVA_XML_OUTPUT", "AUTOMATION_OUTPUT", "APPIUM_SERVER_OUTPUT", "APPIUM_JAVA_OUTPUT", "APPIUM_JAVA_XML_OUTPUT", "APPIUM_PYTHON_OUTPUT", "APPIUM_PYTHON_XML_OUTPUT", "EXPLORER_EVENT_LOG", "EXPLORER_SUMMARY_LOG", "APPLICATION_CRASH_REPORT", "XCTEST_LOG", "VIDEO", "CUSTOMER_ARTIFACT", "CUSTOMER_ARTIFACT_LOG", "TESTSPEC_OUTPUT" ] }, "Artifacts": { "type": "list", "member": { "shape": "Artifact" } }, "BillingMethod": { "type": "string", "enum": [ "METERED", "UNMETERED" ] }, "Boolean": { "type": "boolean" }, "CPU": { "type": "structure", "members": { "frequency": { "shape": "String", "documentation": "

The CPU's frequency.

" }, "architecture": { "shape": "String", "documentation": "

The CPU's architecture (for example, x86 or ARM).

" }, "clock": { "shape": "Double", "documentation": "

The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.

" } }, "documentation": "

Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage.

" }, "ClientId": { "type": "string", "max": 64, "min": 0 }, "ContentType": { "type": "string", "max": 64, "min": 0 }, "Counters": { "type": "structure", "members": { "total": { "shape": "Integer", "documentation": "

The total number of entities.

" }, "passed": { "shape": "Integer", "documentation": "

The number of passed entities.

" }, "failed": { "shape": "Integer", "documentation": "

The number of failed entities.

" }, "warned": { "shape": "Integer", "documentation": "

The number of warned entities.

" }, "errored": { "shape": "Integer", "documentation": "

The number of errored entities.

" }, "stopped": { "shape": "Integer", "documentation": "

The number of stopped entities.

" }, "skipped": { "shape": "Integer", "documentation": "

The number of skipped entities.

" } }, "documentation": "

Represents entity counters.

" }, "CreateDevicePoolRequest": { "type": "structure", "required": [ "projectArn", "name", "rules" ], "members": { "projectArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the project for the device pool.

" }, "name": { "shape": "Name", "documentation": "

The device pool's name.

" }, "description": { "shape": "Message", "documentation": "

The device pool's description.

" }, "rules": { "shape": "Rules", "documentation": "

The device pool's rules.

" }, "maxDevices": { "shape": "Integer", "documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

" } }, "documentation": "

Represents a request to the create device pool operation.

" }, "CreateDevicePoolResult": { "type": "structure", "members": { "devicePool": { "shape": "DevicePool", "documentation": "

The newly created device pool.

" } }, "documentation": "

Represents the result of a create device pool request.

" }, "CreateInstanceProfileRequest": { "type": "structure", "required": [ "name" ], "members": { "name": { "shape": "Name", "documentation": "

The name of your instance profile.

" }, "description": { "shape": "Message", "documentation": "

The description of your instance profile.

" }, "packageCleanup": { "shape": "Boolean", "documentation": "

When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.

" }, "excludeAppPackagesFromCleanup": { "shape": "PackageIds", "documentation": "

An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.

The list of packages is considered only if you set packageCleanup to true.

" }, "rebootAfterUse": { "shape": "Boolean", "documentation": "

When set to true, Device Farm reboots the instance after a test run. The default value is true.

" } } }, "CreateInstanceProfileResult": { "type": "structure", "members": { "instanceProfile": { "shape": "InstanceProfile", "documentation": "

An object that contains information about your instance profile.

" } } }, "CreateNetworkProfileRequest": { "type": "structure", "required": [ "projectArn", "name" ], "members": { "projectArn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project for which you want to create a network profile.

" }, "name": { "shape": "Name", "documentation": "

The name for the new network profile.

" }, "description": { "shape": "Message", "documentation": "

The description of the network profile.

" }, "type": { "shape": "NetworkProfileType", "documentation": "

The type of network profile to create. Valid values are listed here.

" }, "uplinkBandwidthBits": { "shape": "Long", "documentation": "

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" }, "downlinkBandwidthBits": { "shape": "Long", "documentation": "

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" }, "uplinkDelayMs": { "shape": "Long", "documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" }, "downlinkDelayMs": { "shape": "Long", "documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" }, "uplinkJitterMs": { "shape": "Long", "documentation": "

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" }, "downlinkJitterMs": { "shape": "Long", "documentation": "

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" }, "uplinkLossPercent": { "shape": "PercentInteger", "documentation": "

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

" }, "downlinkLossPercent": { "shape": "PercentInteger", "documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" } } }, "CreateNetworkProfileResult": { "type": "structure", "members": { "networkProfile": { "shape": "NetworkProfile", "documentation": "

The network profile that is returned by the create network profile request.

" } } }, "CreateProjectRequest": { "type": "structure", "required": [ "name" ], "members": { "name": { "shape": "Name", "documentation": "

The project's name.

" }, "defaultJobTimeoutMinutes": { "shape": "JobTimeoutMinutes", "documentation": "

Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.

" }, "vpcConfig": { "shape": "VpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" } }, "documentation": "

Represents a request to the create project operation.

" }, "CreateProjectResult": { "type": "structure", "members": { "project": { "shape": "Project", "documentation": "

The newly created project.

" } }, "documentation": "

Represents the result of a create project request.

" }, "CreateRemoteAccessSessionConfiguration": { "type": "structure", "members": { "billingMethod": { "shape": "BillingMethod", "documentation": "

The billing method for the remote access session.

" }, "vpceConfigurationArns": { "shape": "AmazonResourceNames", "documentation": "

An array of ARNs included in the VPC endpoint configuration.

" } }, "documentation": "

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

" }, "CreateRemoteAccessSessionRequest": { "type": "structure", "required": [ "projectArn", "deviceArn" ], "members": { "projectArn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

" }, "deviceArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the device for which you want to create a remote access session.

" }, "instanceArn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

" }, "sshPublicKey": { "shape": "SshPublicKey", "documentation": "

Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

" }, "remoteDebugEnabled": { "shape": "Boolean", "documentation": "

Set to true if you want to access devices remotely for debugging in your remote access session.

Remote debugging is no longer supported.

" }, "remoteRecordEnabled": { "shape": "Boolean", "documentation": "

Set to true to enable remote recording for the remote access session.

" }, "remoteRecordAppArn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

" }, "name": { "shape": "Name", "documentation": "

The name of the remote access session to create.

" }, "clientId": { "shape": "ClientId", "documentation": "

Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

" }, "configuration": { "shape": "CreateRemoteAccessSessionConfiguration", "documentation": "

The configuration information for the remote access session request.

" }, "interactionMode": { "shape": "InteractionMode", "documentation": "

The interaction mode of the remote access session. Valid values are:

" }, "skipAppResign": { "shape": "Boolean", "documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

" } }, "documentation": "

Creates and submits a request to start a remote access session.

" }, "CreateRemoteAccessSessionResult": { "type": "structure", "members": { "remoteAccessSession": { "shape": "RemoteAccessSession", "documentation": "

A container that describes the remote access session when the request to create a remote access session is sent.

" } }, "documentation": "

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

" }, "CreateTestGridProjectRequest": { "type": "structure", "required": [ "name" ], "members": { "name": { "shape": "ResourceName", "documentation": "

Human-readable name of the Selenium testing project.

" }, "description": { "shape": "ResourceDescription", "documentation": "

Human-readable description of the project.

" }, "vpcConfig": { "shape": "TestGridVpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" } } }, "CreateTestGridProjectResult": { "type": "structure", "members": { "testGridProject": { "shape": "TestGridProject", "documentation": "

ARN of the Selenium testing project that was created.

" } } }, "CreateTestGridUrlRequest": { "type": "structure", "required": [ "projectArn", "expiresInSeconds" ], "members": { "projectArn": { "shape": "DeviceFarmArn", "documentation": "

ARN (from CreateTestGridProject or ListTestGridProjects) to associate with the short-term URL.

" }, "expiresInSeconds": { "shape": "TestGridUrlExpiresInSecondsInput", "documentation": "

Lifetime, in seconds, of the URL.

" } } }, "CreateTestGridUrlResult": { "type": "structure", "members": { "url": { "shape": "SensitiveString", "documentation": "

A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to be passed to a RemoteWebDriver.

" }, "expires": { "shape": "DateTime", "documentation": "

The number of seconds the URL from CreateTestGridUrlResult$url stays active.

" } } }, "CreateUploadRequest": { "type": "structure", "required": [ "projectArn", "name", "type" ], "members": { "projectArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the project for the upload.

" }, "name": { "shape": "Name", "documentation": "

The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.

" }, "type": { "shape": "UploadType", "documentation": "

The upload's upload type.

Must be one of the following values:

If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

" }, "contentType": { "shape": "ContentType", "documentation": "

The upload's content type (for example, application/octet-stream).

" } }, "documentation": "

Represents a request to the create upload operation.

" }, "CreateUploadResult": { "type": "structure", "members": { "upload": { "shape": "Upload", "documentation": "

The newly created upload.

" } }, "documentation": "

Represents the result of a create upload request.

" }, "CreateVPCEConfigurationRequest": { "type": "structure", "required": [ "vpceConfigurationName", "vpceServiceName", "serviceDnsName" ], "members": { "vpceConfigurationName": { "shape": "VPCEConfigurationName", "documentation": "

The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.

" }, "vpceServiceName": { "shape": "VPCEServiceName", "documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

" }, "serviceDnsName": { "shape": "ServiceDnsName", "documentation": "

The DNS name of the service running in your VPC that you want Device Farm to test.

" }, "vpceConfigurationDescription": { "shape": "VPCEConfigurationDescription", "documentation": "

An optional description that provides details about your VPC endpoint configuration.

" } } }, "CreateVPCEConfigurationResult": { "type": "structure", "members": { "vpceConfiguration": { "shape": "VPCEConfiguration", "documentation": "

An object that contains information about your VPC endpoint configuration.

" } } }, "CurrencyCode": { "type": "string", "enum": [ "USD" ] }, "CustomerArtifactPaths": { "type": "structure", "members": { "iosPaths": { "shape": "IosPaths", "documentation": "

Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled from.

" }, "androidPaths": { "shape": "AndroidPaths", "documentation": "

Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are pulled from.

" }, "deviceHostPaths": { "shape": "DeviceHostPaths", "documentation": "

Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests are pulled from.

" } }, "documentation": "

A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

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

" }, "DateTime": { "type": "timestamp" }, "DeleteDevicePoolRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.

" } }, "documentation": "

Represents a request to the delete device pool operation.

" }, "DeleteDevicePoolResult": { "type": "structure", "members": {}, "documentation": "

Represents the result of a delete device pool request.

" }, "DeleteInstanceProfileRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.

" } } }, "DeleteInstanceProfileResult": { "type": "structure", "members": {} }, "DeleteNetworkProfileRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the network profile to delete.

" } } }, "DeleteNetworkProfileResult": { "type": "structure", "members": {} }, "DeleteProjectRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.

" } }, "documentation": "

Represents a request to the delete project operation.

" }, "DeleteProjectResult": { "type": "structure", "members": {}, "documentation": "

Represents the result of a delete project request.

" }, "DeleteRemoteAccessSessionRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the session for which you want to delete remote access.

" } }, "documentation": "

Represents the request to delete the specified remote access session.

" }, "DeleteRemoteAccessSessionResult": { "type": "structure", "members": {}, "documentation": "

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

" }, "DeleteRunRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) for the run to delete.

" } }, "documentation": "

Represents a request to the delete run operation.

" }, "DeleteRunResult": { "type": "structure", "members": {}, "documentation": "

Represents the result of a delete run request.

" }, "DeleteTestGridProjectRequest": { "type": "structure", "required": [ "projectArn" ], "members": { "projectArn": { "shape": "DeviceFarmArn", "documentation": "

The ARN of the project to delete, from CreateTestGridProject or ListTestGridProjects.

" } } }, "DeleteTestGridProjectResult": { "type": "structure", "members": {} }, "DeleteUploadRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.

" } }, "documentation": "

Represents a request to the delete upload operation.

" }, "DeleteUploadResult": { "type": "structure", "members": {}, "documentation": "

Represents the result of a delete upload request.

" }, "DeleteVPCEConfigurationRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.

" } } }, "DeleteVPCEConfigurationResult": { "type": "structure", "members": {} }, "Device": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The device's ARN.

" }, "name": { "shape": "Name", "documentation": "

The device's display name.

" }, "manufacturer": { "shape": "String", "documentation": "

The device's manufacturer name.

" }, "model": { "shape": "String", "documentation": "

The device's model name.

" }, "modelId": { "shape": "String", "documentation": "

The device's model ID.

" }, "formFactor": { "shape": "DeviceFormFactor", "documentation": "

The device's form factor.

Allowed values include:

" }, "platform": { "shape": "DevicePlatform", "documentation": "

The device's platform.

Allowed values include:

" }, "os": { "shape": "String", "documentation": "

The device's operating system type.

" }, "cpu": { "shape": "CPU", "documentation": "

Information about the device's CPU.

" }, "resolution": { "shape": "Resolution", "documentation": "

The resolution of the device.

" }, "heapSize": { "shape": "Long", "documentation": "

The device's heap size, expressed in bytes.

" }, "memory": { "shape": "Long", "documentation": "

The device's total memory size, expressed in bytes.

" }, "image": { "shape": "String", "documentation": "

The device's image name.

" }, "carrier": { "shape": "String", "documentation": "

The device's carrier.

" }, "radio": { "shape": "String", "documentation": "

The device's radio.

" }, "remoteAccessEnabled": { "shape": "Boolean", "documentation": "

Specifies whether remote access has been enabled for the specified device.

" }, "remoteDebugEnabled": { "shape": "Boolean", "documentation": "

This flag is set to true if remote debugging is enabled for the device.

Remote debugging is no longer supported.

" }, "fleetType": { "shape": "String", "documentation": "

The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.

" }, "fleetName": { "shape": "String", "documentation": "

The name of the fleet to which this device belongs.

" }, "instances": { "shape": "DeviceInstances", "documentation": "

The instances that belong to this device.

" }, "availability": { "shape": "DeviceAvailability", "documentation": "

Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.

" } }, "documentation": "

Represents a device type that an app is tested against.

" }, "DeviceAttribute": { "type": "string", "enum": [ "ARN", "PLATFORM", "FORM_FACTOR", "MANUFACTURER", "REMOTE_ACCESS_ENABLED", "REMOTE_DEBUG_ENABLED", "APPIUM_VERSION", "INSTANCE_ARN", "INSTANCE_LABELS", "FLEET_TYPE", "OS_VERSION", "MODEL", "AVAILABILITY" ] }, "DeviceAvailability": { "type": "string", "enum": [ "TEMPORARY_NOT_AVAILABLE", "BUSY", "AVAILABLE", "HIGHLY_AVAILABLE" ] }, "DeviceFarmArn": { "type": "string", "max": 1011, "min": 32, "pattern": "^arn:aws:devicefarm:.+" }, "DeviceFilter": { "type": "structure", "required": [ "attribute", "operator", "values" ], "members": { "attribute": { "shape": "DeviceFilterAttribute", "documentation": "

The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.

ARN

The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS

OS_VERSION

The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

The device model (for example, iPad 5th Gen).

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS

MANUFACTURER

The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALS

" }, "operator": { "shape": "RuleOperator", "documentation": "

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

" }, "values": { "shape": "DeviceFilterValues", "documentation": "

An array of one or more filter values used in a device filter.

Operator Values

Attribute Values

" } }, "documentation": "

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

" }, "DeviceFilterAttribute": { "type": "string", "enum": [ "ARN", "PLATFORM", "OS_VERSION", "MODEL", "AVAILABILITY", "FORM_FACTOR", "MANUFACTURER", "REMOTE_ACCESS_ENABLED", "REMOTE_DEBUG_ENABLED", "INSTANCE_ARN", "INSTANCE_LABELS", "FLEET_TYPE" ] }, "DeviceFilterValues": { "type": "list", "member": { "shape": "String" } }, "DeviceFilters": { "type": "list", "member": { "shape": "DeviceFilter" } }, "DeviceFormFactor": { "type": "string", "enum": [ "PHONE", "TABLET" ] }, "DeviceHostPaths": { "type": "list", "member": { "shape": "String" } }, "DeviceInstance": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the device instance.

" }, "deviceArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the device.

" }, "labels": { "shape": "InstanceLabels", "documentation": "

An array of strings that describe the device instance.

" }, "status": { "shape": "InstanceStatus", "documentation": "

The status of the device instance. Valid values are listed here.

" }, "udid": { "shape": "String", "documentation": "

Unique device identifier for the device instance.

" }, "instanceProfile": { "shape": "InstanceProfile", "documentation": "

A object that contains information about the instance profile.

" } }, "documentation": "

Represents the device instance.

" }, "DeviceInstances": { "type": "list", "member": { "shape": "DeviceInstance" } }, "DeviceMinutes": { "type": "structure", "members": { "total": { "shape": "Double", "documentation": "

When specified, represents the total minutes used by the resource to run tests.

" }, "metered": { "shape": "Double", "documentation": "

When specified, represents only the sum of metered minutes used by the resource to run tests.

" }, "unmetered": { "shape": "Double", "documentation": "

When specified, represents only the sum of unmetered minutes used by the resource to run tests.

" } }, "documentation": "

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

" }, "DevicePlatform": { "type": "string", "enum": [ "ANDROID", "IOS" ] }, "DevicePool": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The device pool's ARN.

" }, "name": { "shape": "Name", "documentation": "

The device pool's name.

" }, "description": { "shape": "Message", "documentation": "

The device pool's description.

" }, "type": { "shape": "DevicePoolType", "documentation": "

The device pool's type.

Allowed values include:

" }, "rules": { "shape": "Rules", "documentation": "

Information about the device pool's rules.

" }, "maxDevices": { "shape": "Integer", "documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

" } }, "documentation": "

Represents a collection of device types.

" }, "DevicePoolCompatibilityResult": { "type": "structure", "members": { "device": { "shape": "Device", "documentation": "

The device (phone or tablet) to return information about.

" }, "compatible": { "shape": "Boolean", "documentation": "

Whether the result was compatible with the device pool.

" }, "incompatibilityMessages": { "shape": "IncompatibilityMessages", "documentation": "

Information about the compatibility.

" } }, "documentation": "

Represents a device pool compatibility result.

" }, "DevicePoolCompatibilityResults": { "type": "list", "member": { "shape": "DevicePoolCompatibilityResult" } }, "DevicePoolType": { "type": "string", "enum": [ "CURATED", "PRIVATE" ] }, "DevicePools": { "type": "list", "member": { "shape": "DevicePool" } }, "DeviceSelectionConfiguration": { "type": "structure", "required": [ "filters", "maxDevices" ], "members": { "filters": { "shape": "DeviceFilters", "documentation": "

Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.

" }, "maxDevices": { "shape": "Integer", "documentation": "

The maximum number of devices to be included in a test run.

" } }, "documentation": "

Represents the device filters used in a test run and the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.

" }, "DeviceSelectionResult": { "type": "structure", "members": { "filters": { "shape": "DeviceFilters", "documentation": "

The filters in a device selection result.

" }, "matchedDevicesCount": { "shape": "Integer", "documentation": "

The number of devices that matched the device filter selection criteria.

" }, "maxDevices": { "shape": "Integer", "documentation": "

The maximum number of devices to be selected by a device filter and included in a test run.

" } }, "documentation": "

Contains the run results requested by the device selection configuration and how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.

" }, "Devices": { "type": "list", "member": { "shape": "Device" } }, "Double": { "type": "double" }, "ExecutionConfiguration": { "type": "structure", "members": { "jobTimeoutMinutes": { "shape": "JobTimeoutMinutes", "documentation": "

The number of minutes a test run executes before it times out.

" }, "accountsCleanup": { "shape": "AccountsCleanup", "documentation": "

True if account cleanup is enabled at the beginning of the test. Otherwise, false.

" }, "appPackagesCleanup": { "shape": "AppPackagesCleanup", "documentation": "

True if app package cleanup is enabled at the beginning of the test. Otherwise, false.

" }, "videoCapture": { "shape": "VideoCapture", "documentation": "

Set to true to enable video capture. Otherwise, set to false. The default is true.

" }, "skipAppResign": { "shape": "SkipAppResign", "documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" } }, "documentation": "

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

" }, "ExecutionResult": { "type": "string", "enum": [ "PENDING", "PASSED", "WARNED", "FAILED", "SKIPPED", "ERRORED", "STOPPED" ] }, "ExecutionResultCode": { "type": "string", "enum": [ "PARSING_FAILED", "VPC_ENDPOINT_SETUP_FAILED" ] }, "ExecutionStatus": { "type": "string", "enum": [ "PENDING", "PENDING_CONCURRENCY", "PENDING_DEVICE", "PROCESSING", "SCHEDULING", "PREPARING", "RUNNING", "COMPLETED", "STOPPING" ] }, "Filter": { "type": "string", "max": 8192, "min": 0 }, "GetAccountSettingsRequest": { "type": "structure", "members": {}, "documentation": "

Represents the request sent to retrieve the account settings.

" }, "GetAccountSettingsResult": { "type": "structure", "members": { "accountSettings": { "shape": "AccountSettings", "documentation": "

The account settings.

" } }, "documentation": "

Represents the account settings return values from the GetAccountSettings request.

" }, "GetDeviceInstanceRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the instance you're requesting information about.

" } } }, "GetDeviceInstanceResult": { "type": "structure", "members": { "deviceInstance": { "shape": "DeviceInstance", "documentation": "

An object that contains information about your device instance.

" } } }, "GetDevicePoolCompatibilityRequest": { "type": "structure", "required": [ "devicePoolArn" ], "members": { "devicePoolArn": { "shape": "AmazonResourceName", "documentation": "

The device pool's ARN.

" }, "appArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the app that is associated with the specified device pool.

" }, "testType": { "shape": "TestType", "documentation": "

The test type for the specified device pool.

Allowed values include the following:

" }, "test": { "shape": "ScheduleRunTest", "documentation": "

Information about the uploaded test to be run against the device pool.

" }, "configuration": { "shape": "ScheduleRunConfiguration", "documentation": "

An object that contains information about the settings for a run.

" } }, "documentation": "

Represents a request to the get device pool compatibility operation.

" }, "GetDevicePoolCompatibilityResult": { "type": "structure", "members": { "compatibleDevices": { "shape": "DevicePoolCompatibilityResults", "documentation": "

Information about compatible devices.

" }, "incompatibleDevices": { "shape": "DevicePoolCompatibilityResults", "documentation": "

Information about incompatible devices.

" } }, "documentation": "

Represents the result of describe device pool compatibility request.

" }, "GetDevicePoolRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The device pool's ARN.

" } }, "documentation": "

Represents a request to the get device pool operation.

" }, "GetDevicePoolResult": { "type": "structure", "members": { "devicePool": { "shape": "DevicePool", "documentation": "

An object that contains information about the requested device pool.

" } }, "documentation": "

Represents the result of a get device pool request.

" }, "GetDeviceRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The device type's ARN.

" } }, "documentation": "

Represents a request to the get device request.

" }, "GetDeviceResult": { "type": "structure", "members": { "device": { "shape": "Device", "documentation": "

An object that contains information about the requested device.

" } }, "documentation": "

Represents the result of a get device request.

" }, "GetInstanceProfileRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of an instance profile.

" } } }, "GetInstanceProfileResult": { "type": "structure", "members": { "instanceProfile": { "shape": "InstanceProfile", "documentation": "

An object that contains information about an instance profile.

" } } }, "GetJobRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The job's ARN.

" } }, "documentation": "

Represents a request to the get job operation.

" }, "GetJobResult": { "type": "structure", "members": { "job": { "shape": "Job", "documentation": "

An object that contains information about the requested job.

" } }, "documentation": "

Represents the result of a get job request.

" }, "GetNetworkProfileRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the network profile to return information about.

" } } }, "GetNetworkProfileResult": { "type": "structure", "members": { "networkProfile": { "shape": "NetworkProfile", "documentation": "

The network profile.

" } } }, "GetOfferingStatusRequest": { "type": "structure", "members": { "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents the request to retrieve the offering status for the specified customer or account.

" }, "GetOfferingStatusResult": { "type": "structure", "members": { "current": { "shape": "OfferingStatusMap", "documentation": "

When specified, gets the offering status for the current period.

" }, "nextPeriod": { "shape": "OfferingStatusMap", "documentation": "

When specified, gets the offering status for the next period.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Returns the status result for a device offering.

" }, "GetProjectRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The project's ARN.

" } }, "documentation": "

Represents a request to the get project operation.

" }, "GetProjectResult": { "type": "structure", "members": { "project": { "shape": "Project", "documentation": "

The project to get information about.

" } }, "documentation": "

Represents the result of a get project request.

" }, "GetRemoteAccessSessionRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

" } }, "documentation": "

Represents the request to get information about the specified remote access session.

" }, "GetRemoteAccessSessionResult": { "type": "structure", "members": { "remoteAccessSession": { "shape": "RemoteAccessSession", "documentation": "

A container that lists detailed information about the remote access session.

" } }, "documentation": "

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

" }, "GetRunRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The run's ARN.

" } }, "documentation": "

Represents a request to the get run operation.

" }, "GetRunResult": { "type": "structure", "members": { "run": { "shape": "Run", "documentation": "

The run to get results from.

" } }, "documentation": "

Represents the result of a get run request.

" }, "GetSuiteRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The suite's ARN.

" } }, "documentation": "

Represents a request to the get suite operation.

" }, "GetSuiteResult": { "type": "structure", "members": { "suite": { "shape": "Suite", "documentation": "

A collection of one or more tests.

" } }, "documentation": "

Represents the result of a get suite request.

" }, "GetTestGridProjectRequest": { "type": "structure", "required": [ "projectArn" ], "members": { "projectArn": { "shape": "DeviceFarmArn", "documentation": "

The ARN of the Selenium testing project, from either CreateTestGridProject or ListTestGridProjects.

" } } }, "GetTestGridProjectResult": { "type": "structure", "members": { "testGridProject": { "shape": "TestGridProject", "documentation": "

A TestGridProject.

" } } }, "GetTestGridSessionRequest": { "type": "structure", "members": { "projectArn": { "shape": "DeviceFarmArn", "documentation": "

The ARN for the project that this session belongs to. See CreateTestGridProject and ListTestGridProjects.

" }, "sessionId": { "shape": "ResourceId", "documentation": "

An ID associated with this session.

" }, "sessionArn": { "shape": "DeviceFarmArn", "documentation": "

An ARN that uniquely identifies a TestGridSession.

" } } }, "GetTestGridSessionResult": { "type": "structure", "members": { "testGridSession": { "shape": "TestGridSession", "documentation": "

The TestGridSession that was requested.

" } } }, "GetTestRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The test's ARN.

" } }, "documentation": "

Represents a request to the get test operation.

" }, "GetTestResult": { "type": "structure", "members": { "test": { "shape": "Test", "documentation": "

A test condition that is evaluated.

" } }, "documentation": "

Represents the result of a get test request.

" }, "GetUploadRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The upload's ARN.

" } }, "documentation": "

Represents a request to the get upload operation.

" }, "GetUploadResult": { "type": "structure", "members": { "upload": { "shape": "Upload", "documentation": "

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

" } }, "documentation": "

Represents the result of a get upload request.

" }, "GetVPCEConfigurationRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.

" } } }, "GetVPCEConfigurationResult": { "type": "structure", "members": { "vpceConfiguration": { "shape": "VPCEConfiguration", "documentation": "

An object that contains information about your VPC endpoint configuration.

" } } }, "HostAddress": { "type": "string", "max": 1024 }, "IncompatibilityMessage": { "type": "structure", "members": { "message": { "shape": "Message", "documentation": "

A message about the incompatibility.

" }, "type": { "shape": "DeviceAttribute", "documentation": "

The type of incompatibility.

Allowed values include:

" } }, "documentation": "

Represents information about incompatibility.

" }, "IncompatibilityMessages": { "type": "list", "member": { "shape": "IncompatibilityMessage" } }, "InstallToRemoteAccessSessionRequest": { "type": "structure", "required": [ "remoteAccessSessionArn", "appArn" ], "members": { "remoteAccessSessionArn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

" }, "appArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the app about which you are requesting information.

" } }, "documentation": "

Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.

" }, "InstallToRemoteAccessSessionResult": { "type": "structure", "members": { "appUpload": { "shape": "Upload", "documentation": "

An app to upload or that has been uploaded.

" } }, "documentation": "

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

" }, "InstanceLabels": { "type": "list", "member": { "shape": "String" } }, "InstanceProfile": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the instance profile.

" }, "packageCleanup": { "shape": "Boolean", "documentation": "

When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.

" }, "excludeAppPackagesFromCleanup": { "shape": "PackageIds", "documentation": "

An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

The list of packages is considered only if you set packageCleanup to true.

" }, "rebootAfterUse": { "shape": "Boolean", "documentation": "

When set to true, Device Farm reboots the instance after a test run. The default value is true.

" }, "name": { "shape": "Name", "documentation": "

The name of the instance profile.

" }, "description": { "shape": "Message", "documentation": "

The description of the instance profile.

" } }, "documentation": "

Represents the instance profile.

" }, "InstanceProfiles": { "type": "list", "member": { "shape": "InstanceProfile" } }, "InstanceStatus": { "type": "string", "enum": [ "IN_USE", "PREPARING", "AVAILABLE", "NOT_AVAILABLE" ] }, "Integer": { "type": "integer" }, "InteractionMode": { "type": "string", "enum": [ "INTERACTIVE", "NO_VIDEO", "VIDEO_ONLY" ], "max": 64, "min": 0 }, "IosPaths": { "type": "list", "member": { "shape": "String" } }, "Job": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The job's ARN.

" }, "name": { "shape": "Name", "documentation": "

The job's name.

" }, "type": { "shape": "TestType", "documentation": "

The job's type.

Allowed values include the following:

" }, "created": { "shape": "DateTime", "documentation": "

When the job was created.

" }, "status": { "shape": "ExecutionStatus", "documentation": "

The job's status.

Allowed values include:

" }, "result": { "shape": "ExecutionResult", "documentation": "

The job's result.

Allowed values include:

" }, "started": { "shape": "DateTime", "documentation": "

The job's start time.

" }, "stopped": { "shape": "DateTime", "documentation": "

The job's stop time.

" }, "counters": { "shape": "Counters", "documentation": "

The job's result counters.

" }, "message": { "shape": "Message", "documentation": "

A message about the job's result.

" }, "device": { "shape": "Device", "documentation": "

The device (phone or tablet).

" }, "instanceArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the instance.

" }, "deviceMinutes": { "shape": "DeviceMinutes", "documentation": "

Represents the total (metered or unmetered) minutes used by the job.

" }, "videoEndpoint": { "shape": "String", "documentation": "

The endpoint for streaming device video.

" }, "videoCapture": { "shape": "VideoCapture", "documentation": "

This value is set to true if video capture is enabled. Otherwise, it is set to false.

" } }, "documentation": "

Represents a device.

" }, "JobTimeoutMinutes": { "type": "integer" }, "Jobs": { "type": "list", "member": { "shape": "Job" } }, "ListArtifactsRequest": { "type": "structure", "required": [ "arn", "type" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The run, job, suite, or test ARN.

" }, "type": { "shape": "ArtifactCategory", "documentation": "

The artifacts' type.

Allowed values include:

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list artifacts operation.

" }, "ListArtifactsResult": { "type": "structure", "members": { "artifacts": { "shape": "Artifacts", "documentation": "

Information about the artifacts.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list artifacts operation.

" }, "ListDeviceInstancesRequest": { "type": "structure", "members": { "maxResults": { "shape": "Integer", "documentation": "

An integer that specifies the maximum number of items you want to return in the API response.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListDeviceInstancesResult": { "type": "structure", "members": { "deviceInstances": { "shape": "DeviceInstances", "documentation": "

An object that contains information about your device instances.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that can be used in the next call to this operation to return the next set of items in the list.

" } } }, "ListDevicePoolsRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The project ARN.

" }, "type": { "shape": "DevicePoolType", "documentation": "

The device pools' type.

Allowed values include:

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list device pools request.

" }, "ListDevicePoolsResult": { "type": "structure", "members": { "devicePools": { "shape": "DevicePools", "documentation": "

Information about the device pools.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list device pools request.

" }, "ListDevicesRequest": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" }, "filters": { "shape": "DeviceFilters", "documentation": "

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

" } }, "documentation": "

Represents the result of a list devices request.

" }, "ListDevicesResult": { "type": "structure", "members": { "devices": { "shape": "Devices", "documentation": "

Information about the devices.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list devices operation.

" }, "ListInstanceProfilesRequest": { "type": "structure", "members": { "maxResults": { "shape": "Integer", "documentation": "

An integer that specifies the maximum number of items you want to return in the API response.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListInstanceProfilesResult": { "type": "structure", "members": { "instanceProfiles": { "shape": "InstanceProfiles", "documentation": "

An object that contains information about your instance profiles.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that can be used in the next call to this operation to return the next set of items in the list.

" } } }, "ListJobsRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The run's Amazon Resource Name (ARN).

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list jobs operation.

" }, "ListJobsResult": { "type": "structure", "members": { "jobs": { "shape": "Jobs", "documentation": "

Information about the jobs.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list jobs request.

" }, "ListNetworkProfilesRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project for which you want to list network profiles.

" }, "type": { "shape": "NetworkProfileType", "documentation": "

The type of network profile to return information about. Valid values are listed here.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListNetworkProfilesResult": { "type": "structure", "members": { "networkProfiles": { "shape": "NetworkProfiles", "documentation": "

A list of the available network profiles.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListOfferingPromotionsRequest": { "type": "structure", "members": { "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListOfferingPromotionsResult": { "type": "structure", "members": { "offeringPromotions": { "shape": "OfferingPromotions", "documentation": "

Information about the offering promotions.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier to be used in the next call to this operation, to return the next set of items in the list.

" } } }, "ListOfferingTransactionsRequest": { "type": "structure", "members": { "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents the request to list the offering transaction history.

" }, "ListOfferingTransactionsResult": { "type": "structure", "members": { "offeringTransactions": { "shape": "OfferingTransactions", "documentation": "

The audit log of subscriptions you have purchased and modified through AWS Device Farm.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Returns the transaction log of the specified offerings.

" }, "ListOfferingsRequest": { "type": "structure", "members": { "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents the request to list all offerings.

" }, "ListOfferingsResult": { "type": "structure", "members": { "offerings": { "shape": "Offerings", "documentation": "

A value that represents the list offering results.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents the return values of the list of offerings.

" }, "ListProjectsRequest": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list projects operation.

" }, "ListProjectsResult": { "type": "structure", "members": { "projects": { "shape": "Projects", "documentation": "

Information about the projects.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list projects request.

" }, "ListRemoteAccessSessionsRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project about which you are requesting information.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents the request to return information about the remote access session.

" }, "ListRemoteAccessSessionsResult": { "type": "structure", "members": { "remoteAccessSessions": { "shape": "RemoteAccessSessions", "documentation": "

A container that represents the metadata from the service about each remote access session you are requesting.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

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

" }, "ListRunsRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project for which you want to list runs.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list runs operation.

" }, "ListRunsResult": { "type": "structure", "members": { "runs": { "shape": "Runs", "documentation": "

Information about the runs.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list runs request.

" }, "ListSamplesRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the job used to list samples.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list samples operation.

" }, "ListSamplesResult": { "type": "structure", "members": { "samples": { "shape": "Samples", "documentation": "

Information about the samples.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list samples request.

" }, "ListSuitesRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The job's Amazon Resource Name (ARN).

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list suites operation.

" }, "ListSuitesResult": { "type": "structure", "members": { "suites": { "shape": "Suites", "documentation": "

Information about the suites.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list suites request.

" }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": { "shape": "DeviceFarmArn", "documentation": "

The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

" } } }, "ListTestGridProjectsRequest": { "type": "structure", "members": { "maxResult": { "shape": "MaxPageSize", "documentation": "

Return no more than this number of results.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

From a response, used to continue a paginated listing.

" } } }, "ListTestGridProjectsResult": { "type": "structure", "members": { "testGridProjects": { "shape": "TestGridProjects", "documentation": "

The list of TestGridProjects, based on a ListTestGridProjectsRequest.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

Used for pagination. Pass into ListTestGridProjects to get more results in a paginated request.

" } } }, "ListTestGridSessionActionsRequest": { "type": "structure", "required": [ "sessionArn" ], "members": { "sessionArn": { "shape": "DeviceFarmArn", "documentation": "

The ARN of the session to retrieve.

" }, "maxResult": { "shape": "MaxPageSize", "documentation": "

The maximum number of sessions to return per response.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

Pagination token.

" } } }, "ListTestGridSessionActionsResult": { "type": "structure", "members": { "actions": { "shape": "TestGridSessionActions", "documentation": "

The action taken by the session.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

Pagination token.

" } } }, "ListTestGridSessionArtifactsRequest": { "type": "structure", "required": [ "sessionArn" ], "members": { "sessionArn": { "shape": "DeviceFarmArn", "documentation": "

The ARN of a TestGridSession.

" }, "type": { "shape": "TestGridSessionArtifactCategory", "documentation": "

Limit results to a specified type of artifact.

" }, "maxResult": { "shape": "MaxPageSize", "documentation": "

The maximum number of results to be returned by a request.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

Pagination token.

" } } }, "ListTestGridSessionArtifactsResult": { "type": "structure", "members": { "artifacts": { "shape": "TestGridSessionArtifacts", "documentation": "

A list of test grid session artifacts for a TestGridSession.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

Pagination token.

" } } }, "ListTestGridSessionsRequest": { "type": "structure", "required": [ "projectArn" ], "members": { "projectArn": { "shape": "DeviceFarmArn", "documentation": "

ARN of a TestGridProject.

" }, "status": { "shape": "TestGridSessionStatus", "documentation": "

Return only sessions in this state.

" }, "creationTimeAfter": { "shape": "DateTime", "documentation": "

Return only sessions created after this time.

" }, "creationTimeBefore": { "shape": "DateTime", "documentation": "

Return only sessions created before this time.

" }, "endTimeAfter": { "shape": "DateTime", "documentation": "

Return only sessions that ended after this time.

" }, "endTimeBefore": { "shape": "DateTime", "documentation": "

Return only sessions that ended before this time.

" }, "maxResult": { "shape": "MaxPageSize", "documentation": "

Return only this many results at a time.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

Pagination token.

" } } }, "ListTestGridSessionsResult": { "type": "structure", "members": { "testGridSessions": { "shape": "TestGridSessions", "documentation": "

The sessions that match the criteria in a ListTestGridSessionsRequest.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

Pagination token.

" } } }, "ListTestsRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The test suite's Amazon Resource Name (ARN).

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list tests operation.

" }, "ListTestsResult": { "type": "structure", "members": { "tests": { "shape": "Tests", "documentation": "

Information about the tests.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list tests request.

" }, "ListUniqueProblemsRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The unique problems' ARNs.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list unique problems operation.

" }, "ListUniqueProblemsResult": { "type": "structure", "members": { "uniqueProblems": { "shape": "UniqueProblemsByExecutionResultMap", "documentation": "

Information about the unique problems.

Allowed values include:

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list unique problems request.

" }, "ListUploadsRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project for which you want to list uploads.

" }, "type": { "shape": "UploadType", "documentation": "

The type of upload.

Must be one of the following values:

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation": "

Represents a request to the list uploads operation.

" }, "ListUploadsResult": { "type": "structure", "members": { "uploads": { "shape": "Uploads", "documentation": "

Information about the uploads.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation": "

Represents the result of a list uploads request.

" }, "ListVPCEConfigurationsRequest": { "type": "structure", "members": { "maxResults": { "shape": "Integer", "documentation": "

An integer that specifies the maximum number of items you want to return in the API response.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListVPCEConfigurationsResult": { "type": "structure", "members": { "vpceConfigurations": { "shape": "VPCEConfigurations", "documentation": "

An array of VPCEConfiguration objects that contain information about your VPC endpoint configuration.

" }, "nextToken": { "shape": "PaginationToken", "documentation": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "Location": { "type": "structure", "required": [ "latitude", "longitude" ], "members": { "latitude": { "shape": "Double", "documentation": "

The latitude.

" }, "longitude": { "shape": "Double", "documentation": "

The longitude.

" } }, "documentation": "

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

Elevation is currently not supported.

" }, "Long": { "type": "long" }, "MaxPageSize": { "type": "integer", "max": 1000, "min": 1 }, "MaxSlotMap": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "Integer" } }, "Message": { "type": "string", "max": 16384, "min": 0 }, "Metadata": { "type": "string", "max": 8192, "min": 0 }, "MonetaryAmount": { "type": "structure", "members": { "amount": { "shape": "Double", "documentation": "

The numerical amount of an offering or transaction.

" }, "currencyCode": { "shape": "CurrencyCode", "documentation": "

The currency code of a monetary amount. For example, USD means U.S. dollars.

" } }, "documentation": "

A number that represents the monetary amount for an offering or transaction.

" }, "Name": { "type": "string", "max": 256, "min": 0 }, "NetworkProfile": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the network profile.

" }, "name": { "shape": "Name", "documentation": "

The name of the network profile.

" }, "description": { "shape": "Message", "documentation": "

The description of the network profile.

" }, "type": { "shape": "NetworkProfileType", "documentation": "

The type of network profile. Valid values are listed here.

" }, "uplinkBandwidthBits": { "shape": "Long", "documentation": "

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" }, "downlinkBandwidthBits": { "shape": "Long", "documentation": "

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" }, "uplinkDelayMs": { "shape": "Long", "documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" }, "downlinkDelayMs": { "shape": "Long", "documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" }, "uplinkJitterMs": { "shape": "Long", "documentation": "

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" }, "downlinkJitterMs": { "shape": "Long", "documentation": "

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" }, "uplinkLossPercent": { "shape": "PercentInteger", "documentation": "

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

" }, "downlinkLossPercent": { "shape": "PercentInteger", "documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" } }, "documentation": "

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

" }, "NetworkProfileType": { "type": "string", "enum": [ "CURATED", "PRIVATE" ] }, "NetworkProfiles": { "type": "list", "member": { "shape": "NetworkProfile" } }, "NonEmptyString": { "type": "string", "max": 4096, "min": 1, "pattern": ".*\\S.*" }, "Offering": { "type": "structure", "members": { "id": { "shape": "OfferingIdentifier", "documentation": "

The ID that corresponds to a device offering.

" }, "description": { "shape": "Message", "documentation": "

A string that describes the offering.

" }, "type": { "shape": "OfferingType", "documentation": "

The type of offering (for example, RECURRING) for a device.

" }, "platform": { "shape": "DevicePlatform", "documentation": "

The platform of the device (for example, ANDROID or IOS).

" }, "recurringCharges": { "shape": "RecurringCharges", "documentation": "

Specifies whether there are recurring charges for the offering.

" } }, "documentation": "

Represents the metadata of a device offering.

" }, "OfferingIdentifier": { "type": "string", "min": 32 }, "OfferingPromotion": { "type": "structure", "members": { "id": { "shape": "OfferingPromotionIdentifier", "documentation": "

The ID of the offering promotion.

" }, "description": { "shape": "Message", "documentation": "

A string that describes the offering promotion.

" } }, "documentation": "

Represents information about an offering promotion.

" }, "OfferingPromotionIdentifier": { "type": "string", "min": 4 }, "OfferingPromotions": { "type": "list", "member": { "shape": "OfferingPromotion" } }, "OfferingStatus": { "type": "structure", "members": { "type": { "shape": "OfferingTransactionType", "documentation": "

The type specified for the offering status.

" }, "offering": { "shape": "Offering", "documentation": "

Represents the metadata of an offering status.

" }, "quantity": { "shape": "Integer", "documentation": "

The number of available devices in the offering.

" }, "effectiveOn": { "shape": "DateTime", "documentation": "

The date on which the offering is effective.

" } }, "documentation": "

The status of the offering.

" }, "OfferingStatusMap": { "type": "map", "key": { "shape": "OfferingIdentifier" }, "value": { "shape": "OfferingStatus" } }, "OfferingTransaction": { "type": "structure", "members": { "offeringStatus": { "shape": "OfferingStatus", "documentation": "

The status of an offering transaction.

" }, "transactionId": { "shape": "TransactionIdentifier", "documentation": "

The transaction ID of the offering transaction.

" }, "offeringPromotionId": { "shape": "OfferingPromotionIdentifier", "documentation": "

The ID that corresponds to a device offering promotion.

" }, "createdOn": { "shape": "DateTime", "documentation": "

The date on which an offering transaction was created.

" }, "cost": { "shape": "MonetaryAmount", "documentation": "

The cost of an offering transaction.

" } }, "documentation": "

Represents the metadata of an offering transaction.

" }, "OfferingTransactionType": { "type": "string", "enum": [ "PURCHASE", "RENEW", "SYSTEM" ] }, "OfferingTransactions": { "type": "list", "member": { "shape": "OfferingTransaction" } }, "OfferingType": { "type": "string", "enum": [ "RECURRING" ] }, "Offerings": { "type": "list", "member": { "shape": "Offering" } }, "PackageIds": { "type": "list", "member": { "shape": "String" } }, "PaginationToken": { "type": "string", "max": 1024, "min": 4 }, "PercentInteger": { "type": "integer", "max": 100, "min": 0 }, "Problem": { "type": "structure", "members": { "run": { "shape": "ProblemDetail", "documentation": "

Information about the associated run.

" }, "job": { "shape": "ProblemDetail", "documentation": "

Information about the associated job.

" }, "suite": { "shape": "ProblemDetail", "documentation": "

Information about the associated suite.

" }, "test": { "shape": "ProblemDetail", "documentation": "

Information about the associated test.

" }, "device": { "shape": "Device", "documentation": "

Information about the associated device.

" }, "result": { "shape": "ExecutionResult", "documentation": "

The problem's result.

Allowed values include:

" }, "message": { "shape": "Message", "documentation": "

A message about the problem's result.

" } }, "documentation": "

Represents a specific warning or failure.

" }, "ProblemDetail": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The problem detail's ARN.

" }, "name": { "shape": "Name", "documentation": "

The problem detail's name.

" } }, "documentation": "

Information about a problem detail.

" }, "Problems": { "type": "list", "member": { "shape": "Problem" } }, "Project": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The project's ARN.

" }, "name": { "shape": "Name", "documentation": "

The project's name.

" }, "defaultJobTimeoutMinutes": { "shape": "JobTimeoutMinutes", "documentation": "

The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.

" }, "created": { "shape": "DateTime", "documentation": "

When the project was created.

" }, "vpcConfig": { "shape": "VpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" } }, "documentation": "

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

" }, "Projects": { "type": "list", "member": { "shape": "Project" } }, "PurchaseOfferingRequest": { "type": "structure", "required": [ "offeringId", "quantity" ], "members": { "offeringId": { "shape": "OfferingIdentifier", "documentation": "

The ID of the offering.

" }, "quantity": { "shape": "Integer", "documentation": "

The number of device slots to purchase in an offering request.

" }, "offeringPromotionId": { "shape": "OfferingPromotionIdentifier", "documentation": "

The ID of the offering promotion to be applied to the purchase.

" } }, "documentation": "

Represents a request for a purchase offering.

" }, "PurchaseOfferingResult": { "type": "structure", "members": { "offeringTransaction": { "shape": "OfferingTransaction", "documentation": "

Represents the offering transaction for the purchase result.

" } }, "documentation": "

The result of the purchase offering (for example, success or failure).

" }, "PurchasedDevicesMap": { "type": "map", "key": { "shape": "DevicePlatform" }, "value": { "shape": "Integer" } }, "Radios": { "type": "structure", "members": { "wifi": { "shape": "Boolean", "documentation": "

True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.

" }, "bluetooth": { "shape": "Boolean", "documentation": "

True if Bluetooth is enabled at the beginning of the test. Otherwise, false.

" }, "nfc": { "shape": "Boolean", "documentation": "

True if NFC is enabled at the beginning of the test. Otherwise, false.

" }, "gps": { "shape": "Boolean", "documentation": "

True if GPS is enabled at the beginning of the test. Otherwise, false.

" } }, "documentation": "

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

" }, "RecurringCharge": { "type": "structure", "members": { "cost": { "shape": "MonetaryAmount", "documentation": "

The cost of the recurring charge.

" }, "frequency": { "shape": "RecurringChargeFrequency", "documentation": "

The frequency in which charges recur.

" } }, "documentation": "

Specifies whether charges for devices are recurring.

" }, "RecurringChargeFrequency": { "type": "string", "enum": [ "MONTHLY" ] }, "RecurringCharges": { "type": "list", "member": { "shape": "RecurringCharge" } }, "RemoteAccessSession": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the remote access session.

" }, "name": { "shape": "Name", "documentation": "

The name of the remote access session.

" }, "created": { "shape": "DateTime", "documentation": "

The date and time the remote access session was created.

" }, "status": { "shape": "ExecutionStatus", "documentation": "

The status of the remote access session. Can be any of the following:

" }, "result": { "shape": "ExecutionResult", "documentation": "

The result of the remote access session. Can be any of the following:

" }, "message": { "shape": "Message", "documentation": "

A message about the remote access session.

" }, "started": { "shape": "DateTime", "documentation": "

The date and time the remote access session was started.

" }, "stopped": { "shape": "DateTime", "documentation": "

The date and time the remote access session was stopped.

" }, "device": { "shape": "Device", "documentation": "

The device (phone or tablet) used in the remote access session.

" }, "instanceArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the instance.

" }, "remoteDebugEnabled": { "shape": "Boolean", "documentation": "

This flag is set to true if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" }, "remoteRecordEnabled": { "shape": "Boolean", "documentation": "

This flag is set to true if remote recording is enabled for the remote access session.

" }, "remoteRecordAppArn": { "shape": "AmazonResourceName", "documentation": "

The ARN for the app to be recorded in the remote access session.

" }, "hostAddress": { "shape": "HostAddress", "documentation": "

IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" }, "clientId": { "shape": "ClientId", "documentation": "

Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" }, "billingMethod": { "shape": "BillingMethod", "documentation": "

The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.

" }, "deviceMinutes": { "shape": "DeviceMinutes", "documentation": "

The number of minutes a device is used in a remote access session (including setup and teardown minutes).

" }, "endpoint": { "shape": "String", "documentation": "

The endpoint for the remote access sesssion.

" }, "deviceUdid": { "shape": "String", "documentation": "

Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" }, "interactionMode": { "shape": "InteractionMode", "documentation": "

The interaction mode of the remote access session. Valid values are:

" }, "skipAppResign": { "shape": "SkipAppResign", "documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" }, "vpcConfig": { "shape": "VpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" } }, "documentation": "

Represents information about the remote access session.

" }, "RemoteAccessSessions": { "type": "list", "member": { "shape": "RemoteAccessSession" } }, "RenewOfferingRequest": { "type": "structure", "required": [ "offeringId", "quantity" ], "members": { "offeringId": { "shape": "OfferingIdentifier", "documentation": "

The ID of a request to renew an offering.

" }, "quantity": { "shape": "Integer", "documentation": "

The quantity requested in an offering renewal.

" } }, "documentation": "

A request that represents an offering renewal.

" }, "RenewOfferingResult": { "type": "structure", "members": { "offeringTransaction": { "shape": "OfferingTransaction", "documentation": "

Represents the status of the offering transaction for the renewal.

" } }, "documentation": "

The result of a renewal offering.

" }, "Resolution": { "type": "structure", "members": { "width": { "shape": "Integer", "documentation": "

The screen resolution's width, expressed in pixels.

" }, "height": { "shape": "Integer", "documentation": "

The screen resolution's height, expressed in pixels.

" } }, "documentation": "

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

" }, "ResourceDescription": { "type": "string", "max": 2048, "min": 1, "pattern": ".*\\S.*" }, "ResourceId": { "type": "string", "max": 128, "min": 1, "pattern": ".*\\S.*" }, "ResourceName": { "type": "string", "max": 64, "min": 1, "pattern": ".*\\S.*" }, "Rule": { "type": "structure", "members": { "attribute": { "shape": "DeviceAttribute", "documentation": "

The rule's stringified attribute. For example, specify the value as \"\\\"abc\\\"\".

The supported operators for each attribute are provided in the following list.

APPIUM_VERSION

The Appium version for the test.

Supported operators: CONTAINS

ARN

The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example.

Supported operators: EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALS

FLEET_TYPE

The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

MANUFACTURER

The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_IN

MODEL

The device model, such as Apple iPad Air 2 or Google Pixel.

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

OS_VERSION

The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

PLATFORM

The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.

" }, "operator": { "shape": "RuleOperator", "documentation": "

Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

" }, "value": { "shape": "String", "documentation": "

The rule's value.

" } }, "documentation": "

Represents a condition for a device pool.

" }, "RuleOperator": { "type": "string", "enum": [ "EQUALS", "LESS_THAN", "LESS_THAN_OR_EQUALS", "GREATER_THAN", "GREATER_THAN_OR_EQUALS", "IN", "NOT_IN", "CONTAINS" ] }, "Rules": { "type": "list", "member": { "shape": "Rule" } }, "Run": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The run's ARN.

" }, "name": { "shape": "Name", "documentation": "

The run's name.

" }, "type": { "shape": "TestType", "documentation": "

The run's type.

Must be one of the following values:

" }, "platform": { "shape": "DevicePlatform", "documentation": "

The run's platform.

Allowed values include:

" }, "created": { "shape": "DateTime", "documentation": "

When the run was created.

" }, "status": { "shape": "ExecutionStatus", "documentation": "

The run's status.

Allowed values include:

" }, "result": { "shape": "ExecutionResult", "documentation": "

The run's result.

Allowed values include:

" }, "started": { "shape": "DateTime", "documentation": "

The run's start time.

" }, "stopped": { "shape": "DateTime", "documentation": "

The run's stop time.

" }, "counters": { "shape": "Counters", "documentation": "

The run's result counters.

" }, "message": { "shape": "Message", "documentation": "

A message about the run's result.

" }, "totalJobs": { "shape": "Integer", "documentation": "

The total number of jobs for the run.

" }, "completedJobs": { "shape": "Integer", "documentation": "

The total number of completed jobs.

" }, "billingMethod": { "shape": "BillingMethod", "documentation": "

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

" }, "deviceMinutes": { "shape": "DeviceMinutes", "documentation": "

Represents the total (metered or unmetered) minutes used by the test run.

" }, "networkProfile": { "shape": "NetworkProfile", "documentation": "

The network profile being used for a test run.

" }, "parsingResultUrl": { "shape": "String", "documentation": "

Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

" }, "resultCode": { "shape": "ExecutionResultCode", "documentation": "

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

" }, "seed": { "shape": "Integer", "documentation": "

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

" }, "appUpload": { "shape": "AmazonResourceName", "documentation": "

An app to upload or that has been uploaded.

" }, "eventCount": { "shape": "Integer", "documentation": "

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

" }, "jobTimeoutMinutes": { "shape": "JobTimeoutMinutes", "documentation": "

The number of minutes the job executes before it times out.

" }, "devicePoolArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the device pool for the run.

" }, "locale": { "shape": "String", "documentation": "

Information about the locale that is used for the run.

" }, "radios": { "shape": "Radios", "documentation": "

Information about the radio states for the run.

" }, "location": { "shape": "Location", "documentation": "

Information about the location that is used for the run.

" }, "customerArtifactPaths": { "shape": "CustomerArtifactPaths", "documentation": "

Output CustomerArtifactPaths object for the test run.

" }, "webUrl": { "shape": "String", "documentation": "

The Device Farm console URL for the recording of the run.

" }, "skipAppResign": { "shape": "SkipAppResign", "documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" }, "testSpecArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the YAML-formatted test specification for the run.

" }, "deviceSelectionResult": { "shape": "DeviceSelectionResult", "documentation": "

The results of a device filter used to select the devices for a test run.

" }, "vpcConfig": { "shape": "VpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" } }, "documentation": "

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

" }, "Runs": { "type": "list", "member": { "shape": "Run" } }, "Sample": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The sample's ARN.

" }, "type": { "shape": "SampleType", "documentation": "

The sample's type.

Must be one of the following values:

" }, "url": { "shape": "URL", "documentation": "

The presigned Amazon S3 URL that can be used with a GET request to download the sample's file.

" } }, "documentation": "

Represents a sample of performance data.

" }, "SampleType": { "type": "string", "enum": [ "CPU", "MEMORY", "THREADS", "RX_RATE", "TX_RATE", "RX", "TX", "NATIVE_FRAMES", "NATIVE_FPS", "NATIVE_MIN_DRAWTIME", "NATIVE_AVG_DRAWTIME", "NATIVE_MAX_DRAWTIME", "OPENGL_FRAMES", "OPENGL_FPS", "OPENGL_MIN_DRAWTIME", "OPENGL_AVG_DRAWTIME", "OPENGL_MAX_DRAWTIME" ] }, "Samples": { "type": "list", "member": { "shape": "Sample" } }, "ScheduleRunConfiguration": { "type": "structure", "members": { "extraDataPackageArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external data for Android or the app's sandbox for iOS.

" }, "networkProfileArn": { "shape": "AmazonResourceName", "documentation": "

Reserved for internal use.

" }, "locale": { "shape": "String", "documentation": "

Information about the locale that is used for the run.

" }, "location": { "shape": "Location", "documentation": "

Information about the location that is used for the run.

" }, "vpceConfigurationArns": { "shape": "AmazonResourceNames", "documentation": "

An array of ARNs for your VPC endpoint configurations.

" }, "customerArtifactPaths": { "shape": "CustomerArtifactPaths", "documentation": "

Input CustomerArtifactPaths object for the scheduled run configuration.

" }, "radios": { "shape": "Radios", "documentation": "

Information about the radio states for the run.

" }, "auxiliaryApps": { "shape": "AmazonResourceNames", "documentation": "

A list of upload ARNs for app packages to be installed with your app.

" }, "billingMethod": { "shape": "BillingMethod", "documentation": "

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have purchased unmetered device slots, you must set this parameter to unmetered to make use of them. Otherwise, your run counts against your metered time.

" } }, "documentation": "

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

" }, "ScheduleRunRequest": { "type": "structure", "required": [ "projectArn", "test" ], "members": { "projectArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the project for the run to be scheduled.

" }, "appArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.

" }, "devicePoolArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the device pool for the run to be scheduled.

" }, "deviceSelectionConfiguration": { "shape": "DeviceSelectionConfiguration", "documentation": "

The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

" }, "name": { "shape": "Name", "documentation": "

The name for the run to be scheduled.

" }, "test": { "shape": "ScheduleRunTest", "documentation": "

Information about the test for the run to be scheduled.

" }, "configuration": { "shape": "ScheduleRunConfiguration", "documentation": "

Information about the settings for the run to be scheduled.

" }, "executionConfiguration": { "shape": "ExecutionConfiguration", "documentation": "

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

" } }, "documentation": "

Represents a request to the schedule run operation.

" }, "ScheduleRunResult": { "type": "structure", "members": { "run": { "shape": "Run", "documentation": "

Information about the scheduled run.

" } }, "documentation": "

Represents the result of a schedule run request.

" }, "ScheduleRunTest": { "type": "structure", "required": [ "type" ], "members": { "type": { "shape": "TestType", "documentation": "

The test's type.

Must be one of the following values:

" }, "testPackageArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the uploaded test to be run.

" }, "testSpecArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the YAML-formatted test specification.

" }, "filter": { "shape": "Filter", "documentation": "

The test's filter.

" }, "parameters": { "shape": "TestParameters", "documentation": "

The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

For all tests:

For Appium tests (all types):

For fuzz tests (Android only):

For Instrumentation:

For XCTest and XCTestUI:

" } }, "documentation": "

Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

" }, "SecurityGroupId": { "type": "string", "max": 4096, "min": 1, "pattern": "^sg-[0-9a-fA-F]{8,}$" }, "SecurityGroupIds": { "type": "list", "member": { "shape": "NonEmptyString" }, "max": 5, "min": 1 }, "SensitiveString": { "type": "string", "sensitive": true }, "SensitiveURL": { "type": "string", "max": 2048, "min": 0, "sensitive": true }, "ServiceDnsName": { "type": "string", "max": 2048, "min": 0 }, "SkipAppResign": { "type": "boolean" }, "SshPublicKey": { "type": "string", "max": 8192, "min": 0 }, "StopJobRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.

" } } }, "StopJobResult": { "type": "structure", "members": { "job": { "shape": "Job", "documentation": "

The job that was stopped.

" } } }, "StopRemoteAccessSessionRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the remote access session to stop.

" } }, "documentation": "

Represents the request to stop the remote access session.

" }, "StopRemoteAccessSessionResult": { "type": "structure", "members": { "remoteAccessSession": { "shape": "RemoteAccessSession", "documentation": "

A container that represents the metadata from the service about the remote access session you are stopping.

" } }, "documentation": "

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

" }, "StopRunRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.

" } }, "documentation": "

Represents the request to stop a specific run.

" }, "StopRunResult": { "type": "structure", "members": { "run": { "shape": "Run", "documentation": "

The run that was stopped.

" } }, "documentation": "

Represents the results of your stop run attempt.

" }, "String": { "type": "string" }, "SubnetId": { "type": "string", "max": 4096, "min": 1, "pattern": "^subnet-[0-9a-fA-F]{8,}$" }, "SubnetIds": { "type": "list", "member": { "shape": "NonEmptyString" }, "max": 8, "min": 1 }, "Suite": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The suite's ARN.

" }, "name": { "shape": "Name", "documentation": "

The suite's name.

" }, "type": { "shape": "TestType", "documentation": "

The suite's type.

Must be one of the following values:

" }, "created": { "shape": "DateTime", "documentation": "

When the suite was created.

" }, "status": { "shape": "ExecutionStatus", "documentation": "

The suite's status.

Allowed values include:

" }, "result": { "shape": "ExecutionResult", "documentation": "

The suite's result.

Allowed values include:

" }, "started": { "shape": "DateTime", "documentation": "

The suite's start time.

" }, "stopped": { "shape": "DateTime", "documentation": "

The suite's stop time.

" }, "counters": { "shape": "Counters", "documentation": "

The suite's result counters.

" }, "message": { "shape": "Message", "documentation": "

A message about the suite's result.

" }, "deviceMinutes": { "shape": "DeviceMinutes", "documentation": "

Represents the total (metered or unmetered) minutes used by the test suite.

" } }, "documentation": "

Represents a collection of one or more tests.

" }, "Suites": { "type": "list", "member": { "shape": "Suite" } }, "Tag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "TagKey", "documentation": "

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

" }, "Value": { "shape": "TagValue", "documentation": "

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor in a tag category (key).

" } }, "documentation": "

The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

" }, "TagKey": { "type": "string", "max": 128, "min": 1 }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 150 }, "TagList": { "type": "list", "member": { "shape": "Tag" }, "max": 150 }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "Tags" ], "members": { "ResourceARN": { "shape": "DeviceFarmArn", "documentation": "

The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

" }, "Tags": { "shape": "TagList", "documentation": "

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256, "min": 0 }, "Test": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The test's ARN.

" }, "name": { "shape": "Name", "documentation": "

The test's name.

" }, "type": { "shape": "TestType", "documentation": "

The test's type.

Must be one of the following values:

" }, "created": { "shape": "DateTime", "documentation": "

When the test was created.

" }, "status": { "shape": "ExecutionStatus", "documentation": "

The test's status.

Allowed values include:

" }, "result": { "shape": "ExecutionResult", "documentation": "

The test's result.

Allowed values include:

" }, "started": { "shape": "DateTime", "documentation": "

The test's start time.

" }, "stopped": { "shape": "DateTime", "documentation": "

The test's stop time.

" }, "counters": { "shape": "Counters", "documentation": "

The test's result counters.

" }, "message": { "shape": "Message", "documentation": "

A message about the test's result.

" }, "deviceMinutes": { "shape": "DeviceMinutes", "documentation": "

Represents the total (metered or unmetered) minutes used by the test.

" } }, "documentation": "

Represents a condition that is evaluated.

" }, "TestGridProject": { "type": "structure", "members": { "arn": { "shape": "DeviceFarmArn", "documentation": "

The ARN for the project.

" }, "name": { "shape": "String", "documentation": "

A human-readable name for the project.

" }, "description": { "shape": "String", "documentation": "

A human-readable description for the project.

" }, "vpcConfig": { "shape": "TestGridVpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" }, "created": { "shape": "DateTime", "documentation": "

When the project was created.

" } }, "documentation": "

A Selenium testing project. Projects are used to collect and collate sessions.

" }, "TestGridProjects": { "type": "list", "member": { "shape": "TestGridProject" } }, "TestGridSession": { "type": "structure", "members": { "arn": { "shape": "DeviceFarmArn", "documentation": "

The ARN of the session.

" }, "status": { "shape": "TestGridSessionStatus", "documentation": "

The state of the session.

" }, "created": { "shape": "DateTime", "documentation": "

The time that the session was started.

" }, "ended": { "shape": "DateTime", "documentation": "

The time the session ended.

" }, "billingMinutes": { "shape": "Double", "documentation": "

The number of billed minutes that were used for this session.

" }, "seleniumProperties": { "shape": "String", "documentation": "

A JSON object of options and parameters passed to the Selenium WebDriver.

" } }, "documentation": "

A TestGridSession is a single instance of a browser launched from the URL provided by a call to CreateTestGridUrl.

" }, "TestGridSessionAction": { "type": "structure", "members": { "action": { "shape": "String", "documentation": "

The action taken by the session.

" }, "started": { "shape": "DateTime", "documentation": "

The time that the session invoked the action.

" }, "duration": { "shape": "Long", "documentation": "

The time, in milliseconds, that the action took to complete in the browser.

" }, "statusCode": { "shape": "String", "documentation": "

HTTP status code returned to the browser when the action was taken.

" }, "requestMethod": { "shape": "String", "documentation": "

HTTP method that the browser used to make the request.

" } }, "documentation": "

An action taken by a TestGridSession browser instance.

" }, "TestGridSessionActions": { "type": "list", "member": { "shape": "TestGridSessionAction" } }, "TestGridSessionArtifact": { "type": "structure", "members": { "filename": { "shape": "String", "documentation": "

The file name of the artifact.

" }, "type": { "shape": "TestGridSessionArtifactType", "documentation": "

The kind of artifact.

" }, "url": { "shape": "SensitiveString", "documentation": "

A semi-stable URL to the content of the object.

" } }, "documentation": "

Artifacts are video and other files that are produced in the process of running a browser in an automated context.

Video elements might be broken up into multiple artifacts as they grow in size during creation.

" }, "TestGridSessionArtifactCategory": { "type": "string", "enum": [ "VIDEO", "LOG" ] }, "TestGridSessionArtifactType": { "type": "string", "enum": [ "UNKNOWN", "VIDEO", "SELENIUM_LOG" ] }, "TestGridSessionArtifacts": { "type": "list", "member": { "shape": "TestGridSessionArtifact" } }, "TestGridSessionStatus": { "type": "string", "enum": [ "ACTIVE", "CLOSED", "ERRORED" ] }, "TestGridSessions": { "type": "list", "member": { "shape": "TestGridSession" } }, "TestGridUrlExpiresInSecondsInput": { "type": "integer", "max": 86400, "min": 60 }, "TestGridVpcConfig": { "type": "structure", "required": [ "securityGroupIds", "subnetIds", "vpcId" ], "members": { "securityGroupIds": { "shape": "SecurityGroupIds", "documentation": "

A list of VPC security group IDs in your Amazon VPC.

" }, "subnetIds": { "shape": "SubnetIds", "documentation": "

A list of VPC subnet IDs in your Amazon VPC.

" }, "vpcId": { "shape": "NonEmptyString", "documentation": "

The ID of the Amazon VPC.

" } }, "documentation": "

The VPC security groups and subnets that are attached to a project.

" }, "TestParameters": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "String" } }, "TestType": { "type": "string", "enum": [ "BUILTIN_FUZZ", "APPIUM_JAVA_JUNIT", "APPIUM_JAVA_TESTNG", "APPIUM_PYTHON", "APPIUM_NODE", "APPIUM_RUBY", "APPIUM_WEB_JAVA_JUNIT", "APPIUM_WEB_JAVA_TESTNG", "APPIUM_WEB_PYTHON", "APPIUM_WEB_NODE", "APPIUM_WEB_RUBY", "INSTRUMENTATION", "XCTEST", "XCTEST_UI" ] }, "Tests": { "type": "list", "member": { "shape": "Test" } }, "TransactionIdentifier": { "type": "string", "min": 32 }, "TrialMinutes": { "type": "structure", "members": { "total": { "shape": "Double", "documentation": "

The total number of free trial minutes that the account started with.

" }, "remaining": { "shape": "Double", "documentation": "

The number of free trial minutes remaining in the account.

" } }, "documentation": "

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

" }, "URL": { "type": "string", "max": 2048, "min": 0 }, "UniqueProblem": { "type": "structure", "members": { "message": { "shape": "Message", "documentation": "

A message about the unique problems' result.

" }, "problems": { "shape": "Problems", "documentation": "

Information about the problems.

" } }, "documentation": "

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

" }, "UniqueProblems": { "type": "list", "member": { "shape": "UniqueProblem" } }, "UniqueProblemsByExecutionResultMap": { "type": "map", "key": { "shape": "ExecutionResult" }, "value": { "shape": "UniqueProblems" } }, "UntagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "TagKeys" ], "members": { "ResourceARN": { "shape": "DeviceFarmArn", "documentation": "

The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

" }, "TagKeys": { "shape": "TagKeyList", "documentation": "

The keys of the tags to be removed.

" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateDeviceInstanceRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the device instance.

" }, "profileArn": { "shape": "AmazonResourceName", "documentation": "

The ARN of the profile that you want to associate with the device instance.

" }, "labels": { "shape": "InstanceLabels", "documentation": "

An array of strings that you want to associate with the device instance.

" } } }, "UpdateDeviceInstanceResult": { "type": "structure", "members": { "deviceInstance": { "shape": "DeviceInstance", "documentation": "

An object that contains information about your device instance.

" } } }, "UpdateDevicePoolRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the Device Farm device pool to update.

" }, "name": { "shape": "Name", "documentation": "

A string that represents the name of the device pool to update.

" }, "description": { "shape": "Message", "documentation": "

A description of the device pool to update.

" }, "rules": { "shape": "Rules", "documentation": "

Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.

" }, "maxDevices": { "shape": "Integer", "documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.

" }, "clearMaxDevices": { "shape": "Boolean", "documentation": "

Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the rules parameter.

If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.

" } }, "documentation": "

Represents a request to the update device pool operation.

" }, "UpdateDevicePoolResult": { "type": "structure", "members": { "devicePool": { "shape": "DevicePool", "documentation": "

The device pool you just updated.

" } }, "documentation": "

Represents the result of an update device pool request.

" }, "UpdateInstanceProfileRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the instance profile.

" }, "name": { "shape": "Name", "documentation": "

The updated name for your instance profile.

" }, "description": { "shape": "Message", "documentation": "

The updated description for your instance profile.

" }, "packageCleanup": { "shape": "Boolean", "documentation": "

The updated choice for whether you want to specify package cleanup. The default value is false for private devices.

" }, "excludeAppPackagesFromCleanup": { "shape": "PackageIds", "documentation": "

An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run is over.

The list of packages is only considered if you set packageCleanup to true.

" }, "rebootAfterUse": { "shape": "Boolean", "documentation": "

The updated choice for whether you want to reboot the device after use. The default value is true.

" } } }, "UpdateInstanceProfileResult": { "type": "structure", "members": { "instanceProfile": { "shape": "InstanceProfile", "documentation": "

An object that contains information about your instance profile.

" } } }, "UpdateNetworkProfileRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.

" }, "name": { "shape": "Name", "documentation": "

The name of the network profile about which you are returning information.

" }, "description": { "shape": "Message", "documentation": "

The description of the network profile about which you are returning information.

" }, "type": { "shape": "NetworkProfileType", "documentation": "

The type of network profile to return information about. Valid values are listed here.

" }, "uplinkBandwidthBits": { "shape": "Long", "documentation": "

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" }, "downlinkBandwidthBits": { "shape": "Long", "documentation": "

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" }, "uplinkDelayMs": { "shape": "Long", "documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" }, "downlinkDelayMs": { "shape": "Long", "documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" }, "uplinkJitterMs": { "shape": "Long", "documentation": "

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" }, "downlinkJitterMs": { "shape": "Long", "documentation": "

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" }, "uplinkLossPercent": { "shape": "PercentInteger", "documentation": "

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

" }, "downlinkLossPercent": { "shape": "PercentInteger", "documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" } } }, "UpdateNetworkProfileResult": { "type": "structure", "members": { "networkProfile": { "shape": "NetworkProfile", "documentation": "

A list of the available network profiles.

" } } }, "UpdateProjectRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the project whose name to update.

" }, "name": { "shape": "Name", "documentation": "

A string that represents the new name of the project that you are updating.

" }, "defaultJobTimeoutMinutes": { "shape": "JobTimeoutMinutes", "documentation": "

The number of minutes a test run in the project executes before it times out.

" }, "vpcConfig": { "shape": "VpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" } }, "documentation": "

Represents a request to the update project operation.

" }, "UpdateProjectResult": { "type": "structure", "members": { "project": { "shape": "Project", "documentation": "

The project to update.

" } }, "documentation": "

Represents the result of an update project request.

" }, "UpdateTestGridProjectRequest": { "type": "structure", "required": [ "projectArn" ], "members": { "projectArn": { "shape": "DeviceFarmArn", "documentation": "

ARN of the project to update.

" }, "name": { "shape": "ResourceName", "documentation": "

Human-readable name for the project.

" }, "description": { "shape": "ResourceDescription", "documentation": "

Human-readable description for the project.

" }, "vpcConfig": { "shape": "TestGridVpcConfig", "documentation": "

The VPC security groups and subnets that are attached to a project.

" } } }, "UpdateTestGridProjectResult": { "type": "structure", "members": { "testGridProject": { "shape": "TestGridProject", "documentation": "

The project, including updated information.

" } } }, "UpdateUploadRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the uploaded test spec.

" }, "name": { "shape": "Name", "documentation": "

The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file name must end with the .yaml or .yml file extension.

" }, "contentType": { "shape": "ContentType", "documentation": "

The upload's content type (for example, application/x-yaml).

" }, "editContent": { "shape": "Boolean", "documentation": "

Set to true if the YAML file has changed and must be updated. Otherwise, set to false.

" } } }, "UpdateUploadResult": { "type": "structure", "members": { "upload": { "shape": "Upload", "documentation": "

A test spec uploaded to Device Farm.

" } } }, "UpdateVPCEConfigurationRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.

" }, "vpceConfigurationName": { "shape": "VPCEConfigurationName", "documentation": "

The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.

" }, "vpceServiceName": { "shape": "VPCEServiceName", "documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

" }, "serviceDnsName": { "shape": "ServiceDnsName", "documentation": "

The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already be in use on the internet.

" }, "vpceConfigurationDescription": { "shape": "VPCEConfigurationDescription", "documentation": "

An optional description that provides details about your VPC endpoint configuration.

" } } }, "UpdateVPCEConfigurationResult": { "type": "structure", "members": { "vpceConfiguration": { "shape": "VPCEConfiguration", "documentation": "

An object that contains information about your VPC endpoint configuration.

" } } }, "Upload": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The upload's ARN.

" }, "name": { "shape": "Name", "documentation": "

The upload's file name.

" }, "created": { "shape": "DateTime", "documentation": "

When the upload was created.

" }, "type": { "shape": "UploadType", "documentation": "

The upload's type.

Must be one of the following values:

" }, "status": { "shape": "UploadStatus", "documentation": "

The upload's status.

Must be one of the following values:

" }, "url": { "shape": "SensitiveURL", "documentation": "

The presigned Amazon S3 URL that was used to store a file using a PUT request.

" }, "metadata": { "shape": "Metadata", "documentation": "

The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.

" }, "contentType": { "shape": "ContentType", "documentation": "

The upload's content type (for example, application/octet-stream).

" }, "message": { "shape": "Message", "documentation": "

A message about the upload's result.

" }, "category": { "shape": "UploadCategory", "documentation": "

The upload's category. Allowed values include:

" } }, "documentation": "

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

" }, "UploadCategory": { "type": "string", "enum": [ "CURATED", "PRIVATE" ] }, "UploadStatus": { "type": "string", "enum": [ "INITIALIZED", "PROCESSING", "SUCCEEDED", "FAILED" ] }, "UploadType": { "type": "string", "enum": [ "ANDROID_APP", "IOS_APP", "WEB_APP", "EXTERNAL_DATA", "APPIUM_JAVA_JUNIT_TEST_PACKAGE", "APPIUM_JAVA_TESTNG_TEST_PACKAGE", "APPIUM_PYTHON_TEST_PACKAGE", "APPIUM_NODE_TEST_PACKAGE", "APPIUM_RUBY_TEST_PACKAGE", "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE", "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE", "APPIUM_WEB_PYTHON_TEST_PACKAGE", "APPIUM_WEB_NODE_TEST_PACKAGE", "APPIUM_WEB_RUBY_TEST_PACKAGE", "CALABASH_TEST_PACKAGE", "INSTRUMENTATION_TEST_PACKAGE", "UIAUTOMATION_TEST_PACKAGE", "UIAUTOMATOR_TEST_PACKAGE", "XCTEST_TEST_PACKAGE", "XCTEST_UI_TEST_PACKAGE", "APPIUM_JAVA_JUNIT_TEST_SPEC", "APPIUM_JAVA_TESTNG_TEST_SPEC", "APPIUM_PYTHON_TEST_SPEC", "APPIUM_NODE_TEST_SPEC", "APPIUM_RUBY_TEST_SPEC", "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC", "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC", "APPIUM_WEB_PYTHON_TEST_SPEC", "APPIUM_WEB_NODE_TEST_SPEC", "APPIUM_WEB_RUBY_TEST_SPEC", "INSTRUMENTATION_TEST_SPEC", "XCTEST_UI_TEST_SPEC" ] }, "Uploads": { "type": "list", "member": { "shape": "Upload" } }, "VPCEConfiguration": { "type": "structure", "members": { "arn": { "shape": "AmazonResourceName", "documentation": "

The Amazon Resource Name (ARN) of the VPC endpoint configuration.

" }, "vpceConfigurationName": { "shape": "VPCEConfigurationName", "documentation": "

The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.

" }, "vpceServiceName": { "shape": "VPCEServiceName", "documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

" }, "serviceDnsName": { "shape": "ServiceDnsName", "documentation": "

The DNS name that maps to the private IP address of the service you want to access.

" }, "vpceConfigurationDescription": { "shape": "VPCEConfigurationDescription", "documentation": "

An optional description that provides details about your VPC endpoint configuration.

" } }, "documentation": "

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

" }, "VPCEConfigurationDescription": { "type": "string", "max": 2048, "min": 0 }, "VPCEConfigurationName": { "type": "string", "max": 1024, "min": 0 }, "VPCEConfigurations": { "type": "list", "member": { "shape": "VPCEConfiguration" } }, "VPCEServiceName": { "type": "string", "max": 2048, "min": 0 }, "VideoCapture": { "type": "boolean" }, "VpcConfig": { "type": "structure", "required": [ "securityGroupIds", "subnetIds", "vpcId" ], "members": { "securityGroupIds": { "shape": "VpcSecurityGroupIds", "documentation": "

An array of one or more security groups IDs in your Amazon VPC.

" }, "subnetIds": { "shape": "VpcSubnetIds", "documentation": "

An array of one or more subnet IDs in your Amazon VPC.

" }, "vpcId": { "shape": "NonEmptyString", "documentation": "

The ID of the Amazon VPC.

" } }, "documentation": "

Contains the VPC configuration data necessary to interface with AWS Device Farm's services.

" }, "VpcSecurityGroupIds": { "type": "list", "member": { "shape": "SecurityGroupId" }, "max": 5, "min": 1 }, "VpcSubnetIds": { "type": "list", "member": { "shape": "SubnetId" }, "max": 8, "min": 1 } }, "documentation": "

Welcome to the AWS Device Farm API documentation, which contains APIs for:

" }