SageMaker / Client / describe_action

describe_action#

SageMaker.Client.describe_action(**kwargs)#

Describes an action.

See also: AWS API Documentation

Request Syntax

response = client.describe_action(
    ActionName='string'
)
Parameters:

ActionName (string) –

[REQUIRED]

The name of the action to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ActionName': 'string',
    'ActionArn': 'string',
    'Source': {
        'SourceUri': 'string',
        'SourceType': 'string',
        'SourceId': 'string'
    },
    'ActionType': 'string',
    'Description': 'string',
    'Status': 'Unknown'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    'Properties': {
        'string': 'string'
    },
    'CreationTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'MetadataProperties': {
        'CommitId': 'string',
        'Repository': 'string',
        'GeneratedBy': 'string',
        'ProjectId': 'string'
    },
    'LineageGroupArn': 'string'
}

Response Structure

  • (dict) –

    • ActionName (string) –

      The name of the action.

    • ActionArn (string) –

      The Amazon Resource Name (ARN) of the action.

    • Source (dict) –

      The source of the action.

      • SourceUri (string) –

        The URI of the source.

      • SourceType (string) –

        The type of the source.

      • SourceId (string) –

        The ID of the source.

    • ActionType (string) –

      The type of the action.

    • Description (string) –

      The description of the action.

    • Status (string) –

      The status of the action.

    • Properties (dict) –

      A list of the action’s properties.

      • (string) –

        • (string) –

    • CreationTime (datetime) –

      When the action was created.

    • CreatedBy (dict) –

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

      • UserProfileArn (string) –

        The Amazon Resource Name (ARN) of the user’s profile.

      • UserProfileName (string) –

        The name of the user’s profile.

      • DomainId (string) –

        The domain associated with the user.

      • IamIdentity (dict) –

        The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the IAM identity.

        • PrincipalId (string) –

          The ID of the principal that assumes the IAM identity.

        • SourceIdentity (string) –

          The person or application which assumes the IAM identity.

    • LastModifiedTime (datetime) –

      When the action was last modified.

    • LastModifiedBy (dict) –

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

      • UserProfileArn (string) –

        The Amazon Resource Name (ARN) of the user’s profile.

      • UserProfileName (string) –

        The name of the user’s profile.

      • DomainId (string) –

        The domain associated with the user.

      • IamIdentity (dict) –

        The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the IAM identity.

        • PrincipalId (string) –

          The ID of the principal that assumes the IAM identity.

        • SourceIdentity (string) –

          The person or application which assumes the IAM identity.

    • 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.

    • LineageGroupArn (string) –

      The Amazon Resource Name (ARN) of the lineage group.

Exceptions