Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateProject

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

Request Syntax


{
   "arn": "string",
   "defaultJobTimeoutMinutes": number,
   "environmentVariables": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ],
   "executionRoleArn": "string",
   "name": "string",
   "vpcConfig": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ],
      "vpcId": "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.

arn

The Amazon Resource Name (ARN) of the project whose name to update.

Type: String

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

Pattern: ^arn:aws:devicefarm:.+

Required: Yes

defaultJobTimeoutMinutes

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

Type: Integer

Required: No

environmentVariables

A set of environment variables which are used by default for all runs in the project. These environment variables are applied to the test run during the execution of a test spec file.

For more information about using test spec files, please see Custom test environments in AWS Device Farm.

Type: Array of EnvironmentVariable objects

Array Members: Minimum number of 1 item. Maximum number of 32 items.

Required: No

executionRoleArn

An IAM role to be assumed by the test host for all runs in the project.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:iam::[0-9]{12}:role/.+

Required: No

name

A string that represents the new name of the project that you are updating.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

vpcConfig

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

Type: VpcConfig object

Required: No

Response Syntax


{
   "project": { 
      "arn": "string",
      "created": number,
      "defaultJobTimeoutMinutes": number,
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "executionRoleArn": "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.

project

The project to update.

Type: Project object

Errors

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

ArgumentException

An invalid argument was specified.

message: Any additional information about the exception.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

message: Any additional information about the exception.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

message: Any additional information about the exception.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

message: Any additional information about the exception.

HTTP Status Code: 400