AWS API Changes

2025/03/13 - Amazon DataZone - 8 updated api methods

Changes This release adds support to update projects and environments

CreateEnvironment (updated)

Link ¶
Changes (response)

{'environmentConfigurationId': 'string'}

Create an Amazon DataZone environment.

See also: AWS API Documentation

Request Syntax

client.create_environment(
    deploymentOrder=123,
    description='string',
    domainIdentifier='string',
    environmentAccountIdentifier='string',
    environmentAccountRegion='string',
    environmentBlueprintIdentifier='string',
    environmentConfigurationId='string',
    environmentProfileIdentifier='string',
    glossaryTerms=[
        'string',
    ],
    name='string',
    projectIdentifier='string',
    userParameters=[
        {
            'name': 'string',
            'value': 'string'
        },
    ]
)

type deploymentOrder:

integer

param deploymentOrder:

The deployment order of the environment.

type description:

string

param description:

The description of the Amazon DataZone environment.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which the environment is created.

type environmentAccountIdentifier:

string

param environmentAccountIdentifier:

The ID of the account in which the environment is being created.

type environmentAccountRegion:

string

param environmentAccountRegion:

The region of the account in which the environment is being created.

type environmentBlueprintIdentifier:

string

param environmentBlueprintIdentifier:

The ID of the blueprint with which the environment is being created.

type environmentConfigurationId:

string

param environmentConfigurationId:

The configuration ID of the environment.

type environmentProfileIdentifier:

string

param environmentProfileIdentifier:

[REQUIRED]

The identifier of the environment profile that is used to create this Amazon DataZone environment.

type glossaryTerms:

list

param glossaryTerms:

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

(string) --

type name:

string

param name:

[REQUIRED]

The name of the Amazon DataZone environment.

type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone project in which this environment is created.

type userParameters:

list

param userParameters:

The user parameters of this Amazon DataZone environment.

(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

{
    'awsAccountId': 'string',
    'awsAccountRegion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'deploymentProperties': {
        'endTimeoutMinutes': 123,
        'startTimeoutMinutes': 123
    },
    'description': 'string',
    'domainId': 'string',
    'environmentActions': [
        {
            'auth': 'IAM'|'HTTPS',
            'parameters': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'type': 'string'
        },
    ],
    'environmentBlueprintId': 'string',
    'environmentConfigurationId': 'string',
    'environmentProfileId': 'string',
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastDeployment': {
        'deploymentId': 'string',
        'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
        'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
        'failureReason': {
            'code': 'string',
            'message': 'string'
        },
        'isDeploymentComplete': True|False,
        'messages': [
            'string',
        ]
    },
    'name': 'string',
    'projectId': 'string',
    'provider': 'string',
    'provisionedResources': [
        {
            'name': 'string',
            'provider': 'string',
            'type': 'string',
            'value': 'string'
        },
    ],
    'provisioningProperties': {
        'cloudFormation': {
            'templateUrl': 'string'
        }
    },
    'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
    'updatedAt': datetime(2015, 1, 1),
    'userParameters': [
        {
            'defaultValue': 'string',
            'description': 'string',
            'fieldType': 'string',
            'isEditable': True|False,
            'isOptional': True|False,
            'keyName': 'string'
        },
    ]
}

Response Structure

(dict) --
- awsAccountId (string) --
  
  The Amazon Web Services account in which the Amazon DataZone environment is created.
- awsAccountRegion (string) --
  
  The Amazon Web Services region in which the Amazon DataZone environment is created.
- createdAt (datetime) --
  
  The timestamp of when the environment was created.
- createdBy (string) --
  
  The Amazon DataZone user who created this environment.
- deploymentProperties (dict) --
  
  The deployment properties of this Amazon DataZone environment.
  - endTimeoutMinutes (integer) --
    
    The end timeout of the environment blueprint deployment.
  - startTimeoutMinutes (integer) --
    
    The start timeout of the environment blueprint deployment.
- description (string) --
  
  The description of this Amazon DataZone environment.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain in which the environment is created.
