GetEnvironmentBlueprint - Amazon DataZone
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetEnvironmentBlueprint

Gets an Amazon DataZone blueprint.

Request Syntax

GET /v2/domains/domainIdentifier/environment-blueprints/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the domain in which this blueprint exists.

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

Required: Yes

identifier

The ID of this Amazon DataZone 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",
   "deploymentProperties": { 
      "endTimeoutMinutes": number,
      "startTimeoutMinutes": number
   },
   "description": "string",
   "glossaryTerms": [ "string" ],
   "id": "string",
   "name": "string",
   "provider": "string",
   "provisioningProperties": { ... },
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "keyName": "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

A timestamp of when this blueprint was created.

Type: Timestamp

deploymentProperties

The deployment properties of this Amazon DataZone blueprint.

Type: DeploymentProperties object

description

The description of this Amazon DataZone blueprint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

glossaryTerms

The glossary terms attached to this Amazon DataZone blueprint.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

id

The ID of this Amazon DataZone blueprint.

Type: String

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

name

The name of this Amazon DataZone blueprint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w -]+$

provider

The provider of this Amazon DataZone blueprint.

Type: String

provisioningProperties

The provisioning properties of this Amazon DataZone blueprint.

Type: ProvisioningProperties object

Note: This object is a Union. Only one member of this object can be specified or returned.

updatedAt

The timestamp of when this blueprint was updated.

Type: Timestamp

userParameters

The user parameters of this blueprint.

Type: Array of CustomParameter objects

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: