describe_trial

SageMaker.Client.describe_trial(**kwargs)

Provides a list of a trial's properties.

See also: AWS API Documentation

Request Syntax

response = client.describe_trial(
    TrialName='string'
)
Parameters
TrialName (string) --

[REQUIRED]

The name of the trial to describe.

Return type
dict
Returns
Response Syntax
{
    'TrialName': 'string',
    'TrialArn': 'string',
    'DisplayName': 'string',
    'ExperimentName': 'string',
    'Source': {
        'SourceArn': 'string',
        'SourceType': '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'
    }
}

Response Structure

  • (dict) --
    • TrialName (string) --

      The name of the trial.

    • TrialArn (string) --

      The Amazon Resource Name (ARN) of the trial.

    • DisplayName (string) --

      The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

    • ExperimentName (string) --

      The name of the experiment the trial is part of.

    • Source (dict) --

      The Amazon Resource Name (ARN) of the source and, optionally, the job type.

      • SourceArn (string) --

        The Amazon Resource Name (ARN) of the source.

      • SourceType (string) --

        The source job type.

    • CreationTime (datetime) --

      When the trial was created.

    • CreatedBy (dict) --

      Who created the trial.

      • 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 trial was last modified.

    • LastModifiedBy (dict) --

      Who last modified the trial.

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

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound