Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutEnvironmentBlueprintConfiguration

Writes the configuration for the specified environment blueprint in Amazon DataZone.

Request Syntax


PUT /v2/domains/domainIdentifier/environment-blueprint-configurations/environmentBlueprintIdentifier HTTP/1.1
Content-type: application/json

{
   "enabledRegions": [ "string" ],
   "environmentRolePermissionBoundary": "string",
   "manageAccessRoleArn": "string",
   "provisioningConfigurations": [ 
      { ... }
   ],
   "provisioningRoleArn": "string",
   "regionalParameters": { 
      "string" : { 
         "string" : "string" 
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the Amazon DataZone domain.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

environmentBlueprintIdentifier

The identifier of the environment blueprint.

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

enabledRegions

Specifies the enabled AWS Regions.

Type: Array of strings

Array Members: Minimum number of 0 items.

Length Constraints: Minimum length of 4. Maximum length of 16.

Pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$

Required: Yes

environmentRolePermissionBoundary

The environment role permissions boundary.

Type: String

Pattern: ^arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*$

Required: No

manageAccessRoleArn

The ARN of the manage access role.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

Required: No

provisioningConfigurations

The provisioning configuration of a blueprint.

Type: Array of ProvisioningConfiguration objects

Required: No

provisioningRoleArn

The ARN of the provisioning role.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

Required: No

regionalParameters

The regional parameters in the environment blueprint.

Type: String to string to string map map

Key Length Constraints: Minimum length of 4. Maximum length of 16.

Key Pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "domainId": "string",
   "enabledRegions": [ "string" ],
   "environmentBlueprintId": "string",
   "environmentRolePermissionBoundary": "string",
   "manageAccessRoleArn": "string",
   "provisioningConfigurations": [ 
      { ... }
   ],
   "provisioningRoleArn": "string",
   "regionalParameters": { 
      "string" : { 
         "string" : "string" 
      }
   },
   "updatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp of when the environment blueprint was created.

Type: Timestamp

domainId

The identifier of the Amazon DataZone domain.

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

enabledRegions

Specifies the enabled AWS Regions.

Type: Array of strings

Array Members: Minimum number of 0 items.

Length Constraints: Minimum length of 4. Maximum length of 16.

Pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$

environmentBlueprintId

The identifier of the environment blueprint.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

environmentRolePermissionBoundary

The environment role permissions boundary.

Type: String

Pattern: ^arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*$

manageAccessRoleArn

The ARN of the manage access role.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

provisioningConfigurations

The provisioning configuration of a blueprint.

Type: Array of ProvisioningConfiguration objects

provisioningRoleArn

The ARN of the provisioning role.

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

regionalParameters

The regional parameters in the environment blueprint.

Type: String to string to string map map

Key Length Constraints: Minimum length of 4. Maximum length of 16.

Key Pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$

updatedAt

The timestamp of when the environment blueprint was updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400