SageMaker / Client / describe_experiment
describe_experiment#
- SageMaker.Client.describe_experiment(**kwargs)#
Provides a list of an experiment’s properties.
See also: AWS API Documentation
Request Syntax
response = client.describe_experiment( ExperimentName='string' )
- Parameters:
ExperimentName (string) –
[REQUIRED]
The name of the experiment to describe.
- Return type:
dict
- Returns:
Response Syntax
{ 'ExperimentName': 'string', 'ExperimentArn': 'string', 'DisplayName': 'string', 'Source': { 'SourceArn': 'string', 'SourceType': '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) –
ExperimentName (string) –
The name of the experiment.
ExperimentArn (string) –
The Amazon Resource Name (ARN) of the experiment.
DisplayName (string) –
The name of the experiment as displayed. If
DisplayName
isn’t specified,ExperimentName
is displayed.Source (dict) –
The Amazon Resource Name (ARN) of the source and, optionally, the type.
SourceArn (string) –
The Amazon Resource Name (ARN) of the source.
SourceType (string) –
The source type.
Description (string) –
The description of the experiment.
CreationTime (datetime) –
When the experiment was created.
CreatedBy (dict) –
Who created the experiment.
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 experiment was last modified.
LastModifiedBy (dict) –
Who last modified the experiment.
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