Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
Request Syntax
{
"arn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 327).
The request accepts the following data in JSON format.
arn (p. 98)
The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes
Response Syntax
{
"vpceConfiguration": { "arn": "string",
"serviceDnsName": "string",
"vpceConfigurationDescription": "string", "vpceConfigurationName": "string",
"vpceServiceName": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
vpceConfiguration (p. 98)
An object that contains information about your VPC endpoint configuration.
Type: VPCEConfiguration (p. 325) object
API Version 2015-06-23 98
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 329).
ArgumentException
An invalid argument was specified.
HTTP Status Code: 400 NotFoundException
The specified entity was not found.
HTTP Status Code: 400 ServiceAccountException
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
InstallToRemoteAccessSession
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.
Request Syntax
{ "appArn": "string",
"remoteAccessSessionArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 327).
The request accepts the following data in JSON format.
appArn (p. 100)
The ARN of the app about which you are requesting information.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes
remoteAccessSessionArn (p. 100)
The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes
Response Syntax
{
"appUpload": { "arn": "string", "category": "string", "contentType": "string", "created": number, "message": "string", "metadata": "string", "name": "string", "status": "string", "type": "string",
API Version 2015-06-23 100
Response Elements
"url": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
appUpload (p. 100)
An app to upload or that has been uploaded.
Type: Upload (p. 322) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 329).
ArgumentException
An invalid argument was specified.
HTTP Status Code: 400 LimitExceededException
A limit was exceeded.
HTTP Status Code: 400 NotFoundException
The specified entity was not found.
HTTP Status Code: 400 ServiceAccountException
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2015-06-23 102
ListArtifacts
ListArtifacts
Gets information about artifacts.
Request Syntax
{
"arn": "string", "nextToken": "string", "type": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 327).
The request accepts the following data in JSON format.
arn (p. 103)
The run, job, suite, or test ARN.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes nextToken (p. 103)
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Required: No type (p. 103)
The artifacts' type.
Allowed values include:
• FILE
• LOG
• SCREENSHOT Type: String
Valid Values: SCREENSHOT | FILE | LOG Required: Yes
Response Syntax
{ "artifacts": [ {
"arn": "string", "extension": "string", "name": "string", "type": "string", "url": "string"
} ],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
artifacts (p. 104)
Information about the artifacts.
Type: Array of Artifact (p. 236) objects nextToken (p. 104)
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 329).
ArgumentException
An invalid argument was specified.
HTTP Status Code: 400 LimitExceededException
A limit was exceeded.
HTTP Status Code: 400 NotFoundException
The specified entity was not found.
HTTP Status Code: 400
API Version 2015-06-23 104
See Also
ServiceAccountException
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListDeviceInstances
Returns information about the private device instances associated with one or more AWS accounts.
Request Syntax
{ "maxResults": number, "nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 327).
The request accepts the following data in JSON format.
maxResults (p. 106)
An integer that specifies the maximum number of items you want to return in the API response.
Type: Integer Required: No nextToken (p. 106)
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Required: No
Response Syntax
{
"deviceInstances": [ {
Response Elements
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
deviceInstances (p. 106)
An object that contains information about your device instances.
Type: Array of DeviceInstance (p. 250) objects nextToken (p. 106)
An identifier that can be used in the next call to this operation to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 329).
ArgumentException
An invalid argument was specified.
HTTP Status Code: 400 LimitExceededException
A limit was exceeded.
HTTP Status Code: 400 NotFoundException
The specified entity was not found.
HTTP Status Code: 400 ServiceAccountException
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2015-06-23 108
ListDevicePools
ListDevicePools
Gets information about device pools.
Request Syntax
{
"arn": "string", "nextToken": "string", "type": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 327).
The request accepts the following data in JSON format.
arn (p. 109)
The project ARN.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes nextToken (p. 109)
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Required: No type (p. 109)
The device pools' type.
Allowed values include:
• CURATED: A device pool that is created and managed by AWS Device Farm.
• PRIVATE: A device pool that is created and managed by the device pool developer.
Type: String
Valid Values: CURATED | PRIVATE Required: No
Response Syntax
{
"devicePools": [
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
devicePools (p. 109)
Information about the device pools.
Type: Array of DevicePool (p. 253) objects nextToken (p. 109)
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 329).
ArgumentException
An invalid argument was specified.
HTTP Status Code: 400 LimitExceededException
A limit was exceeded.
HTTP Status Code: 400 NotFoundException
The specified entity was not found.
HTTP Status Code: 400
API Version 2015-06-23 110
See Also
ServiceAccountException
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListDevices
Gets information about unique device types.
Request Syntax
"nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 327).
The request accepts the following data in JSON format.
arn (p. 112)
The Amazon Resource Name (ARN) of the project.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: No filters (p. 112)
Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
• Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.
Allowed values include:
• ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
• PLATFORM: The device platform. Valid values are ANDROID or IOS.
• OS_VERSION: The operating system version (for example, 10.3.2).
• MODEL: The device model (for example, iPad 5th Gen).
• AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
• FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
• MANUFACTURER: The device manufacturer (for example, Apple).
• REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
API Version 2015-06-23 112
Response Syntax
• REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.
• INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
• INSTANCE_LABELS: The label of the device instance.
• FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
• Operator: The filter operator.
• The EQUALS operator is available for every attribute except INSTANCE_LABELS.
• The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
• The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
• The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
• Values: An array of one or more filter values.
• The IN and NOT_IN operators take a values array that has one or more elements.
• The other operators require an array with a single element.
• In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Type: Array of DeviceFilter (p. 247) objects Required: No
nextToken (p. 112)
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Required: No
"description": "string",
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
devices (p. 113)
Information about the devices.
Type: Array of Device (p. 243) objects nextToken (p. 113)
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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 329).
ArgumentException
An invalid argument was specified.
HTTP Status Code: 400
API Version 2015-06-23 114
See Also
LimitExceededException A limit was exceeded.
HTTP Status Code: 400 NotFoundException
The specified entity was not found.
HTTP Status Code: 400 ServiceAccountException
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3