SageMaker / Client / list_studio_lifecycle_configs

list_studio_lifecycle_configs#

SageMaker.Client.list_studio_lifecycle_configs(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_studio_lifecycle_configs(
    MaxResults=123,
    NextToken='string',
    NameContains='string',
    AppTypeEquals='JupyterServer'|'KernelGateway'|'CodeEditor'|'JupyterLab',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    ModifiedTimeBefore=datetime(2015, 1, 1),
    ModifiedTimeAfter=datetime(2015, 1, 1),
    SortBy='CreationTime'|'LastModifiedTime'|'Name',
    SortOrder='Ascending'|'Descending'
)
Parameters:

  • MaxResults (integer) – The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

  • NextToken (string) – 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.

  • NameContains (string) – A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

  • AppTypeEquals (string) – A parameter to search for the App Type to which the Lifecycle Configuration is attached.

  • CreationTimeBefore (datetime) – A filter that returns only Lifecycle Configurations created on or before the specified time.

  • CreationTimeAfter (datetime) – A filter that returns only Lifecycle Configurations created on or after the specified time.

  • ModifiedTimeBefore (datetime) – A filter that returns only Lifecycle Configurations modified before the specified time.

  • ModifiedTimeAfter (datetime) – A filter that returns only Lifecycle Configurations modified after the specified time.

  • SortBy (string) – The property used to sort results. The default value is CreationTime.

  • SortOrder (string) – The sort order. The default value is Descending.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'StudioLifecycleConfigs': [
        {
            'StudioLifecycleConfigArn': 'string',
            'StudioLifecycleConfigName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'StudioLifecycleConfigAppType': 'JupyterServer'|'KernelGateway'|'CodeEditor'|'JupyterLab'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      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 (list) –

      A list of Lifecycle Configurations and their properties.

      • (dict) –

        Details of the Amazon SageMaker Studio Lifecycle Configuration.

        • StudioLifecycleConfigArn (string) –

          The Amazon Resource Name (ARN) of the Lifecycle Configuration.

        • StudioLifecycleConfigName (string) –

          The name of the Amazon SageMaker Studio Lifecycle Configuration.

        • CreationTime (datetime) –

          The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

        • LastModifiedTime (datetime) –

          This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

        • StudioLifecycleConfigAppType (string) –

          The App type to which the Lifecycle Configuration is attached.

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse