- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListStudioLifecycleConfigsCommand
Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SageMakerClient, ListStudioLifecycleConfigsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, ListStudioLifecycleConfigsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // ListStudioLifecycleConfigsRequest
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
NameContains: "STRING_VALUE",
AppTypeEquals: "JupyterServer" || "KernelGateway" || "CodeEditor" || "JupyterLab",
CreationTimeBefore: new Date("TIMESTAMP"),
CreationTimeAfter: new Date("TIMESTAMP"),
ModifiedTimeBefore: new Date("TIMESTAMP"),
ModifiedTimeAfter: new Date("TIMESTAMP"),
SortBy: "CreationTime" || "LastModifiedTime" || "Name",
SortOrder: "Ascending" || "Descending",
};
const command = new ListStudioLifecycleConfigsCommand(input);
const response = await client.send(command);
// { // ListStudioLifecycleConfigsResponse
// NextToken: "STRING_VALUE",
// StudioLifecycleConfigs: [ // StudioLifecycleConfigsList
// { // StudioLifecycleConfigDetails
// StudioLifecycleConfigArn: "STRING_VALUE",
// StudioLifecycleConfigName: "STRING_VALUE",
// CreationTime: new Date("TIMESTAMP"),
// LastModifiedTime: new Date("TIMESTAMP"),
// StudioLifecycleConfigAppType: "JupyterServer" || "KernelGateway" || "CodeEditor" || "JupyterLab",
// },
// ],
// };
ListStudioLifecycleConfigsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AppTypeEquals | StudioLifecycleConfigAppType | undefined | A parameter to search for the App Type to which the Lifecycle Configuration is attached. |
CreationTimeAfter | Date | undefined | A filter that returns only Lifecycle Configurations created on or after the specified time. |
CreationTimeBefore | Date | undefined | A filter that returns only Lifecycle Configurations created on or before the specified time. |
MaxResults | number | undefined | The total number of items to return in the response. If the total number of items available is more than the value specified, a |
ModifiedTimeAfter | Date | undefined | A filter that returns only Lifecycle Configurations modified after the specified time. |
ModifiedTimeBefore | Date | undefined | A filter that returns only Lifecycle Configurations modified before the specified time. |
NameContains | string | undefined | A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string. |
NextToken | string | undefined | If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations. |
SortBy | StudioLifecycleConfigSortKey | undefined | The property used to sort results. The default value is CreationTime. |
SortOrder | SortOrder | undefined | The sort order. The default value is Descending. |
ListStudioLifecycleConfigsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
NextToken | string | undefined | If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. |
StudioLifecycleConfigs | StudioLifecycleConfigDetails[] | undefined | A list of Lifecycle Configurations and their properties. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ResourceInUse | client | Resource being accessed is in use. |
SageMakerServiceException | Base exception class for all service exceptions from SageMaker service. |