ListActionsCommand

Suggest an Edit

Lists the actions in your account and their properties.

Example Syntax

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

import { SageMakerClient, ListActionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, ListActionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // ListActionsRequest
  SourceUri: "STRING_VALUE",
  ActionType: "STRING_VALUE",
  CreatedAfter: new Date("TIMESTAMP"),
  CreatedBefore: new Date("TIMESTAMP"),
  SortBy: "Name" || "CreationTime",
  SortOrder: "Ascending" || "Descending",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListActionsCommand(input);
const response = await client.send(command);
// { // ListActionsResponse
//   ActionSummaries: [ // ActionSummaries
//     { // ActionSummary
//       ActionArn: "STRING_VALUE",
//       ActionName: "STRING_VALUE",
//       Source: { // ActionSource
//         SourceUri: "STRING_VALUE", // required
//         SourceType: "STRING_VALUE",
//         SourceId: "STRING_VALUE",
//       },
//       ActionType: "STRING_VALUE",
//       Status: "Unknown" || "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped",
//       CreationTime: new Date("TIMESTAMP"),
//       LastModifiedTime: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListActionsCommand Input

See ListActionsCommandInput for more details

Parameter
Type
Description
ActionType
string | undefined

A filter that returns only actions of the specified type.

CreatedAfter
Date | undefined

A filter that returns only actions created on or after the specified time.

CreatedBefore
Date | undefined

A filter that returns only actions created on or before the specified time.

MaxResults
number | undefined

The maximum number of actions to return in the response. The default value is 10.

NextToken
string | undefined

If the previous call to ListActions didn't return the full set of actions, the call returns a token for getting the next set of actions.

SortBy
SortActionsBy | undefined

The property used to sort results. The default value is CreationTime.

SortOrder
SortOrder | undefined

The sort order. The default value is Descending.

SourceUri
string | undefined

A filter that returns only actions with the specified source URI.

ListActionsCommand Output

See ListActionsCommandOutput for details

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

A list of actions and their properties.

NextToken
string | undefined

A token for getting the next set of actions, if there are any.

Throws

Name
Fault
Details
ResourceNotFound
client

Resource being access is not found.

SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.