actions

Creates, updates, deletes, gets or lists an actions resource.

Overview

Name	actions
Type	Resource
Id	aws.sagemaker.actions

Fields

The following fields are returned by SELECT queries:

describe_action

Name	Datatype	Description
action_arn	string	The Amazon Resource Name (ARN) of the action. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:action/.*</code>)
action_name	string	The name of the action. (pattern: <code>(arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})</code>)
action_type	string	The type of the action.
created_by	object	Information about the user who created or modified a SageMaker resource.
creation_time	string (date-time)	When the action was created.
description	string	The description of the action. (pattern: <code>.*</code>)
last_modified_by	object	Information about the user who created or modified a SageMaker resource.
last_modified_time	string (date-time)	When the action was last modified.
lineage_group_arn	string	The Amazon Resource Name (ARN) of the lineage group. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:lineage-group/.*</code>)
metadata_properties	object	Metadata properties of the tracking entity, trial, or trial component.
properties	object	A list of the action's properties.
source	object	The source of the action.
status	string	The status of the action. (Unknown, InProgress, Completed, Failed, Stopping, Stopped)

list_actions

Name	Datatype	Description
action_arn	string	The Amazon Resource Name (ARN) of the action. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:action/.*</code>)
action_name	string	The name of the action. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}</code>)
action_type	string	The type of the action.
creation_time	string (date-time)	When the action was created.
last_modified_time	string (date-time)	When the action was last modified.
source	object	The source of the action.
status	string	The status of the action. (Unknown, InProgress, Completed, Failed, Stopping, Stopped)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_action	select	region		Describes an action.
list_actions	select	region		Lists the actions in your account and their properties.
create_action	insert	region, ActionName, ActionType		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.
update_action	update	region, ActionName		Updates an action.
delete_action	delete	region		Deletes an action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_action

Describes an action.

SELECT
action_arn,
action_name,
action_type,
created_by,
creation_time,
description,
last_modified_by,
last_modified_time,
lineage_group_arn,
metadata_properties,
properties,
source,
status
FROM aws.sagemaker.actions
WHERE region = '{{ region }}' -- required
;

list_actions

Lists the actions in your account and their properties.

SELECT
action_arn,
action_name,
action_type,
creation_time,
last_modified_time,
source,
status
FROM aws.sagemaker.actions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_action

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.

INSERT INTO aws.sagemaker.actions (
ActionName,
Source,
ActionType,
Description,
Status,
Properties,
MetadataProperties,
Tags,
region
)
SELECT 
'{{ ActionName }}' /* required */,
'{{ Source }}',
'{{ ActionType }}' /* required */,
'{{ Description }}',
'{{ Status }}',
'{{ Properties }}',
'{{ MetadataProperties }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
action_arn
;

Manifest

# Description fields are for documentation purposes
- name: actions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the actions resource.
  - name: ActionName
    value: "{{ ActionName }}"
    description: |
      The name of the action. Must be unique to your account in an Amazon Web Services Region.
  - name: Source
    description: |
      The source type, ID, and URI.
    value:
      SourceUri: "{{ SourceUri }}"
      SourceType: "{{ SourceType }}"
      SourceId: "{{ SourceId }}"
  - name: ActionType
    value: "{{ ActionType }}"
    description: |
      The action type.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the action.
  - name: Status
    value: "{{ Status }}"
    description: |
      The status of the action.
    valid_values: ['Unknown', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped']
  - name: Properties
    value: "{{ Properties }}"
    description: |
      A list of properties to add to the action.
  - name: MetadataProperties
    description: |
      Metadata properties of the tracking entity, trial, or trial component.
    value:
      CommitId: "{{ CommitId }}"
      Repository: "{{ Repository }}"
      GeneratedBy: "{{ GeneratedBy }}"
      ProjectId: "{{ ProjectId }}"
  - name: Tags
    description: |
      A list of tags to apply to the action.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_action

Updates an action.

UPDATE aws.sagemaker.actions
SET 
ActionName = '{{ ActionName }}',
Description = '{{ Description }}',
Status = '{{ Status }}',
Properties = '{{ Properties }}',
PropertiesToRemove = '{{ PropertiesToRemove }}'
WHERE 
region = '{{ region }}' --required
AND ActionName = '{{ ActionName }}' --required
RETURNING
action_arn;

DELETE examples

delete_action

Deletes an action.

DELETE FROM aws.sagemaker.actions
WHERE region = '{{ region }}' --required
;