SageMaker / Client / describe_context

describe_context

SageMaker.Client.describe_context(**kwargs)

Describes a context.

See also: AWS API Documentation

Request Syntax

response = client.describe_context(
    ContextName='string'
)

Parameters:

ContextName (string) –

[REQUIRED]

The name of the context to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ContextName': 'string',
    'ContextArn': 'string',
    'Source': {
        'SourceUri': 'string',
        'SourceType': 'string',
        'SourceId': 'string'
    },
    'ContextType': 'string',
    'Description': 'string',
    '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'
        }
    },
    'LineageGroupArn': 'string'
}

Response Structure

• (dict) –

  • ContextName (string) –

    The name of the context.

  • ContextArn (string) –

    The Amazon Resource Name (ARN) of the context.

  • Source (dict) –

    The source of the context.

    • SourceUri (string) –

      The URI of the source.

    • SourceType (string) –

      The type of the source.

    • SourceId (string) –

      The ID of the source.

  • ContextType (string) –

    The type of the context.

  • Description (string) –

    The description of the context.

  • Properties (dict) –

    A list of the context’s properties.

    • (string) –

      • (string) –

  • CreationTime (datetime) –

    When the context 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 context 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.

  • LineageGroupArn (string) –

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

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound