2025/09/09 - Amazon DataZone - 3 new8 updated api methods
Changes Adds support for custom blueprints
Updates an environment blueprint in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_environment_blueprint( description='string', domainIdentifier='string', identifier='string', provisioningProperties={ 'cloudFormation': { 'templateUrl': 'string' } }, userParameters=[ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] )
string
The description to be updated as part of the UpdateEnvironmentBlueprint action.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.
string
[REQUIRED]
The identifier of the environment blueprint to be updated.
dict
The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.
cloudFormation (dict) --
The cloud formation properties included as part of the provisioning properties of an environment blueprint.
templateUrl (string) -- [REQUIRED]
The template URL of the cloud formation provisioning properties of the environment blueprint.
list
The user parameters to be updated as part of the UpdateEnvironmentBlueprint 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) -- [REQUIRED]
The filed type 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.
keyName (string) -- [REQUIRED]
The key name of the parameter.
dict
Response Syntax
{ 'createdAt': datetime(2015, 1, 1), 'deploymentProperties': { 'endTimeoutMinutes': 123, 'startTimeoutMinutes': 123 }, 'description': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'name': 'string', 'provider': 'string', 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] }
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the environment blueprint was created.
deploymentProperties (dict) --
The deployment properties to be updated as part of the UpdateEnvironmentBlueprint 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 UpdateEnvironmentBlueprint action.
glossaryTerms (list) --
The glossary terms to be updated as part of the UpdateEnvironmentBlueprint action.
(string) --
id (string) --
The identifier of the blueprint to be updated.
name (string) --
The name to be updated as part of the UpdateEnvironmentBlueprint action.
provider (string) --
The provider of the blueprint to be udpated.
provisioningProperties (dict) --
The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint 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.
updatedAt (datetime) --
The timestamp of when the blueprint was updated.
userParameters (list) --
The user parameters to be updated as part of the UpdateEnvironmentBlueprint 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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
Creates a Amazon DataZone blueprint.
See also: AWS API Documentation
Request Syntax
client.create_environment_blueprint( description='string', domainIdentifier='string', name='string', provisioningProperties={ 'cloudFormation': { 'templateUrl': 'string' } }, userParameters=[ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] )
string
The description of the Amazon DataZone blueprint.
string
[REQUIRED]
The identifier of the domain in which this blueprint is created.
string
[REQUIRED]
The name of this Amazon DataZone blueprint.
dict
[REQUIRED]
The provisioning properties of this Amazon DataZone blueprint.
cloudFormation (dict) --
The cloud formation properties included as part of the provisioning properties of an environment blueprint.
templateUrl (string) -- [REQUIRED]
The template URL of the cloud formation provisioning properties of the environment blueprint.
list
The user parameters of this Amazon DataZone blueprint.
(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) -- [REQUIRED]
The filed type 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.
keyName (string) -- [REQUIRED]
The key name of the parameter.
dict
Response Syntax
{ 'createdAt': datetime(2015, 1, 1), 'deploymentProperties': { 'endTimeoutMinutes': 123, 'startTimeoutMinutes': 123 }, 'description': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'name': 'string', 'provider': 'string', 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] }
Response Structure
(dict) --
createdAt (datetime) --
The timestamp at which the environment blueprint was created.
deploymentProperties (dict) --
The deployment properties of this Amazon DataZone blueprint.
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 blueprint.
glossaryTerms (list) --
The glossary terms attached to this Amazon DataZone blueprint.
(string) --
id (string) --
The ID of this Amazon DataZone blueprint.
name (string) --
The name of this Amazon DataZone blueprint.
provider (string) --
The provider of this Amazon DataZone blueprint.
provisioningProperties (dict) --
The provisioning properties of this Amazon DataZone blueprint.
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.
updatedAt (datetime) --
The timestamp of when this blueprint was updated.
userParameters (list) --
The user parameters of this Amazon DataZone blueprint.
(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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
Deletes a blueprint in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_environment_blueprint( domainIdentifier='string', identifier='string' )
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the blueprint is deleted.
string
[REQUIRED]
The ID of the blueprint that is deleted.
None
{'userParameters': {'isUpdateSupported': 'boolean'}}
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' }, ] )
integer
The deployment order of the environment.
string
The description of the Amazon DataZone environment.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the environment is created.
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.
string
The configuration ID of the environment.
string
The identifier of the environment profile that is used to create this Amazon DataZone environment.
list
The glossary terms that can be used in this Amazon DataZone environment.
(string) --
string
[REQUIRED]
The name of the Amazon DataZone environment.
string
[REQUIRED]
The identifier of the Amazon DataZone project in which this environment is created.
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.
dict
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, 'isUpdateSupported': 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.
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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
{'userParameters': {'isUpdateSupported': 'boolean'}}
Creates an Amazon DataZone environment profile.
See also: AWS API Documentation
Request Syntax
client.create_environment_profile( awsAccountId='string', awsAccountRegion='string', description='string', domainIdentifier='string', environmentBlueprintIdentifier='string', name='string', projectIdentifier='string', userParameters=[ { 'name': 'string', 'value': 'string' }, ] )
string
The Amazon Web Services account in which the Amazon DataZone environment is created.
string
The Amazon Web Services region in which this environment profile is created.
string
The description of this Amazon DataZone environment profile.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this environment profile is created.
string
[REQUIRED]
The ID of the blueprint with which this environment profile is created.
string
[REQUIRED]
The name of this Amazon DataZone environment profile.
string
[REQUIRED]
The identifier of the project in which to create the environment profile.
list
The user parameters of this Amazon DataZone environment profile.
(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.
dict
Response Syntax
{ 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] }
Response Structure
(dict) --
awsAccountId (string) --
The Amazon Web Services account ID in which this Amazon DataZone environment profile is created.
awsAccountRegion (string) --
The Amazon Web Services region in which this Amazon DataZone environment profile is created.
createdAt (datetime) --
The timestamp of when this environment profile was created.
createdBy (string) --
The Amazon DataZone user who created this environment profile.
description (string) --
The description of this Amazon DataZone environment profile.
domainId (string) --
The ID of the Amazon DataZone domain in which this environment profile is created.
environmentBlueprintId (string) --
The ID of the blueprint with which this environment profile is created.
id (string) --
The ID of this Amazon DataZone environment profile.
name (string) --
The name of this Amazon DataZone environment profile.
projectId (string) --
The ID of the Amazon DataZone project in which this environment profile is created.
updatedAt (datetime) --
The timestamp of when this environment profile was updated.
userParameters (list) --
The user parameters of this Amazon DataZone environment profile.
(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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
{'userParameters': {'isUpdateSupported': 'boolean'}}
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
{ '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, 'isUpdateSupported': 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.
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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
{'userParameters': {'isUpdateSupported': 'boolean'}}
Gets an Amazon DataZone blueprint.
See also: AWS API Documentation
Request Syntax
client.get_environment_blueprint( domainIdentifier='string', identifier='string' )
string
[REQUIRED]
The identifier of the domain in which this blueprint exists.
string
[REQUIRED]
The ID of this Amazon DataZone blueprint.
dict
Response Syntax
{ 'createdAt': datetime(2015, 1, 1), 'deploymentProperties': { 'endTimeoutMinutes': 123, 'startTimeoutMinutes': 123 }, 'description': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'name': 'string', 'provider': 'string', 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] }
Response Structure
(dict) --
createdAt (datetime) --
A timestamp of when this blueprint was created.
deploymentProperties (dict) --
The deployment properties of this Amazon DataZone blueprint.
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 blueprint.
glossaryTerms (list) --
The glossary terms attached to this Amazon DataZone blueprint.
(string) --
id (string) --
The ID of this Amazon DataZone blueprint.
name (string) --
The name of this Amazon DataZone blueprint.
provider (string) --
The provider of this Amazon DataZone blueprint.
provisioningProperties (dict) --
The provisioning properties of this Amazon DataZone blueprint.
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.
updatedAt (datetime) --
The timestamp of when this blueprint was updated.
userParameters (list) --
The user parameters of this blueprint.
(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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
{'userParameters': {'isUpdateSupported': 'boolean'}}
Gets an evinronment profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_environment_profile( domainIdentifier='string', identifier='string' )
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this environment profile exists.
string
[REQUIRED]
The ID of the environment profile.
dict
Response Syntax
{ 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] }
Response Structure
(dict) --
awsAccountId (string) --
The ID of the Amazon Web Services account where this environment profile exists.
awsAccountRegion (string) --
The Amazon Web Services region where this environment profile exists.
createdAt (datetime) --
The timestamp of when this environment profile was created.
createdBy (string) --
The Amazon DataZone user who created this environment profile.
description (string) --
The description of the environment profile.
domainId (string) --
The ID of the Amazon DataZone domain in which this environment profile exists.
environmentBlueprintId (string) --
The ID of the blueprint with which this environment profile is created.
id (string) --
The ID of the environment profile.
name (string) --
The name of the environment profile.
projectId (string) --
The ID of the Amazon DataZone project in which this environment profile is created.
updatedAt (datetime) --
The timestamp of when this environment profile was upated.
userParameters (list) --
The user parameters of the environment profile.
(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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
{'globalParameters': {'string': 'string'}}
Writes the configuration for the specified environment blueprint in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.put_environment_blueprint_configuration( domainIdentifier='string', enabledRegions=[ 'string', ], environmentBlueprintIdentifier='string', environmentRolePermissionBoundary='string', globalParameters={ 'string': 'string' }, manageAccessRoleArn='string', provisioningConfigurations=[ { 'lakeFormationConfiguration': { 'locationRegistrationExcludeS3Locations': [ 'string', ], 'locationRegistrationRole': 'string' } }, ], provisioningRoleArn='string', regionalParameters={ 'string': { 'string': 'string' } } )
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
list
[REQUIRED]
Specifies the enabled Amazon Web Services Regions.
(string) --
string
[REQUIRED]
The identifier of the environment blueprint.
string
The environment role permissions boundary.
dict
Region-agnostic environment blueprint parameters.
(string) --
(string) --
string
The ARN of the manage access role.
list
The provisioning configuration of a blueprint.
(dict) --
The provisioning configuration of the blueprint.
lakeFormationConfiguration (dict) --
The Lake Formation configuration of the Data Lake blueprint.
locationRegistrationExcludeS3Locations (list) --
Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.
(string) --
locationRegistrationRole (string) --
The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode.
string
The ARN of the provisioning role.
dict
The regional parameters in the environment blueprint.
(string) --
(dict) --
(string) --
(string) --
dict
Response Syntax
{ 'createdAt': datetime(2015, 1, 1), 'domainId': 'string', 'enabledRegions': [ 'string', ], 'environmentBlueprintId': 'string', 'environmentRolePermissionBoundary': 'string', 'manageAccessRoleArn': 'string', 'provisioningConfigurations': [ { 'lakeFormationConfiguration': { 'locationRegistrationExcludeS3Locations': [ 'string', ], 'locationRegistrationRole': 'string' } }, ], 'provisioningRoleArn': 'string', 'regionalParameters': { 'string': { 'string': 'string' } }, 'updatedAt': datetime(2015, 1, 1) }
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the environment blueprint was created.
domainId (string) --
The identifier of the Amazon DataZone domain.
enabledRegions (list) --
Specifies the enabled Amazon Web Services Regions.
(string) --
environmentBlueprintId (string) --
The identifier of the environment blueprint.
environmentRolePermissionBoundary (string) --
The environment role permissions boundary.
manageAccessRoleArn (string) --
The ARN of the manage access role.
provisioningConfigurations (list) --
The provisioning configuration of a blueprint.
(dict) --
The provisioning configuration of the blueprint.
lakeFormationConfiguration (dict) --
The Lake Formation configuration of the Data Lake blueprint.
locationRegistrationExcludeS3Locations (list) --
Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.
(string) --
locationRegistrationRole (string) --
The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode.
provisioningRoleArn (string) --
The ARN of the provisioning role.
regionalParameters (dict) --
The regional parameters in the environment blueprint.
(string) --
(dict) --
(string) --
(string) --
updatedAt (datetime) --
The timestamp of when the environment blueprint was updated.
{'userParameters': {'isUpdateSupported': 'boolean'}}
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' }, ] )
string
The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.
string
The description to be updated as part of the UpdateEnvironment action.
string
[REQUIRED]
The identifier of the domain in which the environment is to be updated.
list
The glossary terms to be updated as part of the UpdateEnvironment action.
(string) --
string
[REQUIRED]
The identifier of the environment that is to be updated.
string
The name to be updated as part of the UpdateEnvironment action.
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.
dict
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, 'isUpdateSupported': 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.
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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.
{'userParameters': {'isUpdateSupported': 'boolean'}}
Updates the specified environment profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_environment_profile( awsAccountId='string', awsAccountRegion='string', description='string', domainIdentifier='string', identifier='string', name='string', userParameters=[ { 'name': 'string', 'value': 'string' }, ] )
string
The Amazon Web Services account in which a specified environment profile is to be udpated.
string
The Amazon Web Services Region in which a specified environment profile is to be updated.
string
The description to be updated as part of the UpdateEnvironmentProfile action.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which an environment profile is to be updated.
string
[REQUIRED]
The identifier of the environment profile that is to be updated.
string
The name to be updated as part of the UpdateEnvironmentProfile action.
list
The user parameters to be updated as part of the UpdateEnvironmentProfile action.
(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.
dict
Response Syntax
{ 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'isUpdateSupported': True|False, 'keyName': 'string' }, ] }
Response Structure
(dict) --
awsAccountId (string) --
The Amazon Web Services account in which a specified environment profile is to be udpated.
awsAccountRegion (string) --
The Amazon Web Services Region in which a specified environment profile is to be updated.
createdAt (datetime) --
The timestamp of when the environment profile was created.
createdBy (string) --
The Amazon DataZone user who created the environment profile.
description (string) --
The description to be updated as part of the UpdateEnvironmentProfile action.
domainId (string) --
The identifier of the Amazon DataZone domain in which the environment profile is to be updated.
environmentBlueprintId (string) --
The identifier of the blueprint of the environment profile that is to be updated.
id (string) --
The identifier of the environment profile that is to be udpated.
name (string) --
The name to be updated as part of the UpdateEnvironmentProfile action.
projectId (string) --
The identifier of the project of the environment profile that is to be updated.
updatedAt (datetime) --
The timestamp of when the environment profile was updated.
userParameters (list) --
The user parameters to be updated as part of the UpdateEnvironmentProfile 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.
isUpdateSupported (boolean) --
Specifies whether a parameter value can be updated after creation.
keyName (string) --
The key name of the parameter.