[ aws . sagemaker ]



Creates an action . An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--action-name <value>
--source <value>
--action-type <value>
[--description <value>]
[--status <value>]
[--properties <value>]
[--metadata-properties <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--action-name (string)

The name of the action. Must be unique to your account in an Amazon Web Services Region.

--source (structure)

The source type, ID, and URI.

SourceUri -> (string)

The URI of the source.

SourceType -> (string)

The type of the source.

SourceId -> (string)

The ID of the source.

Shorthand Syntax:


JSON Syntax:

  "SourceUri": "string",
  "SourceType": "string",
  "SourceId": "string"

--action-type (string)

The action type.

--description (string)

The description of the action.

--status (string)

The status of the action.

Possible values:

  • Unknown

  • InProgress

  • Completed

  • Failed

  • Stopping

  • Stopped

--properties (map)

A list of properties to add to the action.

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--metadata-properties (structure)

Metadata properties of the tracking entity, trial, or trial component.

CommitId -> (string)

The commit ID.

Repository -> (string)

The repository.

GeneratedBy -> (string)

The entity this entity was generated by.

ProjectId -> (string)

The project ID.

Shorthand Syntax:


JSON Syntax:

  "CommitId": "string",
  "Repository": "string",
  "GeneratedBy": "string",
  "ProjectId": "string"

--tags (list)

A list of tags to apply to the action.


A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources . For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy .

Key -> (string)

The tag key. Tag keys must be unique per resource.

Value -> (string)

The tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


ActionArn -> (string)

The Amazon Resource Name (ARN) of the action.