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 76
GetProject
GetProject
Gets information about a project.
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. 77)
The project's ARN.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes
Response Syntax
{ "project": { "arn": "string", "created": number,
"defaultJobTimeoutMinutes": number, "name": "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.
project (p. 77)
The project to get information about.
Type: Project (p. 282) 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 78
GetRemoteAccessSession
GetRemoteAccessSession
Returns a link to a currently running remote access session.
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. 79)
The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes
Response Syntax
{
"remoteAccessSession": { "arn": "string",
"billingMethod": "string", "clientId": "string",
"deviceArn": "string",
"deviceUdid": "string", "endpoint": "string", "hostAddress": "string", "instanceArn": "string", "interactionMode": "string", "message": "string",
"name": "string",
"remoteDebugEnabled": boolean, "remoteRecordAppArn": "string", "remoteRecordEnabled": boolean, "result": "string",
"skipAppResign": boolean, "started": number, "status": "string", "stopped": number }}
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.
remoteAccessSession (p. 79)
A container that lists detailed information about the remote access session.
Type: RemoteAccessSession (p. 285) object
API Version 2015-06-23 80
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 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
GetRun
Gets information about a run.
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. 82)
The run's ARN.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
"billingMethod": "string", "completedJobs": number,
Response Elements
"unmetered": number },
"devicePoolArn": "string", "deviceSelectionResult": {
"jobTimeoutMinutes": number, "locale": "string",
"parsingResultUrl": "string", "platform": "string", "resultCode": "string", "seed": number,
"skipAppResign": boolean, "started": number, "status": "string", "stopped": number, "testSpecArn": "string", "totalJobs": number, "type": "string", "webUrl": "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.
run (p. 82)
The run to get results from.
Type: Run (p. 294) 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 84
GetSuite
GetSuite
Gets information about a suite.
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. 85)
The suite's ARN.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
}
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.
suite (p. 85)
A collection of one or more tests.
Type: Suite (p. 307) 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 86
See Also
GetTest
Gets information about a test.
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. 88)
The test's ARN.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Response Elements
}
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.
test (p. 88)
A test condition that is evaluated.
Type: Test (p. 311) 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 90
GetTestGridProject
GetTestGridProject
Retrieves information about a Selenium testing project.
Request Syntax
{ "projectArn": "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.
projectArn (p. 91)
The ARN of the Selenium testing project, from either CreateTestGridProject (p. 21) or ListTestGridProjects (p. 158).
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:aws:devicefarm:.+
Required: Yes
Response Syntax
{ "testGridProject": { "arn": "string", "created": number, "description": "string", "name": "string", "vpcConfig": {
"securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "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.
testGridProject (p. 91) A TestGridProject (p. 314).
Type: TestGridProject (p. 314) 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 InternalServiceException
An internal exception was raised in the service. Contact [email protected] if you see this error.
HTTP Status Code: 500 NotFoundException
The specified entity was not found.
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 92
GetTestGridSession
GetTestGridSession
A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrl:url (p. 25). You can use the following to look up sessions:
• The session ARN (GetTestGridSession:sessionArn (p. 93)).
• The project ARN and a session ID (GetTestGridSession:projectArn (p. 93) and GetTestGridSession:sessionId (p. 93)).
Request Syntax
{ "projectArn": "string", "sessionArn": "string", "sessionId": "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.
projectArn (p. 93)
The ARN for the project that this session belongs to. See CreateTestGridProject (p. 21) and ListTestGridProjects (p. 158).
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:aws:devicefarm:.+
Required: No sessionArn (p. 93)
An ARN that uniquely identifies a TestGridSession (p. 315).
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:aws:devicefarm:.+
Required: No sessionId (p. 93)
An ID associated with this session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: No
Response Syntax
{
"testGridSession": { "arn": "string",
"billingMinutes": number, "created": number, "ended": number,
"seleniumProperties": "string", "status": "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.
testGridSession (p. 94)
The TestGridSession (p. 315) that was requested.
Type: TestGridSession (p. 315) 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 InternalServiceException
An internal exception was raised in the service. Contact [email protected] if you see this error.
HTTP Status Code: 500 NotFoundException
The specified entity was not found.
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
API Version 2015-06-23 94
See Also
• 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
GetUpload
Gets information about an upload.
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. 96)
The upload's ARN.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern: ^arn:.+
Required: Yes
Response Syntax
{ "upload": { "arn": "string", "category": "string", "contentType": "string", "created": number, "message": "string", "metadata": "string", "name": "string", "status": "string", "type": "string", "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.
upload (p. 96)
An app or a set of one or more tests to upload or that have been uploaded.
API Version 2015-06-23 96
Errors
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