DescribeProject - AWS Glue DataBrew
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DescribeProject

Returns the definition of a specific DataBrew project.

Request Syntax

GET /projects/name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the project to be described.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "CreateDate": number,
   "CreatedBy": "string",
   "DatasetName": "string",
   "LastModifiedBy": "string",
   "LastModifiedDate": number,
   "Name": "string",
   "OpenDate": number,
   "OpenedBy": "string",
   "RecipeName": "string",
   "ResourceArn": "string",
   "RoleArn": "string",
   "Sample": { 
      "Size": number,
      "Type": "string"
   },
   "SessionStatus": "string",
   "Tags": { 
      "string" : "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.

Name

The name of the project.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

CreateDate

The date and time that the project was created.

Type: Timestamp

CreatedBy

The identifier (user name) of the user who created the project.

Type: String

DatasetName

The dataset associated with the project.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

LastModifiedBy

The identifier (user name) of the user who last modified the project.

Type: String

LastModifiedDate

The date and time that the project was last modified.

Type: Timestamp

OpenDate

The date and time when the project was opened.

Type: Timestamp

OpenedBy

The identifier (user name) of the user that opened the project for use.

Type: String

RecipeName

The recipe associated with this job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

ResourceArn

The Amazon Resource Name (ARN) of the project.

Type: String

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

RoleArn

The ARN of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Type: String

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

Sample

Represents the sample size and sampling type for DataBrew to use for interactive data analysis.

Type: Sample object

SessionStatus

Describes the current state of the session:

  • PROVISIONING - allocating resources for the session.

  • INITIALIZING - getting the session ready for first use.

  • ASSIGNED - the session is ready for use.

Type: String

Valid Values: ASSIGNED | FAILED | INITIALIZING | PROVISIONING | READY | RECYCLING | ROTATING | TERMINATED | TERMINATING | UPDATING

Tags

Metadata tags associated with this project.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Errors

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

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: