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

GetEnvironmentProfile

Gets an evinronment profile in Amazon DataZone.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain in which this environment profile exists.

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

Required: Yes

identifier

The ID of the environment profile.

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

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "environmentBlueprintId": "string",
   "id": "string",
   "name": "string",
   "projectId": "string",
   "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.

awsAccountId

The ID of the AWS account where this environment profile exists.

Type: String

Pattern: ^\d{12}$

awsAccountRegion

The AWS region where this environment profile exists.

Type: String

Pattern: ^[a-z]{2}-[a-z]{4,10}-\d$

createdAt

The timestamp of when this environment profile was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created this environment profile.

Type: String

description

The description of the environment profile.

Type: String

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

domainId

The ID of the Amazon DataZone domain in which this environment profile exists.

Type: String

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

environmentBlueprintId

The ID of the blueprint with which this environment profile is created.

Type: String

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

id

The ID of the environment profile.

Type: String

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

name

The name of the environment profile.

Type: String

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

Pattern: ^[\w -]+$

projectId

The ID of the Amazon DataZone project in which this environment profile is created.

Type: String

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

updatedAt

The timestamp of when this environment profile was upated.

Type: Timestamp

userParameters

The user parameters of the environment profile.

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: