AWS API Changes

2025/08/13 - Amazon DataZone - 6 new 6 updated api methods

Changes Adds support for account pools and project profile account decoupling

DeleteAccountPool (new)

Deletes an account pool.

Request Syntax

client.delete_account_pool(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where the account pool is deleted.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the account pool to be deleted.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetAccountPool (new)

Link ¶

Gets the details of the account pool.

See also: AWS API Documentation

Request Syntax

client.get_account_pool(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain in which the account pool lives whose details are to be displayed.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the account pool whose details are to be displayed.

rtype:

dict

returns:

Response Syntax

{
    'accountSource': {
        'accounts': [
            {
                'awsAccountId': 'string',
                'awsAccountName': 'string',
                'supportedRegions': [
                    'string',
                ]
            },
        ],
        'customAccountPoolHandler': {
            'lambdaExecutionRoleArn': 'string',
            'lambdaFunctionArn': 'string'
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'resolutionStrategy': 'MANUAL',
    'updatedBy': 'string'
}

Response Structure

(dict) --
- accountSource (dict) --
  
  The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: accounts, customAccountPoolHandler. 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'}
```
  - accounts (list) --
    
    The static list of accounts within an account pool.
    - (dict) --
      
      The account information within an account pool.
      - awsAccountId (string) --
        
        The account ID.
      - awsAccountName (string) --
        
        The account name.
      - supportedRegions (list) --
        
        The regions supported for an account within an account pool.
        
        (string) --
  - customAccountPoolHandler (dict) --
    
    The custom Amazon Web Services Lambda handler within an account pool.
    - lambdaExecutionRoleArn (string) --
      
      The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.
    - lambdaFunctionArn (string) --
      
      The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.
- createdAt (datetime) --
  
  The timestamp at which the account pool was created.
- createdBy (string) --
  
  The user who created the account pool.
- description (string) --
  
  The description of the account pool.
- domainId (string) --
  
  The ID of the domain in which the account pool lives whose details are to be displayed.
- domainUnitId (string) --
  
  The domain unit ID of the account pool.
- id (string) --
  
  The ID of the account pool.
- lastUpdatedAt (datetime) --
  
  The timestamp at which the account pool was last updated.
- name (string) --
  
  The name of the account pool.
- resolutionStrategy (string) --
  
  The mechanism used to resolve the account selection from the account pool.
- updatedBy (string) --
  
  The user who last updated the account pool.

UpdateAccountPool (new)

Link ¶

Updates the account pool.

See also: AWS API Documentation

Request Syntax

client.update_account_pool(
    accountSource={
        'accounts': [
            {
                'awsAccountId': 'string',
                'awsAccountName': 'string',
                'supportedRegions': [
                    'string',
                ]
            },
        ],
        'customAccountPoolHandler': {
            'lambdaExecutionRoleArn': 'string',
            'lambdaFunctionArn': 'string'
        }
    },
    description='string',
    domainIdentifier='string',
    identifier='string',
    name='string',
    resolutionStrategy='MANUAL'
)

type accountSource:

dict

param accountSource:

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

accounts (list) --

The static list of accounts within an account pool.
- (dict) --
  
  The account information within an account pool.
  - awsAccountId (string) -- [REQUIRED]
    
    The account ID.
  - awsAccountName (string) --
    
    The account name.
  - supportedRegions (list) -- [REQUIRED]
    
    The regions supported for an account within an account pool.
    - (string) --
customAccountPoolHandler (dict) --

The custom Amazon Web Services Lambda handler within an account pool.
- lambdaExecutionRoleArn (string) --
  
  The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.
- lambdaFunctionArn (string) -- [REQUIRED]
  
  The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.

type description:

string

param description:

The description of the account pool that is to be udpated.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The domain ID where the account pool that is to be updated lives.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the account pool that is to be updated.

type name:

string

param name:

The name of the account pool that is to be updated.

type resolutionStrategy:

string

param resolutionStrategy:

The mechanism used to resolve the account selection from the account pool.

rtype:

dict

returns:

Response Syntax

{
    'accountSource': {
        'accounts': [
            {
                'awsAccountId': 'string',
                'awsAccountName': 'string',
                'supportedRegions': [
                    'string',
                ]
            },
        ],
        'customAccountPoolHandler': {
            'lambdaExecutionRoleArn': 'string',
            'lambdaFunctionArn': 'string'
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'resolutionStrategy': 'MANUAL',
    'updatedBy': 'string'
}

Response Structure

(dict) --
- accountSource (dict) --
  
  The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: accounts, customAccountPoolHandler. 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'}
```
  - accounts (list) --
    
    The static list of accounts within an account pool.
    - (dict) --
      
      The account information within an account pool.
      - awsAccountId (string) --
        
        The account ID.
      - awsAccountName (string) --
        
        The account name.
      - supportedRegions (list) --
        
        The regions supported for an account within an account pool.
        
        (string) --
  - customAccountPoolHandler (dict) --
    
    The custom Amazon Web Services Lambda handler within an account pool.
    - lambdaExecutionRoleArn (string) --
      
      The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.
    - lambdaFunctionArn (string) --
      
      The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.
- createdAt (datetime) --
  
  The timestamp at which the account pool was created.
- createdBy (string) --
  
  The user who created the account pool.
- description (string) --
  
  The description of the account pool that is to be udpated.
- domainId (string) --
  
  The domain ID where the account pool that is to be updated lives.
- domainUnitId (string) --
  
  The domain ID in which the account pool that is to be updated lives.
- id (string) --
  
  The ID of the account pool that is to be updated.
- lastUpdatedAt (datetime) --
  
  The timestamp at which the account pool was last updated.
- name (string) --
  
  The name of the account pool that is to be updated.
- resolutionStrategy (string) --
  
  The mechanism used to resolve the account selection from the account pool.
- updatedBy (string) --
  
  The user who last updated the account pool.

ListAccountsInAccountPool (new)

Link ¶

Lists the accounts in the specified account pool.

See also: AWS API Documentation

Request Syntax

client.list_accounts_in_account_pool(
    domainIdentifier='string',
    identifier='string',
    maxResults=123,
    nextToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain in which the accounts in the specified account pool are to be listed.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the account pool whose accounts are to be listed.

type maxResults:

integer

param maxResults:

The maximum number of accounts to return in a single call to ListAccountsInAccountPool. When the number of accounts to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.

type nextToken:

string

param nextToken:

When the number of accounts is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'awsAccountId': 'string',
            'awsAccountName': 'string',
            'supportedRegions': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListAccountsInAccountPool operation.
  - (dict) --
    
    The account information within an account pool.
    - awsAccountId (string) --
      
      The account ID.
    - awsAccountName (string) --
      
      The account name.
    - supportedRegions (list) --
      
      The regions supported for an account within an account pool.
      - (string) --
- nextToken (string) --
  
  When the number of accounts is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.

ListAccountPools (new)

Link ¶

Lists existing account pools.

See also: AWS API Documentation

Request Syntax

client.list_account_pools(
    domainIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    sortBy='NAME',
    sortOrder='ASCENDING'|'DESCENDING'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where exsting account pools are to be listed.

type maxResults:

integer

param maxResults:

The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountPools to list the next set of account pools.

type name:

string

param name:

The name of the account pool to be listed.

type nextToken:

string

param nextToken:

When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

type sortBy:

string

param sortBy:

The sort by mechanism in which the existing account pools are to be listed.

type sortOrder:

string

param sortOrder:

The sort order in which the existing account pools are to be listed.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'createdBy': 'string',
            'domainId': 'string',
            'domainUnitId': 'string',
            'id': 'string',
            'name': 'string',
            'resolutionStrategy': 'MANUAL',
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListAccountPools operation.
  - (dict) --
    
    The summary of the account pool.
    - createdBy (string) --
      
      The user who created the account pool.
    - domainId (string) --
      
      The ID of the domain.
    - domainUnitId (string) --
      
      The ID of the domain unit.
    - id (string) --
      
      The ID of the account pool.
    - name (string) --
      
      The name of the account pool.
    - resolutionStrategy (string) --
      
      The mechanism used to resolve the account selection from the account pool.
    - updatedBy (string) --
      
      The user who updated the account pool.
- nextToken (string) --
  
  When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

CreateAccountPool (new)

Link ¶

Creates an account pool.

See also: AWS API Documentation

Request Syntax

client.create_account_pool(
    accountSource={
        'accounts': [
            {
                'awsAccountId': 'string',
                'awsAccountName': 'string',
                'supportedRegions': [
                    'string',
                ]
            },
        ],
        'customAccountPoolHandler': {
            'lambdaExecutionRoleArn': 'string',
            'lambdaFunctionArn': 'string'
        }
    },
    description='string',
    domainIdentifier='string',
    name='string',
    resolutionStrategy='MANUAL'
)

type accountSource:

dict

param accountSource:

[REQUIRED]

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

accounts (list) --

The static list of accounts within an account pool.
- (dict) --
  
  The account information within an account pool.
  - awsAccountId (string) -- [REQUIRED]
    
    The account ID.
  - awsAccountName (string) --
    
    The account name.
  - supportedRegions (list) -- [REQUIRED]
    
    The regions supported for an account within an account pool.
    - (string) --
customAccountPoolHandler (dict) --

The custom Amazon Web Services Lambda handler within an account pool.
- lambdaExecutionRoleArn (string) --
  
  The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.
- lambdaFunctionArn (string) -- [REQUIRED]
  
  The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.

type description:

string

param description:

The description of the account pool.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where the account pool is created.

type name:

string

param name:

[REQUIRED]

The name of the account pool.

type resolutionStrategy:

string

param resolutionStrategy:

[REQUIRED]

The mechanism used to resolve the account selection from the account pool.

rtype:

dict

returns:

Response Syntax

{
    'accountSource': {
        'accounts': [
            {
                'awsAccountId': 'string',
                'awsAccountName': 'string',
                'supportedRegions': [
                    'string',
                ]
            },
        ],
        'customAccountPoolHandler': {
            'lambdaExecutionRoleArn': 'string',
            'lambdaFunctionArn': 'string'
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'resolutionStrategy': 'MANUAL',
    'updatedBy': 'string'
}

Response Structure

(dict) --
- accountSource (dict) --
  
  The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: accounts, customAccountPoolHandler. 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'}
```
  - accounts (list) --
    
    The static list of accounts within an account pool.
    - (dict) --
      
      The account information within an account pool.
      - awsAccountId (string) --
        
        The account ID.
      - awsAccountName (string) --
        
        The account name.
      - supportedRegions (list) --
        
        The regions supported for an account within an account pool.
        
        (string) --
  - customAccountPoolHandler (dict) --
    
    The custom Amazon Web Services Lambda handler within an account pool.
    - lambdaExecutionRoleArn (string) --
      
      The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.
    - lambdaFunctionArn (string) --
      
      The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.
- createdAt (datetime) --
  
  The timestamp at which the account pool was created.
- createdBy (string) --
  
  The user who created the account pool.
- description (string) --
  
  The description of the account pool.
- domainId (string) --
  
  The ID of the domain where the account pool is created.
- domainUnitId (string) --
  
  The ID of the domain where the account pool is created.
- id (string) --
  
  The ID of the account pool.
- lastUpdatedAt (datetime) --
  
  The timestamp at which the account pool was last updated.
- name (string) --
  
  The name of the account pool.
- resolutionStrategy (string) --
  
  The mechanism used to resolve the account selection from the account pool.
- updatedBy (string) --
  
  The user who last updated the account pool.

CreateProject (updated)

Link ¶
Changes (both)

{'userParameters': {'environmentResolvedAccount': {'awsAccountId': 'string',
                                                   'regionName': 'string',
                                                   'sourceAccountPoolId': 'string'}}}

Creates an Amazon DataZone project.

See also: AWS API Documentation

Request Syntax

client.create_project(
    description='string',
    domainIdentifier='string',
    domainUnitId='string',
    glossaryTerms=[
        'string',
    ],
    name='string',
    projectProfileId='string',
    userParameters=[
        {
            'environmentConfigurationName': 'string',
            'environmentId': 'string',
            'environmentParameters': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'environmentResolvedAccount': {
                'awsAccountId': 'string',
                'regionName': 'string',
                'sourceAccountPoolId': 'string'
            }
        },
    ]
)

type description:

string

param description:

The description of the Amazon DataZone project.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain in which this project is created.

type domainUnitId:

string

param domainUnitId:

The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

type glossaryTerms:

list

param glossaryTerms:

The glossary terms that can be used in this Amazon DataZone project.

(string) --

type name:

string

param name:

[REQUIRED]

The name of the Amazon DataZone project.

type projectProfileId:

string

param projectProfileId:

The ID of the project profile.

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

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'
                },
            ],
            '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 identifier of the Amazon DataZone domain in which the project was created.
- domainUnitId (string) --
  
  The ID of the domain unit.
- environmentDeploymentDetails (dict) --
  
  The environment deployment details.
  - 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 that can be used in the project.
  - (string) --
- id (string) --
  
  The ID of the Amazon DataZone project.
- lastUpdatedAt (datetime) --
  
  The timestamp of when the project was last updated.
- name (string) --
  
  The name of the project.
- projectProfileId (string) --
  
  The project profile ID.
- projectStatus (string) --
  
  The status of the Amazon DataZone project that was created.
- 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.

CreateProjectProfile (updated)

Link ¶
Changes (both)

{'environmentConfigurations': {'accountPools': ['string']}}

Creates a project profile.

See also: AWS API Documentation

Request Syntax

client.create_project_profile(
    description='string',
    domainIdentifier='string',
    domainUnitIdentifier='string',
    environmentConfigurations=[
        {
            'accountPools': [
                'string',
            ],
            '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'
        },
    ],
    name='string',
    status='ENABLED'|'DISABLED'
)

type description:

string

param description:

A description of a project profile.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

A domain ID of the project profile.

type domainUnitIdentifier:

string

param domainUnitIdentifier:

A domain unit ID of the project profile.

type environmentConfigurations:

list

param environmentConfigurations:

Environment configurations of the project profile.

(dict) --

The configuration of an environment.
- accountPools (list) --
  
  The account pools used by a custom project profile.
  - (string) --
- 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 can be set: awsAccountId, awsAccountIdPath.
  - 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 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.

type name:

string

param name:

[REQUIRED]

Project profile name.

type status:

string

param status:

Project profile status.

rtype:

dict

returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'environmentConfigurations': [
        {
            'accountPools': [
                'string',
            ],
            '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) --
  
  A timestamp at which a project profile is created.
- createdBy (string) --
  
  A user who created a project profile.
- description (string) --
  
  A project profile description.
- domainId (string) --
  
  The ID of the domain where a project profile is created.
- domainUnitId (string) --
  
  The ID of the domain unit where a project profile is created.
- environmentConfigurations (list) --
  
  Environment configurations of a project profile.
  - (dict) --
    
    The configuration of an environment.
    - accountPools (list) --
      
      The account pools used by a custom project profile.
      - (string) --
    - 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) --
  
  Project profile ID.
- lastUpdatedAt (datetime) --
  
  A timestamp when a project profile was last updated.
- name (string) --
  
  Project profile name.
- status (string) --
  
  Project profile status.

GetProject (updated)

Link ¶
Changes (response)

{'userParameters': {'environmentResolvedAccount': {'awsAccountId': 'string',
                                                   'regionName': 'string',
                                                   'sourceAccountPoolId': 'string'}}}

Gets a project in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.get_project(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

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

type identifier:

string

param identifier:

[REQUIRED]

The ID of the project.

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'
                },
            ],
            '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.

GetProjectProfile (updated)

Link ¶
Changes (response)

{'environmentConfigurations': {'accountPools': ['string']}}

The details of the project profile.

See also: AWS API Documentation

Request Syntax

client.get_project_profile(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the project profile.

rtype:

dict

returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'environmentConfigurations': [
        {
            'accountPools': [
                'string',
            ],
            '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 of when the project profile was created.
- createdBy (string) --
  
  The user who created the project profile.
- description (string) --
  
  The description of the project profile.
- domainId (string) --
  
  The ID of the domain of the project profile.
- domainUnitId (string) --
  
  The ID of the domain unit of the project profile.
- environmentConfigurations (list) --
  
  The environment configurations of the project profile.
  - (dict) --
    
    The configuration of an environment.
    - accountPools (list) --
      
      The account pools used by a custom project profile.
      - (string) --
    - 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 of when project profile was last updated.
- name (string) --
  
  The name of the project profile.
- status (string) --
  
  The status of the project profile.

UpdateProject (updated)

Link ¶
Changes (both)

{'userParameters': {'environmentResolvedAccount': {'awsAccountId': 'string',
                                                   'regionName': 'string',
                                                   'sourceAccountPoolId': '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'
                },
            ],
            'environmentResolvedAccount': {
                'awsAccountId': 'string',
                'regionName': 'string',
                'sourceAccountPoolId': '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.
- 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.

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'
                },
            ],
            '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.

UpdateProjectProfile (updated)

Link ¶
Changes (both)

{'environmentConfigurations': {'accountPools': ['string']}}

Updates a project profile.

See also: AWS API Documentation

Request Syntax

client.update_project_profile(
    description='string',
    domainIdentifier='string',
    domainUnitIdentifier='string',
    environmentConfigurations=[
        {
            'accountPools': [
                'string',
            ],
            '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'
)

type description:

string

param description:

The description of a project profile.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where a project profile is to be updated.

type domainUnitIdentifier:

string

param domainUnitIdentifier:

The ID of the domain unit where a project profile is to be updated.

type environmentConfigurations:

list

param environmentConfigurations:

The environment configurations of a project profile.

(dict) --

The configuration of an environment.
- accountPools (list) --
  
  The account pools used by a custom project profile.
  - (string) --
- 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 can be set: awsAccountId, awsAccountIdPath.
  - 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 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.

type identifier:

string

param identifier:

[REQUIRED]

The ID of a project profile that is to be updated.

type name:

string

param name:

The name of a project profile.

type status:

string

param status:

The status of a project profile.

rtype:

dict

returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'environmentConfigurations': [
        {
            'accountPools': [
                'string',
            ],
            '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.
    - accountPools (list) --
      
      The account pools used by a custom project profile.
      - (string) --
    - 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.