ListTestGridSessions
Retrieves a list of sessions for a TestGridProject.
Request Syntax
{
"creationTimeAfter": number
,
"creationTimeBefore": number
,
"endTimeAfter": number
,
"endTimeBefore": number
,
"maxResult": number
,
"nextToken": "string
",
"projectArn": "string
",
"status": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- creationTimeAfter
-
Return only sessions created after this time.
Type: Timestamp
Required: No
- creationTimeBefore
-
Return only sessions created before this time.
Type: Timestamp
Required: No
- endTimeAfter
-
Return only sessions that ended after this time.
Type: Timestamp
Required: No
- endTimeBefore
-
Return only sessions that ended before this time.
Type: Timestamp
Required: No
- maxResult
-
Return only this many results at a time.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- nextToken
-
Pagination token.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Required: No
- projectArn
-
ARN of a TestGridProject.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern:
^arn:aws:devicefarm:.+
Required: Yes
- status
-
Return only sessions in this state.
Type: String
Valid Values:
ACTIVE | CLOSED | ERRORED
Required: No
Response Syntax
{
"nextToken": "string",
"testGridSessions": [
{
"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.
- nextToken
-
Pagination token.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
- testGridSessions
-
The sessions that match the criteria in a ListTestGridSessionsRequest.
Type: Array of TestGridSession objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ArgumentException
-
An invalid argument was specified.
HTTP Status Code: 400
- InternalServiceException
-
An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com
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: