GlueDataBrew / Client / describe_project

describe_project#

GlueDataBrew.Client.describe_project(**kwargs)#

Returns the definition of a specific DataBrew project.

See also: AWS API Documentation

Request Syntax

response = client.describe_project(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

The name of the project to be described.

Return type:

dict

Returns:

Response Syntax

{
    'CreateDate': datetime(2015, 1, 1),
    'CreatedBy': 'string',
    'DatasetName': 'string',
    'LastModifiedDate': datetime(2015, 1, 1),
    'LastModifiedBy': 'string',
    'Name': 'string',
    'RecipeName': 'string',
    'ResourceArn': 'string',
    'Sample': {
        'Size': 123,
        'Type': 'FIRST_N'|'LAST_N'|'RANDOM'
    },
    'RoleArn': 'string',
    'Tags': {
        'string': 'string'
    },
    'SessionStatus': 'ASSIGNED'|'FAILED'|'INITIALIZING'|'PROVISIONING'|'READY'|'RECYCLING'|'ROTATING'|'TERMINATED'|'TERMINATING'|'UPDATING',
    'OpenedBy': 'string',
    'OpenDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • CreateDate (datetime) –

      The date and time that the project was created.

    • CreatedBy (string) –

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

    • DatasetName (string) –

      The dataset associated with the project.

    • LastModifiedDate (datetime) –

      The date and time that the project was last modified.

    • LastModifiedBy (string) –

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

    • Name (string) –

      The name of the project.

    • RecipeName (string) –

      The recipe associated with this job.

    • ResourceArn (string) –

      The Amazon Resource Name (ARN) of the project.

    • Sample (dict) –

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

      • Size (integer) –

        The number of rows in the sample.

      • Type (string) –

        The way in which DataBrew obtains rows from a dataset.

    • RoleArn (string) –

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

    • Tags (dict) –

      Metadata tags associated with this project.

      • (string) –

        • (string) –

    • SessionStatus (string) –

      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.

    • OpenedBy (string) –

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

    • OpenDate (datetime) –

      The date and time when the project was opened.

Exceptions

  • GlueDataBrew.Client.exceptions.ResourceNotFoundException

  • GlueDataBrew.Client.exceptions.ValidationException