DescribeExperiment - Amazon SageMaker Service

DescribeExperiment

Provides a list of an experiment's properties.

Request Syntax

{ "ExperimentName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ExperimentName

The name of the experiment to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 82.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Syntax

{ "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "DisplayName": "string", "ExperimentArn": "string", "ExperimentName": "string", "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "Source": { "SourceArn": "string", "SourceType": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedBy

Who created the experiment.

Type: UserContext object

CreationTime

When the experiment was created.

Type: Timestamp

Description

The description of the experiment.

Type: String

Length Constraints: Maximum length of 3072.

Pattern: .*

DisplayName

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 82.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

ExperimentArn

The Amazon Resource Name (ARN) of the experiment.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment/.*

ExperimentName

The name of the experiment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 82.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

LastModifiedBy

Who last modified the experiment.

Type: UserContext object

LastModifiedTime

When the experiment was last modified.

Type: Timestamp

Source

The ARN of the source and, optionally, the type.

Type: ExperimentSource object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: