GetEnvironmentBlueprintConfiguration
Gets the blueprint configuration in Amazon DataZone.
Request Syntax
GET /v2/domains/domainIdentifier
/environment-blueprint-configurations/environmentBlueprintIdentifier
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the Amazon DataZone domain where this blueprint exists.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$
Required: Yes
- environmentBlueprintIdentifier
-
He ID of the blueprint.
Pattern:
^[a-zA-Z0-9_-]{1,36}$
Required: Yes
Request Body
The request does not have a request body.
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 this blueprint was created.
Type: Timestamp
- domainId
-
The ID of the Amazon DataZone domain where this blueprint exists.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$
- enabledRegions
-
The AWS regions in which this blueprint is enabled.
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 ID of the 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 with which this blueprint is created.
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 with which this blueprint is created.
Type: String
Pattern:
^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$
- regionalParameters
-
The regional parameters of the 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 this blueprint was upated.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: