SageMaker / Paginator / ListStudioLifecycleConfigs

ListStudioLifecycleConfigs#

class SageMaker.Paginator.ListStudioLifecycleConfigs#
paginator = client.get_paginator('list_studio_lifecycle_configs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SageMaker.Client.list_studio_lifecycle_configs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    NameContains='string',
    AppTypeEquals='JupyterServer'|'KernelGateway',
    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',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • 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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • StudioLifecycleConfigs (list) –

      A list of Lifecycle Configurations and their properties.

      • (dict) –

        Details of the Studio Lifecycle Configuration.

        • StudioLifecycleConfigArn (string) –

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

        • StudioLifecycleConfigName (string) –

          The name of the Studio Lifecycle Configuration.

        • CreationTime (datetime) –

          The creation time of the Studio Lifecycle Configuration.

        • LastModifiedTime (datetime) –

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

        • StudioLifecycleConfigAppType (string) –

          The App type to which the Lifecycle Configuration is attached.