DescribeAppImageConfig - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeAppImageConfig

Describes an AppImageConfig.

Request Syntax

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

AppImageConfigName

The name of the AppImageConfig to describe.

Type: String

Length Constraints: Maximum length of 63.

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

Required: Yes

Response Syntax

{ "AppImageConfigArn": "string", "AppImageConfigName": "string", "CodeEditorAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "CreationTime": number, "JupyterLabAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "KernelGatewayImageConfig": { "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" }, "KernelSpecs": [ { "DisplayName": "string", "Name": "string" } ] }, "LastModifiedTime": number }

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.

AppImageConfigArn

The ARN of the AppImageConfig.

Type: String

Length Constraints: Maximum length of 256.

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

AppImageConfigName

The name of the AppImageConfig.

Type: String

Length Constraints: Maximum length of 63.

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

CodeEditorAppImageConfig

The configuration of the Code Editor app.

Type: CodeEditorAppImageConfig object

CreationTime

When the AppImageConfig was created.

Type: Timestamp

JupyterLabAppImageConfig

The configuration of the JupyterLab app.

Type: JupyterLabAppImageConfig object

KernelGatewayImageConfig

The configuration of a KernelGateway app.

Type: KernelGatewayImageConfig object

LastModifiedTime

When the AppImageConfig was last modified.

Type: Timestamp

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 Amazon SDKs, see the following: