DataZone / Client / update_project_profile

update_project_profile#

DataZone.Client.update_project_profile(**kwargs)#

Updates a project profile.

Request Syntax

response = client.update_project_profile(
    description='string',
    domainIdentifier='string',
    domainUnitIdentifier='string',
    environmentConfigurations=[
        {
            'awsAccount': {
                'awsAccountId': 'string',
                'awsAccountIdPath': 'string'
            },
            'awsRegion': {
                'regionName': 'string',
                'regionNamePath': 'string'
            },
            'configurationParameters': {
                'parameterOverrides': [
                    {
                        'isEditable': True|False,
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'resolvedParameters': [
                    {
                        'isEditable': True|False,
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'ssmPath': 'string'
            },
            'deploymentMode': 'ON_CREATE'|'ON_DEMAND',
            'deploymentOrder': 123,
            'description': 'string',
            'environmentBlueprintId': 'string',
            'id': 'string',
            'name': 'string'
        },
    ],
    identifier='string',
    name='string',
    status='ENABLED'|'DISABLED'
)

Parameters:

description (string) – The description of a project profile.
domainIdentifier (string) –
[REQUIRED]

The ID of the domain where a project profile is to be updated.
domainUnitIdentifier (string) – The ID of the domain unit where a project profile is to be updated.
environmentConfigurations (list) –
The environment configurations of a project profile.
- (dict) –
  
  The configuration of an environment.
  - awsAccount (dict) – [REQUIRED]
    
    The Amazon Web Services account of the environment.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: awsAccountId, awsAccountIdPath.
    - awsAccountId (string) –
      
      The account ID of a project.
    - awsAccountIdPath (string) –
      
      The account ID path of a project.
  - awsRegion (dict) – [REQUIRED]
    
    The Amazon Web Services Region of the environment.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: regionName, regionNamePath.
    - regionName (string) –
      
      The Amazon Web Services Region name.
    - regionNamePath (string) –
      
      The region name path.
  - configurationParameters (dict) –
    
    The configuration parameters of the environment.
    - parameterOverrides (list) –
      
      The parameter overrides.
      - (dict) –
        
        The environment configuration parameter.
        
        isEditable (boolean) –
        
        Specifies whether the environment parameter is editable.
        
        name (string) –
        
        The name of the environment configuration parameter.
        
        value (string) –
        
        The value of the environment configuration parameter.
    - resolvedParameters (list) –
      
      The resolved environment configuration parameters.
      - (dict) –
        
        The environment configuration parameter.
        
        isEditable (boolean) –
        
        Specifies whether the environment parameter is editable.
        
        name (string) –
        
        The name of the environment configuration parameter.
        
        value (string) –
        
        The value of the environment configuration parameter.
    - ssmPath (string) –
      
      Ssm path environment configuration parameters.
  - deploymentMode (string) –
    
    The deployment mode of the environment.
  - deploymentOrder (integer) –
    
    The deployment order of the environment.
  - description (string) –
    
    The environment description.
  - environmentBlueprintId (string) – [REQUIRED]
    
    The environment blueprint ID.
  - id (string) –
    
    The environment ID.
  - name (string) – [REQUIRED]
    
    The environment name.
identifier (string) –
[REQUIRED]

The ID of a project profile that is to be updated.
name (string) – The name of a project profile.
status (string) – The status of a project profile.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'environmentConfigurations': [
        {
            'awsAccount': {
                'awsAccountId': 'string',
                'awsAccountIdPath': 'string'
            },
            'awsRegion': {
                'regionName': 'string',
                'regionNamePath': 'string'
            },
            'configurationParameters': {
                'parameterOverrides': [
                    {
                        'isEditable': True|False,
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'resolvedParameters': [
                    {
                        'isEditable': True|False,
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'ssmPath': 'string'
            },
            'deploymentMode': 'ON_CREATE'|'ON_DEMAND',
            'deploymentOrder': 123,
            'description': 'string',
            'environmentBlueprintId': 'string',
            'id': 'string',
            'name': 'string'
        },
    ],
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'status': 'ENABLED'|'DISABLED'
}

Response Structure

(dict) –
- createdAt (datetime) –
  
  The timestamp at which a project profile is created.
- createdBy (string) –
  
  The user who created a project profile.
- description (string) –
  
  The description of a project profile.
- domainId (string) –
  
  The ID of the domain where project profile is to be updated.
- domainUnitId (string) –
  
  The domain unit ID of the project profile to be updated.
- environmentConfigurations (list) –
  
  The environment configurations of a project profile.
  - (dict) –
    
    The configuration of an environment.
    - awsAccount (dict) –
      
      The Amazon Web Services account of the environment.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: awsAccountId, awsAccountIdPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - awsAccountId (string) –
        
        The account ID of a project.
      - awsAccountIdPath (string) –
        
        The account ID path of a project.
    - awsRegion (dict) –
      
      The Amazon Web Services Region of the environment.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: regionName, regionNamePath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - regionName (string) –
        
        The Amazon Web Services Region name.
      - regionNamePath (string) –
        
        The region name path.
    - configurationParameters (dict) –
      
      The configuration parameters of the environment.
      - parameterOverrides (list) –
        
        The parameter overrides.
        
        (dict) –
        
        The environment configuration parameter.
        
        isEditable (boolean) –
        
        Specifies whether the environment parameter is editable.
        
        name (string) –
        
        The name of the environment configuration parameter.
        
        value (string) –
        
        The value of the environment configuration parameter.
      - resolvedParameters (list) –
        
        The resolved environment configuration parameters.
        
        (dict) –
        
        The environment configuration parameter.
        
        isEditable (boolean) –
        
        Specifies whether the environment parameter is editable.
        
        name (string) –
        
        The name of the environment configuration parameter.
        
        value (string) –
        
        The value of the environment configuration parameter.
      - ssmPath (string) –
        
        Ssm path environment configuration parameters.
    - deploymentMode (string) –
      
      The deployment mode of the environment.
    - deploymentOrder (integer) –
      
      The deployment order of the environment.
    - description (string) –
      
      The environment description.
    - environmentBlueprintId (string) –
      
      The environment blueprint ID.
    - id (string) –
      
      The environment ID.
    - name (string) –
      
      The environment name.
- id (string) –
  
  The ID of the project profile.
- lastUpdatedAt (datetime) –
  
  The timestamp at which a project profile was last updated.
- name (string) –
  
  The name of the project profile.
- status (string) –
  
  The status of the project profile.

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