studio_lifecycle_configs

Creates, updates, deletes, gets or lists a studio_lifecycle_configs resource.

Overview

Name	studio_lifecycle_configs
Type	Resource
Id	aws.sagemaker.studio_lifecycle_configs

Fields

The following fields are returned by SELECT queries:

describe_studio_lifecycle_config

Name	Datatype	Description
creation_time	string (date-time)	The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
last_modified_time	string (date-time)	This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.
studio_lifecycle_config_app_type	string	The App type that the Lifecycle Configuration is attached to. (JupyterServer, KernelGateway, CodeEditor, JupyterLab)
studio_lifecycle_config_arn	string	The ARN of the Lifecycle Configuration to describe. (pattern: <code>(arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:studio-lifecycle-config/.*|None)</code>)
studio_lifecycle_config_content	string	The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. (pattern: <code>[\S\s]+</code>)
studio_lifecycle_config_name	string	The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

list_studio_lifecycle_configs

Name	Datatype	Description
creation_time	string (date-time)	The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
last_modified_time	string (date-time)	This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.
studio_lifecycle_config_app_type	string	The App type to which the Lifecycle Configuration is attached. (JupyterServer, KernelGateway, CodeEditor, JupyterLab)
studio_lifecycle_config_arn	string	The Amazon Resource Name (ARN) of the Lifecycle Configuration. (pattern: <code>(arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:studio-lifecycle-config/.*|None)</code>)
studio_lifecycle_config_name	string	The name of the Amazon SageMaker AI Studio Lifecycle Configuration. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_studio_lifecycle_config	select	region		Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
list_studio_lifecycle_configs	select	region		Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.
create_studio_lifecycle_config	insert	region, StudioLifecycleConfigName, StudioLifecycleConfigContent, StudioLifecycleConfigAppType		Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
delete_studio_lifecycle_config	delete	region		Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_studio_lifecycle_config

Describes the Amazon SageMaker AI Studio Lifecycle Configuration.

SELECT
creation_time,
last_modified_time,
studio_lifecycle_config_app_type,
studio_lifecycle_config_arn,
studio_lifecycle_config_content,
studio_lifecycle_config_name
FROM aws.sagemaker.studio_lifecycle_configs
WHERE region = '{{ region }}' -- required
;

list_studio_lifecycle_configs

Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.

SELECT
creation_time,
last_modified_time,
studio_lifecycle_config_app_type,
studio_lifecycle_config_arn,
studio_lifecycle_config_name
FROM aws.sagemaker.studio_lifecycle_configs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_studio_lifecycle_config

Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.

INSERT INTO aws.sagemaker.studio_lifecycle_configs (
StudioLifecycleConfigName,
StudioLifecycleConfigContent,
StudioLifecycleConfigAppType,
Tags,
region
)
SELECT 
'{{ StudioLifecycleConfigName }}' /* required */,
'{{ StudioLifecycleConfigContent }}' /* required */,
'{{ StudioLifecycleConfigAppType }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
studio_lifecycle_config_arn
;

Manifest

# Description fields are for documentation purposes
- name: studio_lifecycle_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the studio_lifecycle_configs resource.
  - name: StudioLifecycleConfigName
    value: "{{ StudioLifecycleConfigName }}"
    description: |
      The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.
  - name: StudioLifecycleConfigContent
    value: "{{ StudioLifecycleConfigContent }}"
    description: |
      The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded.
  - name: StudioLifecycleConfigAppType
    value: "{{ StudioLifecycleConfigAppType }}"
    description: |
      The App type that the Lifecycle Configuration is attached to.
    valid_values: ['JupyterServer', 'KernelGateway', 'CodeEditor', 'JupyterLab']
  - name: Tags
    description: |
      Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_studio_lifecycle_config

Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

DELETE FROM aws.sagemaker.studio_lifecycle_configs
WHERE region = '{{ region }}' --required
;