GetProjectCommand

Suggest an Edit

Gets information about a project.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DeviceFarmClient, GetProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import
// const { DeviceFarmClient, GetProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import
const client = new DeviceFarmClient(config);
const input = { // GetProjectRequest
  arn: "STRING_VALUE", // required
};
const command = new GetProjectCommand(input);
const response = await client.send(command);
// { // GetProjectResult
//   project: { // Project
//     arn: "STRING_VALUE",
//     name: "STRING_VALUE",
//     defaultJobTimeoutMinutes: Number("int"),
//     created: new Date("TIMESTAMP"),
//     vpcConfig: { // VpcConfig
//       securityGroupIds: [ // VpcSecurityGroupIds // required
//         "STRING_VALUE",
//       ],
//       subnetIds: [ // VpcSubnetIds // required
//         "STRING_VALUE",
//       ],
//       vpcId: "STRING_VALUE", // required
//     },
//   },
// };

Example Usage

 Loading code editorLoading code editor

GetProjectCommand Input

See GetProjectCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

The project's ARN.

GetProjectCommand Output

See GetProjectCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
project
Project | undefined

The project to get information about.

Throws

Name
Fault
Details
ArgumentException
client

An invalid argument was specified.

LimitExceededException
client

A limit was exceeded.

NotFoundException
client

The specified entity was not found.

ServiceAccountException
client

There was a problem with the service account.

DeviceFarmServiceException
Base exception class for all service exceptions from DeviceFarm service.