SageMaker / Client / create_action

create_action#

SageMaker.Client.create_action(**kwargs)#

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

Request Syntax

response = client.create_action(
    ActionName='string',
    Source={
        'SourceUri': 'string',
        'SourceType': 'string',
        'SourceId': 'string'
    },
    ActionType='string',
    Description='string',
    Status='Unknown'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    Properties={
        'string': 'string'
    },
    MetadataProperties={
        'CommitId': 'string',
        'Repository': 'string',
        'GeneratedBy': 'string',
        'ProjectId': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ActionName (string) –

    [REQUIRED]

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

  • Source (dict) –

    [REQUIRED]

    The source type, ID, and URI.

    • SourceUri (string) – [REQUIRED]

      The URI of the source.

    • SourceType (string) –

      The type of the source.

    • SourceId (string) –

      The ID of the source.

  • ActionType (string) –

    [REQUIRED]

    The action type.

  • Description (string) – The description of the action.

  • Status (string) – The status of the action.

  • Properties (dict) –

    A list of properties to add to the action.

    • (string) –

      • (string) –

  • MetadataProperties (dict) –

    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.

  • Tags (list) –

    A list of tags to apply to the action.

    • (dict) –

      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) – [REQUIRED]

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

      • Value (string) – [REQUIRED]

        The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'ActionArn': 'string'
}

Response Structure

  • (dict) –

    • ActionArn (string) –

      The Amazon Resource Name (ARN) of the action.

Exceptions

  • SageMaker.Client.exceptions.ResourceLimitExceeded