UpdateEnvironmentActionCommand

Updates an environment action.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, UpdateEnvironmentActionCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateEnvironmentActionCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateEnvironmentActionInput
  domainIdentifier: "STRING_VALUE", // required
  environmentIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  parameters: { // ActionParameters Union: only one key present
    awsConsoleLink: { // AwsConsoleLinkParameters
      uri: "STRING_VALUE",
    },
  },
  name: "STRING_VALUE",
  description: "STRING_VALUE",
};
const command = new UpdateEnvironmentActionCommand(input);
const response = await client.send(command);
// { // UpdateEnvironmentActionOutput
//   domainId: "STRING_VALUE", // required
//   environmentId: "STRING_VALUE", // required
//   id: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   parameters: { // ActionParameters Union: only one key present
//     awsConsoleLink: { // AwsConsoleLinkParameters
//       uri: "STRING_VALUE",
//     },
//   },
//   description: "STRING_VALUE",
// };

UpdateEnvironmentActionCommand Input

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The domain ID of the environment action.

environmentIdentifier
Required
string | undefined

The environment ID of the environment action.

identifier
Required
string | undefined

The ID of the environment action.

description
string | undefined

The description of the environment action.

name
string | undefined

The name of the environment action.

parameters
ActionParameters | undefined

The parameters of the environment action.

UpdateEnvironmentActionCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
Required
string | undefined

The domain ID of the environment action.

environmentId
Required
string | undefined

The environment ID of the environment action.

id
Required
string | undefined

The ID of the environment action.

name
Required
string | undefined

The name of the environment action.

parameters
Required
ActionParameters | undefined

The parameters of the environment action.

description
string | undefined

The description of the environment action.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.