DataZone / Client / get_project

get_project

DataZone.Client.get_project(**kwargs)

Gets a project in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.get_project(
    domainIdentifier='string',
    identifier='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone domain in which the project exists.

  • identifier (string) –

    [REQUIRED]

    The ID of the project.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'environmentDeploymentDetails': {
        'environmentFailureReasons': {
            'string': [
                {
                    'code': 'string',
                    'message': 'string'
                },
            ]
        },
        'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT'
    },
    'failureReasons': [
        {
            'code': 'string',
            'message': 'string'
        },
    ],
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'projectProfileId': 'string',
    'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
    'userParameters': [
        {
            'environmentConfigurationName': 'string',
            'environmentId': 'string',
            'environmentParameters': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'environmentResolvedAccount': {
                'awsAccountId': 'string',
                'regionName': 'string',
                'sourceAccountPoolId': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • createdAt (datetime) –

      The timestamp of when the project was created.

    • createdBy (string) –

      The Amazon DataZone user who created the project.

    • description (string) –

      The description of the project.

    • domainId (string) –

      The ID of the Amazon DataZone domain in which the project exists.

    • domainUnitId (string) –

      The ID of the domain unit.

    • environmentDeploymentDetails (dict) –

      The environment deployment status of a project.

      • environmentFailureReasons (dict) –

        Environment failure reasons.

        • (string) –

          • (list) –

            • (dict) –

              The failure reasons for the environment deployment.

              • code (string) –

                The error code for the failure reason for the environment deployment.

              • message (string) –

                The error message for the failure reason for the environment deployment.

      • overallDeploymentStatus (string) –

        The overall deployment status of the environment.

    • failureReasons (list) –

      Specifies the error message that is returned if the operation cannot be successfully completed.

      • (dict) –

        Specifies the error message that is returned if the operation cannot be successfully completed.

        • code (string) –

          The code of the project deletion error.

        • message (string) –

          The message of the project deletion error.

    • glossaryTerms (list) –

      The business glossary terms that can be used in the project.

      • (string) –

    • id (string) –

      >The ID of the project.

    • lastUpdatedAt (datetime) –

      The timestamp of when the project was last updated.

    • name (string) –

      The name of the project.

    • projectProfileId (string) –

      The ID of the project profile of a project.

    • projectStatus (string) –

      The status of the project.

    • userParameters (list) –

      The user parameters of a project.

      • (dict) –

        The environment configuration user parameters.

        • environmentConfigurationName (string) –

          The environment configuration name.

        • environmentId (string) –

          The ID of the environment.

        • environmentParameters (list) –

          The environment parameters.

          • (dict) –

            The parameter details of an evironment profile.

            • name (string) –

              The name of an environment profile parameter.

            • value (string) –

              The value of an environment profile parameter.

        • environmentResolvedAccount (dict) –

          Specifies the account/Region that is to be used during project creation for a particular blueprint.

          • awsAccountId (string) –

            The ID of the resolved account.

          • regionName (string) –

            The name of the resolved Region.

          • sourceAccountPoolId (string) –

            The ID of the account pool.

Exceptions