ListOﬀeringTransactions

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 ﬁrst). 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 [email protected].

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.

nextToken (p. 131)

An identiﬁer 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

{ "nextToken": "string", "offeringTransactions": [ {

"offeringPromotionId": "string", "offeringStatus": {

"type": "string"

"quantity": number, "type": "string"

"transactionId": "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 (p. 131)

An identiﬁer 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.

oﬀeringTransactions (p. 131)

The audit log of subscriptions you have purchased and modiﬁed through AWS Device Farm.

Type: Array of OﬀeringTransaction (p. 278) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

HTTP Status Code: 400 LimitExceededException

A limit was exceeded.

HTTP Status Code: 400 NotEligibleException

Exception gets thrown when a user is not eligible to perform the speciﬁed transaction.

HTTP Status Code: 400 NotFoundException

The speciﬁed entity was not found.

HTTP Status Code: 400 ServiceAccountException

There was a problem with the service account.

API Version 2015-06-23 132

Examples

HTTP Status Code: 400

Examples

Example

The following example response contains all the transactions that the customer has made.

Sample Response

{ "offeringTransactions": [ {

Examples

"quantity": 1

Examples

For more information about using this API in one of the language-speciﬁc 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 138

ListProjects

Gets information about projects.

Request Syntax

{ "arn": "string", "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. 139)

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No nextToken (p. 139)

An identiﬁer 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

{

"nextToken": "string", "projects": [

{

"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.

nextToken (p. 139)

If the number of items that are returned is signiﬁcantly large, this is an identiﬁer 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.

projects (p. 139)

Information about the projects.

Type: Array of Project (p. 282) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

HTTP Status Code: 400 LimitExceededException

A limit was exceeded.

HTTP Status Code: 400 NotFoundException

The speciﬁed entity was not found.

HTTP Status Code: 400 ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

ListRemoteAccessSessions

Returns a list of all currently running remote access sessions.

Request Syntax

{ "arn": "string", "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. 142)

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes nextToken (p. 142)

An identiﬁer 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

{

"nextToken": "string", "remoteAccessSessions": [ {

Response Syntax

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 (p. 142)

An identiﬁer 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.

remoteAccessSessions (p. 142)

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

Type: Array of RemoteAccessSession (p. 285) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

HTTP Status Code: 400 LimitExceededException

A limit was exceeded.

HTTP Status Code: 400 NotFoundException

The speciﬁed entity was not found.

HTTP Status Code: 400 ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

ListRuns

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

Request Syntax

{

"arn": "string", "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. 146)

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes nextToken (p. 146)

An identiﬁer 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

{ "nextToken": "string", "runs": [

{

"appUpload": "string", "arn": "string",

"billingMethod": "string", "completedJobs": number, "counters": {

"errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number,

API Version 2015-06-23 146

Response Syntax

"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.

nextToken (p. 146)

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

runs (p. 146)

Information about the runs.

Type: Array of Run (p. 294) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

HTTP Status Code: 400 LimitExceededException

A limit was exceeded.

HTTP Status Code: 400 NotFoundException

The speciﬁed entity was not found.

HTTP Status Code: 400 ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

ListSamples

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

Request Syntax

{ "arn": "string", "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. 150)

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes nextToken (p. 150)

An identiﬁer 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

{ "nextToken": "string", "samples": [

{

"arn": "string", "type": "string", "url": "string"

} ]}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

API Version 2015-06-23 150

Errors

The following data is returned in JSON format by the service.

nextToken (p. 150)

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

samples (p. 150)

Information about the samples.

Type: Array of Sample (p. 300) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

HTTP Status Code: 400 LimitExceededException

A limit was exceeded.

HTTP Status Code: 400 NotFoundException

The speciﬁed entity was not found.

HTTP Status Code: 400 ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

Request Syntax

{ "arn": "string", "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. 153)

The job's Amazon Resource Name (ARN).

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes nextToken (p. 153)

An identiﬁer 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

{

"nextToken": "string", "suites": [

{

"arn": "string", "counters": {

"errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number

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 (p. 153)

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

suites (p. 153)

Information about the suites.

Type: Array of Suite (p. 307) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

HTTP Status Code: 400 LimitExceededException

A limit was exceeded.

HTTP Status Code: 400 NotFoundException

The speciﬁed entity was not found.

HTTP Status Code: 400

API Version 2015-06-23 154

ListTagsForResource

List the tags for an AWS Device Farm resource.

Request Syntax

{ "ResourceARN": "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.

ResourceARN (p. 156)

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.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:aws:devicefarm:.+

Required: Yes

Response Syntax

{ "Tags": [ {

"Key": "string", "Value": "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.

Tags (p. 156)

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.

Type: Array of Tag (p. 310) objects

API Version 2015-06-23 156

Errors

Array Members: Maximum number of 150 items.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

HTTP Status Code: 400 NotFoundException

The speciﬁed entity was not found.

HTTP Status Code: 400 TagOperationException

The operation was not successful. Try again.

HTTP Status Code: 400

ListTestGridProjects

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

Request Syntax

{ "maxResult": 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.

maxResult (p. 158)

Return no more than this number of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No nextToken (p. 158)

From a response, used to continue a paginated listing.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Required: No

Response Syntax

{

"nextToken": "string", "testGridProjects": [ {

"arn": "string", "created": number, "description": "string", "name": "string", "vpcConfig": {

"securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string"

} } ]}

API Version 2015-06-23 158

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 (p. 158)

Used for pagination. Pass into ListTestGridProjects (p. 158) to get more results in a paginated request.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

testGridProjects (p. 158)

The list of TestGridProjects, based on a ListTestGridProjectsRequest (p. 267).

Type: Array of TestGridProject (p. 314) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 329).

ArgumentException

An invalid argument was speciﬁed.

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

ListTestGridSessionActions

Returns a list of the actions taken in a TestGridSession (p. 315).

Request Syntax

{ "maxResult": number, "nextToken": "string", "sessionArn": "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.

maxResult (p. 160)

The maximum number of sessions to return per response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No nextToken (p. 160)

Pagination token.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Required: No sessionArn (p. 160)

The ARN of the session to retrieve.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:aws:devicefarm:.+

Required: Yes

Response Syntax

{ "actions": [ {

"action": "string",

API Version 2015-06-23 160

Response Elements

"duration": number, "requestMethod": "string", "started": number,

"statusCode": "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.

actions (p. 160)

The action taken by the session.

Type: Array of TestGridSessionAction (p. 317) objects nextToken (p. 160)

Pagination token.

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 speciﬁed.

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 speciﬁed entity was not found.

HTTP Status Code: 400

Request Syntax

{ "maxResult": number, "nextToken": "string", "sessionArn": "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.

maxResult (p. 163)

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No nextToken (p. 163)

Pagination token.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Required: No sessionArn (p. 163)

The ARN of a TestGridSession (p. 315).

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:aws:devicefarm:.+

Required: Yes type (p. 163)

Limit results to a speciﬁed type of artifact.

Type: String

Valid Values: VIDEO | LOG Required: No

Response Syntax

{

"artifacts": [ {

"filename": "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. 164)

A list of test grid session artifacts for a TestGridSession (p. 315).

Type: Array of TestGridSessionArtifact (p. 318) objects nextToken (p. 164)

Pagination token.

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 speciﬁed.

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 speciﬁed entity was not found.

HTTP Status Code: 400

ListOﬀeringTransactions