- 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.
UpdateActionCommand
Updates an action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SageMakerClient, UpdateActionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, UpdateActionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // UpdateActionRequest
ActionName: "STRING_VALUE", // required
Description: "STRING_VALUE",
Status: "Unknown" || "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped",
Properties: { // LineageEntityParameters
"<keys>": "STRING_VALUE",
},
PropertiesToRemove: [ // ListLineageEntityParameterKey
"STRING_VALUE",
],
};
const command = new UpdateActionCommand(input);
const response = await client.send(command);
// { // UpdateActionResponse
// ActionArn: "STRING_VALUE",
// };
UpdateActionCommand Input
See UpdateActionCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ActionName Required | string | undefined | The name of the action to update. |
Description | string | undefined | The new description for the action. |
Properties | Record<string, string> | undefined | The new list of properties. Overwrites the current property list. |
PropertiesToRemove | string[] | undefined | A list of properties to remove. |
Status | ActionStatus | undefined | The new status for the action. |
UpdateActionCommand Output
See UpdateActionCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ActionArn | string | undefined | The Amazon Resource Name (ARN) of the action. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | There was a conflict when you attempted to modify a SageMaker entity such as an |
ResourceNotFound | client | Resource being access is not found. |
SageMakerServiceException | Base exception class for all service exceptions from SageMaker service. |