- environmentActions (list) --
  
  The configurable actions of this Amazon DataZone environment.
  - (dict) --
    
    The configurable action of a Amazon DataZone environment.
    - auth (string) --
      
      The authentication type of a configurable action of a Amazon DataZone environment.
    - parameters (list) --
      
      The parameters of a configurable action in a Amazon DataZone environment.
      - (dict) --
        
        The details of the parameters for the configurable environment action.
        
        key (string) --
        
        The key of the configurable action parameter.
        
        value (string) --
        
        The value of the configurable action parameter.
    - type (string) --
      
      The type of a configurable action in a Amazon DataZone environment.
- environmentBlueprintId (string) --
  
  The ID of the blueprint with which this Amazon DataZone environment was created.
- environmentConfigurationId (string) --
  
  The configuration ID of the environment.
- environmentProfileId (string) --
  
  The ID of the environment profile with which this Amazon DataZone environment was created.
- glossaryTerms (list) --
  
  The glossary terms that can be used in this Amazon DataZone environment.
  - (string) --
- id (string) --
  
  The ID of this Amazon DataZone environment.
- lastDeployment (dict) --
  
  The details of the last deployment of this Amazon DataZone environment.
  - deploymentId (string) --
    
    The identifier of the last deployment of the environment.
  - deploymentStatus (string) --
    
    The status of the last deployment of the environment.
  - deploymentType (string) --
    
    The type of the last deployment of the environment.
  - failureReason (dict) --
    
    The failure reason of the last deployment of the environment.
    - 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.
  - isDeploymentComplete (boolean) --
    
    Specifies whether the last deployment of the environment is complete.
  - messages (list) --
    
    The messages of the last deployment of the environment.
    - (string) --
- name (string) --
  
  The name of this environment.
- projectId (string) --
  
  The ID of the Amazon DataZone project in which this environment is created.
- provider (string) --
  
  The provider of this Amazon DataZone environment.
- provisionedResources (list) --
  
  The provisioned resources of this Amazon DataZone environment.
  - (dict) --
    
    The details of a provisioned resource of this Amazon DataZone environment.
    - name (string) --
      
      The name of a provisioned resource of this Amazon DataZone environment.
    - provider (string) --
      
      The provider of a provisioned resource of this Amazon DataZone environment.
    - type (string) --
      
      The type of a provisioned resource of this Amazon DataZone environment.
    - value (string) --
      
      The value of a provisioned resource of this Amazon DataZone environment.
- provisioningProperties (dict) --
  
  The provisioning properties of this Amazon DataZone environment.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation. 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'}
