DataZone / Client / update_project

update_project¶

DataZone.Client.update_project(**kwargs)¶

Updates the specified project in Amazon DataZone.

Request Syntax

response = 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'
                },
            ],
            'environmentResolvedAccount': {
                'awsAccountId': 'string',
                'regionName': 'string',
                'sourceAccountPoolId': 'string'
            }
        },
    ]
)

Parameters:

description (string) – The description to be updated as part of the UpdateProject action.
domainIdentifier (string) –
[REQUIRED]

The ID of the Amazon DataZone domain where a project is being 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) – [REQUIRED]
        
        The error message for the failure reason for the environment deployment.
- overallDeploymentStatus (string) –
  
  The overall deployment status of the environment.
glossaryTerms (list) –
The glossary terms to be updated as part of the UpdateProject action.
- (string) –
identifier (string) –
[REQUIRED]

The identifier of the project that is to be updated.
name (string) – The name to be updated as part of the UpdateProject action.
projectProfileVersion (string) – The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.
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.
  - environmentResolvedAccount (dict) –
    
    Specifies the account/Region that is to be used during project creation for a particular blueprint.
    - awsAccountId (string) – [REQUIRED]
      
      The ID of the resolved account.
    - regionName (string) – [REQUIRED]
      
      The name of the resolved Region.
    - sourceAccountPoolId (string) –
      
      The ID of the account pool.

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 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.
    - 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

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ServiceQuotaExceededException
DataZone.Client.exceptions.ConflictException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException