SageMaker / Client / describe_lineage_group

describe_lineage_group#

SageMaker.Client.describe_lineage_group(**kwargs)#

Provides a list of properties for the requested lineage group. For more information, see `Cross-Account Lineage Tracking <https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html>`__in the Amazon SageMaker Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_lineage_group(
    LineageGroupName='string'
)
Parameters:

LineageGroupName (string) –

[REQUIRED]

The name of the lineage group.

Return type:

dict

Returns:

Response Syntax

{
    'LineageGroupName': 'string',
    'LineageGroupArn': 'string',
    'DisplayName': 'string',
    'Description': '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'
        }
    }
}

Response Structure

  • (dict) –

    • LineageGroupName (string) –

      The name of the lineage group.

    • LineageGroupArn (string) –

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

    • DisplayName (string) –

      The display name of the lineage group.

    • Description (string) –

      The description of the lineage group.

    • CreationTime (datetime) –

      The creation time of lineage group.

    • 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) –

      The last modified time of the lineage group.

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

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound