CreateEnvironmentActionCommand

Suggest an Edit

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

Example Syntax

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

import { DataZoneClient, CreateEnvironmentActionCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateEnvironmentActionCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateEnvironmentActionInput
  domainIdentifier: "STRING_VALUE", // required
  environmentIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  parameters: { // ActionParameters Union: only one key present
    awsConsoleLink: { // AwsConsoleLinkParameters
      uri: "STRING_VALUE",
    },
  },
  description: "STRING_VALUE",
};
const command = new CreateEnvironmentActionCommand(input);
const response = await client.send(command);
// { // CreateEnvironmentActionOutput
//   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",
// };

CreateEnvironmentActionCommand Input

See CreateEnvironmentActionCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

environmentIdentifier
Required
string | undefined

The ID of the environment in which the environment action is created.

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 that is being created in the environment.

CreateEnvironmentActionCommand Output

See CreateEnvironmentActionCommandOutput for details

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

The ID of the domain in which the environment action is created.

environmentId
Required
string | undefined

The ID of the environment in which the environment is created.

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.