ListEnvironmentActionsCommand

Suggest an Edit

Lists existing environment actions.

Example Syntax

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

import { DataZoneClient, ListEnvironmentActionsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListEnvironmentActionsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListEnvironmentActionsInput
  domainIdentifier: "STRING_VALUE", // required
  environmentIdentifier: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListEnvironmentActionsCommand(input);
const response = await client.send(command);
// { // ListEnvironmentActionsOutput
//   items: [ // ListEnvironmentActionSummaries
//     { // EnvironmentActionSummary
//       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",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListEnvironmentActionsCommand Input

See ListEnvironmentActionsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which the environment actions are listed.

environmentIdentifier
Required
string | undefined

The ID of the envrironment whose environment actions are listed.

maxResults
number | undefined

The maximum number of environment actions to return in a single call to ListEnvironmentActions. When the number of environment actions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

nextToken
string | undefined

When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

ListEnvironmentActionsCommand Output

See ListEnvironmentActionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
EnvironmentActionSummary[] | undefined

The results of ListEnvironmentActions.

nextToken
string | undefined

When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

Throws

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.

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.