- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetEnvironmentActionCommand
Gets the specified environment action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, GetEnvironmentActionCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetEnvironmentActionCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetEnvironmentActionInput
domainIdentifier: "STRING_VALUE", // required
environmentIdentifier: "STRING_VALUE", // required
identifier: "STRING_VALUE", // required
};
const command = new GetEnvironmentActionCommand(input);
const response = await client.send(command);
// { // GetEnvironmentActionOutput
// 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",
// };
GetEnvironmentActionCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The ID of the Amazon DataZone domain in which the |
environmentIdentifier Required | string | undefined | The environment ID of the environment action. |
identifier Required | string | undefined | The ID of the environment action |
GetEnvironmentActionCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
domainId Required | string | undefined | The ID of the Amazon DataZone domain in which the environment action lives. |
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 |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform 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. |