UpdateEnvironmentAction
Updates an environment action.
Request Syntax
PATCH /v2/domains/domainIdentifier/environments/environmentIdentifier/actions/identifier HTTP/1.1
Content-type: application/json
{
"description": "string",
"name": "string",
"parameters": { ... }
}URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The domain ID of the environment action.
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 accepts the following data in JSON format.
- description
-
The description of the environment action.
Type: String
Required: No
- name
-
The name of the environment action.
Type: String
Required: No
- 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.
Required: No
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 domain ID of the environment action.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