```
  - cloudFormation (dict) --
    
    The cloud formation properties included as part of the provisioning properties of an environment blueprint.
    - templateUrl (string) --
      
      The template URL of the cloud formation provisioning properties of the environment blueprint.
- status (string) --
  
  The status of this Amazon DataZone environment.
- updatedAt (datetime) --
  
  The timestamp of when this environment was updated.
- userParameters (list) --
  
  The user parameters of this Amazon DataZone environment.
  - (dict) --
    
    The details of user parameters of an environment blueprint.
    - defaultValue (string) --
      
      The default value of the parameter.
    - description (string) --
      
      The description of the parameter.
    - fieldType (string) --
      
      The filed type of the parameter.
    - isEditable (boolean) --
      
      Specifies whether the parameter is editable.
    - isOptional (boolean) --
      
      Specifies whether the custom parameter is optional.
    - keyName (string) --
      
      The key name of the parameter.

CreateProject (updated)

Link ¶
Changes (request, response)
Request

{'userParameters': {'environmentId': 'string'}}

Response

{'projectStatus': {'UPDATING', 'UPDATE_FAILED'},
 'userParameters': {'environmentId': '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'
                },
            ]
        },
    ]
)

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.

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

GetEnvironment (updated)

Link ¶
Changes (response)

{'environmentConfigurationId': 'string'}

Gets an Amazon DataZone environment.

See also: AWS API Documentation

Request Syntax

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

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain where the environment exists.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the Amazon DataZone environment.

rtype:

dict

returns:

Response Syntax

{
    'awsAccountId': 'string',
    'awsAccountRegion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'deploymentProperties': {
        'endTimeoutMinutes': 123,
        'startTimeoutMinutes': 123
    },
    'description': 'string',
    'domainId': 'string',
    'environmentActions': [
        {
            'auth': 'IAM'|'HTTPS',
            'parameters': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'type': 'string'
        },
    ],
    'environmentBlueprintId': 'string',
    'environmentConfigurationId': 'string',
    'environmentProfileId': 'string',
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastDeployment': {
        'deploymentId': 'string',
        'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
        'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
        'failureReason': {
            'code': 'string',
            'message': 'string'
        },
        'isDeploymentComplete': True|False,
        'messages': [
            'string',
        ]
    },
    'name': 'string',
    'projectId': 'string',
    'provider': 'string',
    'provisionedResources': [
        {
            'name': 'string',
            'provider': 'string',
            'type': 'string',
            'value': 'string'
        },
    ],
    'provisioningProperties': {
        'cloudFormation': {
            'templateUrl': 'string'
        }
    },
    'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
    'updatedAt': datetime(2015, 1, 1),
    'userParameters': [
        {
            'defaultValue': 'string',
            'description': 'string',
            'fieldType': 'string',
            'isEditable': True|False,
            'isOptional': True|False,
            'keyName': 'string'
        },
    ]
}

Response Structure

(dict) --
- awsAccountId (string) --
  
  The ID of the Amazon Web Services account where the environment exists.
- awsAccountRegion (string) --
  
  The Amazon Web Services region where the environment exists.
- createdAt (datetime) --
  
  The timestamp of when the environment was created.
- createdBy (string) --
  
  The Amazon DataZone user who created the environment.
- deploymentProperties (dict) --
  
  The deployment properties of the environment.
  - endTimeoutMinutes (integer) --
    
    The end timeout of the environment blueprint deployment.
  - startTimeoutMinutes (integer) --
    
    The start timeout of the environment blueprint deployment.
- description (string) --
  
  The description of the environment.
- domainId (string) --
  
  The ID of the Amazon DataZone domain where the environment exists.
- environmentActions (list) --
  
  The actions of the environment.
  - (dict) --
    
    The configurable action of a Amazon DataZone environment.
    - auth (string) --
      
      The authentication type of a configurable action of a Amazon DataZone environment.
    - parameters (list) --
      
      The parameters of a configurable action in a Amazon DataZone environment.
      - (dict) --
        
        The details of the parameters for the configurable environment action.
        
        key (string) --
        
        The key of the configurable action parameter.
        
        value (string) --
        
        The value of the configurable action parameter.
    - type (string) --
      
      The type of a configurable action in a Amazon DataZone environment.
- environmentBlueprintId (string) --
  
  The blueprint with which the environment is created.
- environmentConfigurationId (string) --
  
  The configuration ID that is used to create the environment.
- environmentProfileId (string) --
  
  The ID of the environment profile with which the environment is created.
- glossaryTerms (list) --
  
  The business glossary terms that can be used in this environment.
  - (string) --
- id (string) --
  
  The ID of the environment.
- lastDeployment (dict) --
  
  The details of the last deployment of the environment.
  - deploymentId (string) --
    
    The identifier of the last deployment of the environment.
  - deploymentStatus (string) --
    
    The status of the last deployment of the environment.
  - deploymentType (string) --
    
    The type of the last deployment of the environment.
  - failureReason (dict) --
    
    The failure reason of the last deployment of the environment.
    - 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.
  - isDeploymentComplete (boolean) --
    
    Specifies whether the last deployment of the environment is complete.
  - messages (list) --
    
    The messages of the last deployment of the environment.
    - (string) --
- name (string) --
  
  The name of the environment.
- projectId (string) --
  
  The ID of the Amazon DataZone project in which this environment is created.
- provider (string) --
  
  The provider of this Amazon DataZone environment.
- provisionedResources (list) --
  
  The provisioned resources of this Amazon DataZone environment.
  - (dict) --
    
    The details of a provisioned resource of this Amazon DataZone environment.
    - name (string) --
      
      The name of a provisioned resource of this Amazon DataZone environment.
    - provider (string) --
      
      The provider of a provisioned resource of this Amazon DataZone environment.
    - type (string) --
      
      The type of a provisioned resource of this Amazon DataZone environment.
    - value (string) --
      
      The value of a provisioned resource of this Amazon DataZone environment.
- provisioningProperties (dict) --
  
  The provisioning properties of this Amazon DataZone environment.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation. 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'}
```
  - cloudFormation (dict) --
    
    The cloud formation properties included as part of the provisioning properties of an environment blueprint.
    - templateUrl (string) --
      
      The template URL of the cloud formation provisioning properties of the environment blueprint.
- status (string) --
  
  The status of this Amazon DataZone environment.
- updatedAt (datetime) --
  
  The timestamp of when this environment was updated.
- userParameters (list) --
  
  The user parameters of this Amazon DataZone environment.
  - (dict) --
    
    The details of user parameters of an environment blueprint.
    - defaultValue (string) --
      
      The default value of the parameter.
    - description (string) --
      
      The description of the parameter.
    - fieldType (string) --
      
      The filed type of the parameter.
    - isEditable (boolean) --
      
      Specifies whether the parameter is editable.
    - isOptional (boolean) --
      
      Specifies whether the custom parameter is optional.
    - keyName (string) --
      
      The key name of the parameter.

GetProject (updated)

Link ¶
Changes (response)

{'projectStatus': {'UPDATING', 'UPDATE_FAILED'},
 'userParameters': {'environmentId': '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'
                },
            ]
        },
    ]
}

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.

ListEnvironments (updated)

Link ¶
Changes (response)

{'items': {'environmentConfigurationId': 'string'}}

Lists Amazon DataZone environments.

See also: AWS API Documentation

Request Syntax

client.list_environments(
    awsAccountId='string',
    awsAccountRegion='string',
    domainIdentifier='string',
    environmentBlueprintIdentifier='string',
    environmentProfileIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    projectIdentifier='string',
    provider='string',
    status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE'
)

type awsAccountId:

string

param awsAccountId:

The identifier of the Amazon Web Services account where you want to list environments.

type awsAccountRegion:

string

param awsAccountRegion:

The Amazon Web Services region where you want to list environments.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain.

type environmentBlueprintIdentifier:

string

param environmentBlueprintIdentifier:

The identifier of the Amazon DataZone blueprint.

type environmentProfileIdentifier:

string

param environmentProfileIdentifier:

The identifier of the environment profile.

type maxResults:

integer

param maxResults:

The maximum number of environments to return in a single call to ListEnvironments. When the number of environments 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 ListEnvironments to list the next set of environments.

type name:

string

param name:

The name of the environment.

type nextToken:

string

param nextToken:

When the number of environments 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 environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

type projectIdentifier:

string

param projectIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone project.

type provider:

string

param provider:

The provider of the environment.

type status:

string

param status:

The status of the environments that you want to list.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'awsAccountId': 'string',
            'awsAccountRegion': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'environmentConfigurationId': 'string',
            'environmentProfileId': 'string',
            'id': 'string',
            'name': 'string',
            'projectId': 'string',
            'provider': 'string',
            'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListEnvironments action.
  - (dict) --
    
    The details of an environment.
    - awsAccountId (string) --
      
      The identifier of the Amazon Web Services account in which an environment exists.
    - awsAccountRegion (string) --
      
      The Amazon Web Services Region in which an environment exists.
    - createdAt (datetime) --
      
      The timestamp of when the environment was created.
    - createdBy (string) --
      
      The Amazon DataZone user who created the environment.
    - description (string) --
      
      The description of the environment.
    - domainId (string) --
      
      The identifier of the Amazon DataZone domain in which the environment exists.
    - environmentConfigurationId (string) --
      
      The configuration ID with which the environment is created.
    - environmentProfileId (string) --
      
      The identifier of the environment profile with which the environment was created.
    - id (string) --
      
      The identifier of the environment.
    - name (string) --
      
      The name of the environment.
    - projectId (string) --
      
      The identifier of the project in which the environment exists.
    - provider (string) --
      
      The provider of the environment.
    - status (string) --
      
      The status of the environment.
    - updatedAt (datetime) --
      
      The timestamp of when the environment was updated.
- nextToken (string) --
  
  When the number of environments 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 environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

ListProjects (updated)

Link ¶
Changes (response)

{'items': {'projectStatus': {'UPDATING', 'UPDATE_FAILED'}}}

Lists Amazon DataZone projects.

See also: AWS API Documentation

Request Syntax

client.list_projects(
    domainIdentifier='string',
    groupIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    userIdentifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain.

type groupIdentifier:

string

param groupIdentifier:

The identifier of a group.

type maxResults:

integer

param maxResults:

The maximum number of projects to return in a single call to ListProjects. When the number of projects 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 ListProjects to list the next set of projects.

type name:

string

param name:

The name of the project.

type nextToken:

string

param nextToken:

When the number of projects 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 projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

type userIdentifier:

string

param userIdentifier:

The identifier of the Amazon DataZone user.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'domainUnitId': 'string',
            'failureReasons': [
                {
                    'code': 'string',
                    'message': 'string'
                },
            ],
            'id': 'string',
            'name': 'string',
            'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListProjects action.
  - (dict) --
    
    The details of a Amazon DataZone project.
    - createdAt (datetime) --
      
      The timestamp of when a project was created.
    - createdBy (string) --
      
      The Amazon DataZone user who created the project.
    - description (string) --
      
      The description of a project.
    - domainId (string) --
      
      The identifier of a Amazon DataZone domain where the project exists.
    - domainUnitId (string) --
      
      The ID of the domain unit.
    - 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.
    - id (string) --
      
      The identifier of a project.
    - name (string) --
      
      The name of a project.
    - projectStatus (string) --
      
      The status of the project.
    - updatedAt (datetime) --
      
      The timestamp of when the project was updated.
- nextToken (string) --
  
  When the number of projects 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 projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

UpdateEnvironment (updated)

Link ¶
Changes (request, response)
Request

{'blueprintVersion': 'string',
 'userParameters': [{'name': 'string', 'value': 'string'}]}

Response

{'environmentConfigurationId': 'string'}

Updates the specified environment in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.update_environment(
    blueprintVersion='string',
    description='string',
    domainIdentifier='string',
    glossaryTerms=[
        'string',
    ],
    identifier='string',
    name='string',
    userParameters=[
        {
            'name': 'string',
            'value': 'string'
        },
    ]
)

type blueprintVersion:

string

param blueprintVersion:

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

type description:

string

param description:

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

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the domain in which the environment is to be updated.

type glossaryTerms:

list

param glossaryTerms:

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

(string) --

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the environment that is to be updated.

type name:

string

param name:

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

type userParameters:

list

param userParameters:

The user parameters of the environment.

(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

{
    'awsAccountId': 'string',
    'awsAccountRegion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'deploymentProperties': {
        'endTimeoutMinutes': 123,
        'startTimeoutMinutes': 123
    },
    'description': 'string',
    'domainId': 'string',
    'environmentActions': [
        {
            'auth': 'IAM'|'HTTPS',
            'parameters': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'type': 'string'
        },
    ],
    'environmentBlueprintId': 'string',
    'environmentConfigurationId': 'string',
    'environmentProfileId': 'string',
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'lastDeployment': {
        'deploymentId': 'string',
        'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
        'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
        'failureReason': {
            'code': 'string',
            'message': 'string'
        },
        'isDeploymentComplete': True|False,
        'messages': [
            'string',
        ]
    },
    'name': 'string',
    'projectId': 'string',
    'provider': 'string',
    'provisionedResources': [
        {
            'name': 'string',
            'provider': 'string',
            'type': 'string',
            'value': 'string'
        },
    ],
    'provisioningProperties': {
        'cloudFormation': {
            'templateUrl': 'string'
        }
    },
    'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
    'updatedAt': datetime(2015, 1, 1),
    'userParameters': [
        {
            'defaultValue': 'string',
            'description': 'string',
            'fieldType': 'string',
            'isEditable': True|False,
            'isOptional': True|False,
            'keyName': 'string'
        },
    ]
}

Response Structure

(dict) --
- awsAccountId (string) --
  
  The identifier of the Amazon Web Services account in which the environment is to be updated.
- awsAccountRegion (string) --
  
  The Amazon Web Services Region in which the environment is updated.
- createdAt (datetime) --
  
  The timestamp of when the environment was created.
- createdBy (string) --
  
  The Amazon DataZone user who created the environment.
- deploymentProperties (dict) --
  
  The deployment properties to be updated as part of the UpdateEnvironment action.
  - endTimeoutMinutes (integer) --
    
    The end timeout of the environment blueprint deployment.
  - startTimeoutMinutes (integer) --
    
    The start timeout of the environment blueprint deployment.
- description (string) --
  
  The description to be updated as part of the UpdateEnvironment action.
- domainId (string) --
  
  The identifier of the domain in which the environment is to be updated.
- environmentActions (list) --
  
  The environment actions to be updated as part of the UpdateEnvironment action.
  - (dict) --
    
    The configurable action of a Amazon DataZone environment.
    - auth (string) --
      
      The authentication type of a configurable action of a Amazon DataZone environment.
    - parameters (list) --
      
      The parameters of a configurable action in a Amazon DataZone environment.
      - (dict) --
        
        The details of the parameters for the configurable environment action.
        
        key (string) --
        
        The key of the configurable action parameter.
        
        value (string) --
        
        The value of the configurable action parameter.
    - type (string) --
      
      The type of a configurable action in a Amazon DataZone environment.
- environmentBlueprintId (string) --
  
  The blueprint identifier of the environment.
- environmentConfigurationId (string) --
  
  The configuration ID of the environment.
- environmentProfileId (string) --
  
  The profile identifier of the environment.
- glossaryTerms (list) --
  
  The glossary terms to be updated as part of the UpdateEnvironment action.
  - (string) --
- id (string) --
  
  The identifier of the environment that is to be updated.
- lastDeployment (dict) --
  
  The last deployment of the environment.
  - deploymentId (string) --
    
    The identifier of the last deployment of the environment.
  - deploymentStatus (string) --
    
    The status of the last deployment of the environment.
  - deploymentType (string) --
    
    The type of the last deployment of the environment.
  - failureReason (dict) --
    
    The failure reason of the last deployment of the environment.
    - 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.
  - isDeploymentComplete (boolean) --
    
    Specifies whether the last deployment of the environment is complete.
  - messages (list) --
    
    The messages of the last deployment of the environment.
    - (string) --
- name (string) --
  
  The name to be updated as part of the UpdateEnvironment action.
- projectId (string) --
  
  The project identifier of the environment.
- provider (string) --
  
  The provider identifier of the environment.
- provisionedResources (list) --
  
  The provisioned resources to be updated as part of the UpdateEnvironment action.
  - (dict) --
    
    The details of a provisioned resource of this Amazon DataZone environment.
    - name (string) --
      
      The name of a provisioned resource of this Amazon DataZone environment.
    - provider (string) --
      
      The provider of a provisioned resource of this Amazon DataZone environment.
    - type (string) --
      
      The type of a provisioned resource of this Amazon DataZone environment.
    - value (string) --
      
      The value of a provisioned resource of this Amazon DataZone environment.
- provisioningProperties (dict) --
  
  The provisioning properties to be updated as part of the UpdateEnvironment action.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation. 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'}
```
  - cloudFormation (dict) --
    
    The cloud formation properties included as part of the provisioning properties of an environment blueprint.
    - templateUrl (string) --
      
      The template URL of the cloud formation provisioning properties of the environment blueprint.
- status (string) --
  
  The status to be updated as part of the UpdateEnvironment action.
- updatedAt (datetime) --
  
  The timestamp of when the environment was updated.
- userParameters (list) --
  
  The user parameters to be updated as part of the UpdateEnvironment action.
  - (dict) --
    
    The details of user parameters of an environment blueprint.
    - defaultValue (string) --
      
      The default value of the parameter.
    - description (string) --
      
      The description of the parameter.
    - fieldType (string) --
      
      The filed type of the parameter.
    - isEditable (boolean) --
      
      Specifies whether the parameter is editable.
    - isOptional (boolean) --
      
      Specifies whether the custom parameter is optional.
    - keyName (string) --
      
      The key name of the parameter.

UpdateProject (updated)

Link ¶
Changes (request, response)
Request

{'projectProfileVersion': 'string',
 'userParameters': [{'environmentConfigurationName': 'string',
                     'environmentId': 'string',
                     'environmentParameters': [{'name': 'string',
                                                'value': 'string'}]}]}

Response

{'projectStatus': {'UPDATING', 'UPDATE_FAILED'},
 'userParameters': {'environmentId': 'string'}}

Updates the specified project in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.update_project(
    description='string',
    domainIdentifier='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 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.