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

GetEnvironmentAction

Gets the specified environment action.

Request Syntax


GET /v2/domains/domainIdentifier/environments/environmentIdentifier/actions/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is invoked.

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

Required: Yes

environmentIdentifier

The environment ID of the environment action.

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

Required: Yes

identifier

The ID of the environment action

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "name": "string",
   "parameters": { ... }
}

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.

description

The description of the environment action.

Type: String

domainId

The ID of the Amazon DataZone domain in which the environment action lives.

Type: String

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

environmentId

The environment ID of the environment action.

Type: String

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

id

The ID of the environment action.

Type: String

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

name

The name of the environment action.

Type: String

parameters

The parameters of the environment action.

Type: ActionParameters object

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

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