2026/03/31 - Amazon DataZone - 4 updated api methods
Changes Adds environmentConfigurationName field to CreateEnvironmentInput and UpdateEnvironmentInput, so that Domain Owners can now recover orphaned environments by recreating deleted configurations with the same name, and will auto-recover orphaned environments
{'environmentConfigurationName': 'string'}
Create an Amazon DataZone environment.
See also: AWS API Documentation
Request Syntax
client.create_environment(
projectIdentifier='string',
domainIdentifier='string',
description='string',
name='string',
environmentProfileIdentifier='string',
userParameters=[
{
'name': 'string',
'value': 'string'
},
],
glossaryTerms=[
'string',
],
environmentAccountIdentifier='string',
environmentAccountRegion='string',
environmentBlueprintIdentifier='string',
deploymentOrder=123,
environmentConfigurationId='string',
environmentConfigurationName='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone project in which this environment is created.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the environment is created.
string
The description of the Amazon DataZone environment.
string
[REQUIRED]
The name of the Amazon DataZone environment.
string
The identifier of the environment profile that is used to create this Amazon DataZone environment.
list
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.
list
The glossary terms that can be used in this Amazon DataZone environment.
(string) --
string
The ID of the account in which the environment is being created.
string
The region of the account in which the environment is being created.
string
The ID of the blueprint with which the environment is being created.
integer
The deployment order of the environment.
string
The configuration ID of the environment.
string
The configuration name of the environment.
dict
Response Syntax
{
'projectId': 'string',
'id': 'string',
'domainId': 'string',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'name': 'string',
'description': 'string',
'environmentProfileId': 'string',
'awsAccountId': 'string',
'awsAccountRegion': 'string',
'provider': 'string',
'provisionedResources': [
{
'provider': 'string',
'name': 'string',
'value': 'string',
'type': 'string'
},
],
'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
'environmentActions': [
{
'type': 'string',
'auth': 'IAM'|'HTTPS',
'parameters': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'glossaryTerms': [
'string',
],
'userParameters': [
{
'keyName': 'string',
'description': 'string',
'fieldType': 'string',
'defaultValue': 'string',
'isEditable': True|False,
'isOptional': True|False,
'isUpdateSupported': True|False
},
],
'lastDeployment': {
'deploymentId': 'string',
'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
'failureReason': {
'code': 'string',
'message': 'string'
},
'messages': [
'string',
],
'isDeploymentComplete': True|False
},
'provisioningProperties': {
'cloudFormation': {
'templateUrl': 'string'
}
},
'deploymentProperties': {
'startTimeoutMinutes': 123,
'endTimeoutMinutes': 123
},
'environmentBlueprintId': 'string',
'environmentConfigurationId': 'string',
'environmentConfigurationName': 'string'
}
Response Structure
(dict) --
projectId (string) --
The ID of the Amazon DataZone project in which this environment is created.
id (string) --
The ID of this Amazon DataZone environment.
domainId (string) --
The identifier of the Amazon DataZone domain in which the environment is created.
createdBy (string) --
The Amazon DataZone user who created this environment.
createdAt (datetime) --
The timestamp of when the environment was created.
updatedAt (datetime) --
The timestamp of when this environment was updated.
name (string) --
The name of this environment.
description (string) --
The description of this Amazon DataZone environment.
environmentProfileId (string) --
The ID of the environment profile with which this Amazon DataZone environment was created.
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.
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.
provider (string) --
The provider of a provisioned resource of this Amazon DataZone environment.
name (string) --
The name of a provisioned resource of this Amazon DataZone environment.
value (string) --
The value of a provisioned resource of this Amazon DataZone environment.
type (string) --
The type of a provisioned resource of this Amazon DataZone environment.
status (string) --
The status of this Amazon DataZone environment.
environmentActions (list) --
The configurable actions of this Amazon DataZone environment.
(dict) --
The configurable action of a Amazon DataZone environment.
type (string) --
The type of a configurable action in 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.
glossaryTerms (list) --
The glossary terms that can be used in this Amazon DataZone environment.
(string) --
userParameters (list) --
The user parameters of this Amazon DataZone environment.
(dict) --
The details of user parameters of an environment blueprint.
keyName (string) --
The key name of the parameter.
description (string) --
The description of the parameter.
fieldType (string) --
The filed type of the parameter.
defaultValue (string) --
The default value of the parameter.
isEditable (boolean) --
Specifies whether the parameter is editable.
isOptional (boolean) --
Specifies whether the custom parameter is optional.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
lastDeployment (dict) --
The details of the last deployment of this Amazon DataZone environment.
deploymentId (string) --
The identifier of the last deployment of the environment.
deploymentType (string) --
The type of the last deployment of the environment.
deploymentStatus (string) --
The status 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.
messages (list) --
The messages of the last deployment of the environment.
(string) --
isDeploymentComplete (boolean) --
Specifies whether the last deployment of the environment is complete.
provisioningProperties (dict) --
The provisioning properties of this Amazon DataZone environment.
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.
deploymentProperties (dict) --
The deployment properties of this Amazon DataZone environment.
startTimeoutMinutes (integer) --
The start timeout of the environment blueprint deployment.
endTimeoutMinutes (integer) --
The end timeout of the environment blueprint deployment.
environmentBlueprintId (string) --
The ID of the blueprint with which this Amazon DataZone environment was created.
environmentConfigurationId (string) --
The configuration ID of the environment.
environmentConfigurationName (string) --
The configuration name of the environment.
{'environmentConfigurationName': 'string'}
Gets an Amazon DataZone environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain where the environment exists.
string
[REQUIRED]
The ID of the Amazon DataZone environment.
dict
Response Syntax
{
'projectId': 'string',
'id': 'string',
'domainId': 'string',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'name': 'string',
'description': 'string',
'environmentProfileId': 'string',
'awsAccountId': 'string',
'awsAccountRegion': 'string',
'provider': 'string',
'provisionedResources': [
{
'provider': 'string',
'name': 'string',
'value': 'string',
'type': 'string'
},
],
'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
'environmentActions': [
{
'type': 'string',
'auth': 'IAM'|'HTTPS',
'parameters': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'glossaryTerms': [
'string',
],
'userParameters': [
{
'keyName': 'string',
'description': 'string',
'fieldType': 'string',
'defaultValue': 'string',
'isEditable': True|False,
'isOptional': True|False,
'isUpdateSupported': True|False
},
],
'lastDeployment': {
'deploymentId': 'string',
'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
'failureReason': {
'code': 'string',
'message': 'string'
},
'messages': [
'string',
],
'isDeploymentComplete': True|False
},
'provisioningProperties': {
'cloudFormation': {
'templateUrl': 'string'
}
},
'deploymentProperties': {
'startTimeoutMinutes': 123,
'endTimeoutMinutes': 123
},
'environmentBlueprintId': 'string',
'environmentConfigurationId': 'string',
'environmentConfigurationName': 'string'
}
Response Structure
(dict) --
projectId (string) --
The ID of the Amazon DataZone project in which this environment is created.
id (string) --
The ID of the environment.
domainId (string) --
The ID of the Amazon DataZone domain where the environment exists.
createdBy (string) --
The Amazon DataZone user who created the environment.
createdAt (datetime) --
The timestamp of when the environment was created.
updatedAt (datetime) --
The timestamp of when this environment was updated.
name (string) --
The name of the environment.
description (string) --
The description of the environment.
environmentProfileId (string) --
The ID of the environment profile with which the environment is created.
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.
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.
provider (string) --
The provider of a provisioned resource of this Amazon DataZone environment.
name (string) --
The name of a provisioned resource of this Amazon DataZone environment.
value (string) --
The value of a provisioned resource of this Amazon DataZone environment.
type (string) --
The type of a provisioned resource of this Amazon DataZone environment.
status (string) --
The status of this Amazon DataZone environment.
environmentActions (list) --
The actions of the environment.
(dict) --
The configurable action of a Amazon DataZone environment.
type (string) --
The type of a configurable action in 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.
glossaryTerms (list) --
The business glossary terms that can be used in this environment.
(string) --
userParameters (list) --
The user parameters of this Amazon DataZone environment.
(dict) --
The details of user parameters of an environment blueprint.
keyName (string) --
The key name of the parameter.
description (string) --
The description of the parameter.
fieldType (string) --
The filed type of the parameter.
defaultValue (string) --
The default value of the parameter.
isEditable (boolean) --
Specifies whether the parameter is editable.
isOptional (boolean) --
Specifies whether the custom parameter is optional.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
lastDeployment (dict) --
The details of the last deployment of the environment.
deploymentId (string) --
The identifier of the last deployment of the environment.
deploymentType (string) --
The type of the last deployment of the environment.
deploymentStatus (string) --
The status 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.
messages (list) --
The messages of the last deployment of the environment.
(string) --
isDeploymentComplete (boolean) --
Specifies whether the last deployment of the environment is complete.
provisioningProperties (dict) --
The provisioning properties of this Amazon DataZone environment.
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.
deploymentProperties (dict) --
The deployment properties of the environment.
startTimeoutMinutes (integer) --
The start timeout of the environment blueprint deployment.
endTimeoutMinutes (integer) --
The end timeout of the environment blueprint deployment.
environmentBlueprintId (string) --
The blueprint with which the environment is created.
environmentConfigurationId (string) --
The configuration ID that is used to create the environment.
environmentConfigurationName (string) --
The configuration name that is used to create the environment.
{'items': {'environmentConfigurationName': 'string'}}
Lists Amazon DataZone environments.
See also: AWS API Documentation
Request Syntax
client.list_environments(
domainIdentifier='string',
awsAccountId='string',
status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
awsAccountRegion='string',
projectIdentifier='string',
environmentProfileIdentifier='string',
environmentBlueprintIdentifier='string',
provider='string',
name='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the Amazon Web Services account where you want to list environments.
string
The status of the environments that you want to list.
string
The Amazon Web Services region where you want to list environments.
string
[REQUIRED]
The identifier of the Amazon DataZone project.
string
The identifier of the environment profile.
string
The identifier of the Amazon DataZone blueprint.
string
The provider of the environment.
string
The name of the environment.
integer
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.
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.
dict
Response Syntax
{
'items': [
{
'projectId': 'string',
'id': 'string',
'domainId': 'string',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'name': 'string',
'description': 'string',
'environmentProfileId': 'string',
'awsAccountId': 'string',
'awsAccountRegion': 'string',
'provider': 'string',
'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
'environmentConfigurationId': 'string',
'environmentConfigurationName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListEnvironments action.
(dict) --
The details of an environment.
projectId (string) --
The identifier of the project in which the environment exists.
id (string) --
The identifier of the environment.
domainId (string) --
The identifier of the Amazon DataZone domain in which the environment exists.
createdBy (string) --
The Amazon DataZone user who created the environment.
createdAt (datetime) --
The timestamp of when the environment was created.
updatedAt (datetime) --
The timestamp of when the environment was updated.
name (string) --
The name of the environment.
description (string) --
The description of the environment.
environmentProfileId (string) --
The identifier of the environment profile with which the environment was created.
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.
provider (string) --
The provider of the environment.
status (string) --
The status of the environment.
environmentConfigurationId (string) --
The configuration ID with which the environment is created.
environmentConfigurationName (string) --
The configuration name with which the environment is created.
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.
{'environmentConfigurationName': 'string'}
Updates the specified environment in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_environment(
domainIdentifier='string',
identifier='string',
name='string',
description='string',
glossaryTerms=[
'string',
],
blueprintVersion='string',
userParameters=[
{
'name': 'string',
'value': 'string'
},
],
environmentConfigurationName='string'
)
string
[REQUIRED]
The identifier of the domain in which the environment is to be updated.
string
[REQUIRED]
The identifier of the environment that is to be updated.
string
The name to be updated as part of the UpdateEnvironment action.
string
The description to be updated as part of the UpdateEnvironment action.
list
The glossary terms to be updated as part of the UpdateEnvironment action.
(string) --
string
The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.
list
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.
string
The configuration name of the environment.
dict
Response Syntax
{
'projectId': 'string',
'id': 'string',
'domainId': 'string',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'name': 'string',
'description': 'string',
'environmentProfileId': 'string',
'awsAccountId': 'string',
'awsAccountRegion': 'string',
'provider': 'string',
'provisionedResources': [
{
'provider': 'string',
'name': 'string',
'value': 'string',
'type': 'string'
},
],
'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE',
'environmentActions': [
{
'type': 'string',
'auth': 'IAM'|'HTTPS',
'parameters': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'glossaryTerms': [
'string',
],
'userParameters': [
{
'keyName': 'string',
'description': 'string',
'fieldType': 'string',
'defaultValue': 'string',
'isEditable': True|False,
'isOptional': True|False,
'isUpdateSupported': True|False
},
],
'lastDeployment': {
'deploymentId': 'string',
'deploymentType': 'CREATE'|'UPDATE'|'DELETE',
'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT',
'failureReason': {
'code': 'string',
'message': 'string'
},
'messages': [
'string',
],
'isDeploymentComplete': True|False
},
'provisioningProperties': {
'cloudFormation': {
'templateUrl': 'string'
}
},
'deploymentProperties': {
'startTimeoutMinutes': 123,
'endTimeoutMinutes': 123
},
'environmentBlueprintId': 'string',
'environmentConfigurationId': 'string',
'environmentConfigurationName': 'string'
}
Response Structure
(dict) --
projectId (string) --
The project identifier of the environment.
id (string) --
The identifier of the environment that is to be updated.
domainId (string) --
The identifier of the domain in which the environment is to be updated.
createdBy (string) --
The Amazon DataZone user who created the environment.
createdAt (datetime) --
The timestamp of when the environment was created.
updatedAt (datetime) --
The timestamp of when the environment was updated.
name (string) --
The name to be updated as part of the UpdateEnvironment action.
description (string) --
The description to be updated as part of the UpdateEnvironment action.
environmentProfileId (string) --
The profile identifier of the environment.
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.
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.
provider (string) --
The provider of a provisioned resource of this Amazon DataZone environment.
name (string) --
The name of a provisioned resource of this Amazon DataZone environment.
value (string) --
The value of a provisioned resource of this Amazon DataZone environment.
type (string) --
The type of a provisioned resource of this Amazon DataZone environment.
status (string) --
The status to be updated as part of the UpdateEnvironment action.
environmentActions (list) --
The environment actions to be updated as part of the UpdateEnvironment action.
(dict) --
The configurable action of a Amazon DataZone environment.
type (string) --
The type of a configurable action in 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.
glossaryTerms (list) --
The glossary terms to be updated as part of the UpdateEnvironment action.
(string) --
userParameters (list) --
The user parameters to be updated as part of the UpdateEnvironment action.
(dict) --
The details of user parameters of an environment blueprint.
keyName (string) --
The key name of the parameter.
description (string) --
The description of the parameter.
fieldType (string) --
The filed type of the parameter.
defaultValue (string) --
The default value of the parameter.
isEditable (boolean) --
Specifies whether the parameter is editable.
isOptional (boolean) --
Specifies whether the custom parameter is optional.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
lastDeployment (dict) --
The last deployment of the environment.
deploymentId (string) --
The identifier of the last deployment of the environment.
deploymentType (string) --
The type of the last deployment of the environment.
deploymentStatus (string) --
The status 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.
messages (list) --
The messages of the last deployment of the environment.
(string) --
isDeploymentComplete (boolean) --
Specifies whether the last deployment of the environment is complete.
provisioningProperties (dict) --
The provisioning properties to be updated as part of the UpdateEnvironment action.
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.
deploymentProperties (dict) --
The deployment properties to be updated as part of the UpdateEnvironment action.
startTimeoutMinutes (integer) --
The start timeout of the environment blueprint deployment.
endTimeoutMinutes (integer) --
The end timeout of the environment blueprint deployment.
environmentBlueprintId (string) --
The blueprint identifier of the environment.
environmentConfigurationId (string) --
The configuration ID of the environment.
environmentConfigurationName (string) --
The configuration name of the environment.