DescribeProject - Amazon SageMaker

DescribeProject

Describes the details of a project.

Request Syntax

{ "ProjectName": "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.

ProjectName

The name of the project to describe.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}

Required: Yes

Response Syntax

{ "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "ProjectArn": "string", "ProjectDescription": "string", "ProjectId": "string", "ProjectName": "string", "ProjectStatus": "string", "ServiceCatalogProvisionedProductDetails": { "ProvisionedProductId": "string", "ProvisionedProductStatusMessage": "string" }, "ServiceCatalogProvisioningDetails": { "PathId": "string", "ProductId": "string", "ProvisioningArtifactId": "string", "ProvisioningParameters": [ { "Key": "string", "Value": "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

Information about the user who created or modified an experiment, trial, or trial component.

Type: UserContext object

CreationTime

The time when the project was created.

Type: Timestamp

ProjectArn

The Amazon Resource Name (ARN) of the project.

Type: String

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

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

ProjectDescription

The description of the project.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*

ProjectId

The ID of the project.

Type: String

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

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

ProjectName

The name of the project.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}

ProjectStatus

The status of the project.

Type: String

Valid Values: Pending | CreateInProgress | CreateCompleted | CreateFailed | DeleteInProgress | DeleteFailed | DeleteCompleted

ServiceCatalogProvisionedProductDetails

Information about a provisioned service catalog product.

Type: ServiceCatalogProvisionedProductDetails object

ServiceCatalogProvisioningDetails

Information used to provision a service catalog product. For information, see What is AWS Service Catalog.

Type: ServiceCatalogProvisioningDetails object

Errors

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

See Also

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