Amazon DataZone

{'domainUnitId': 'string'}

Updates the specified project in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.update_project(
    description='string',
    domainIdentifier='string',
    domainUnitId='string',
    environmentDeploymentDetails={
        'environmentFailureReasons': {
            'string': [
                {
                    'code': 'string',
                    'message': 'string'
                },
            ]
        },
        'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT'
    },
    glossaryTerms=[
        'string',
    ],
    identifier='string',
    name='string',
    projectProfileVersion='string',
    userParameters=[
        {
            'environmentConfigurationName': 'string',
            'environmentId': 'string',
            'environmentParameters': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        },
    ]
)

type description:

string

param description:

The description to be updated as part of the UpdateProject action.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain where a project is being updated.

type domainUnitId:

string

param domainUnitId:

The ID of the domain unit.

type environmentDeploymentDetails:

dict

param environmentDeploymentDetails:

The environment deployment details of the 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) -- [REQUIRED]

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

• overallDeploymentStatus (string) --

  The overall deployment status of the environment.

type glossaryTerms:

list

param glossaryTerms:

The glossary terms to be updated as part of the UpdateProject action.

• (string) --

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the project that is to be updated.

type name:

string

param name:

The name to be updated as part of the UpdateProject action.

type projectProfileVersion:

string

param projectProfileVersion:

The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.

type userParameters:

list

param userParameters:

The user parameters of the 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.

rtype:

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',
    'userParameters': [
        {
            'environmentConfigurationName': 'string',
            'environmentId': 'string',
            'environmentParameters': [
                {
                    'name': 'string',
                    'value': '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 that is to be updated.

  • domainId (string) --

    The identifier of the Amazon DataZone domain in which a project is updated.

  • domainUnitId (string) --

    The ID of the domain unit.

  • environmentDeploymentDetails (dict) --

    The environment deployment details of the 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 glossary terms of the project that are to be updated.

    • (string) --

  • id (string) --

    The identifier of the project that is to be updated.

  • lastUpdatedAt (datetime) --

    The timestamp of when the project was last updated.

  • name (string) --

    The name of the project that is to be updated.

  • projectProfileId (string) --

    The ID of the project profile.

  • projectStatus (string) --

    The status of the project.

  • userParameters (list) --

    The user parameters of the 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.