SageMaker / Paginator / ListAppImageConfigs

ListAppImageConfigs#

class SageMaker.Paginator.ListAppImageConfigs#
paginator = client.get_paginator('list_app_image_configs')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    NameContains='string',
    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 filter that returns only AppImageConfigs whose name contains the specified string.

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

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

  • ModifiedTimeBefore (datetime) – A filter that returns only AppImageConfigs modified on or before the specified time.

  • ModifiedTimeAfter (datetime) – A filter that returns only AppImageConfigs modified on or 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

{
    'AppImageConfigs': [
        {
            'AppImageConfigArn': 'string',
            'AppImageConfigName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'KernelGatewayImageConfig': {
                'KernelSpecs': [
                    {
                        'Name': 'string',
                        'DisplayName': 'string'
                    },
                ],
                'FileSystemConfig': {
                    'MountPath': 'string',
                    'DefaultUid': 123,
                    'DefaultGid': 123
                }
            },
            'JupyterLabAppImageConfig': {
                'FileSystemConfig': {
                    'MountPath': 'string',
                    'DefaultUid': 123,
                    'DefaultGid': 123
                },
                'ContainerConfig': {
                    'ContainerArguments': [
                        'string',
                    ],
                    'ContainerEntrypoint': [
                        'string',
                    ],
                    'ContainerEnvironmentVariables': {
                        'string': 'string'
                    }
                }
            },
            'CodeEditorAppImageConfig': {
                'FileSystemConfig': {
                    'MountPath': 'string',
                    'DefaultUid': 123,
                    'DefaultGid': 123
                },
                'ContainerConfig': {
                    'ContainerArguments': [
                        'string',
                    ],
                    'ContainerEntrypoint': [
                        'string',
                    ],
                    'ContainerEnvironmentVariables': {
                        'string': 'string'
                    }
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    • AppImageConfigs (list) –

      A list of AppImageConfigs and their properties.

      • (dict) –

        The configuration for running a SageMaker image as a KernelGateway app.

        • AppImageConfigArn (string) –

          The ARN of the AppImageConfig.

        • AppImageConfigName (string) –

          The name of the AppImageConfig. Must be unique to your account.

        • CreationTime (datetime) –

          When the AppImageConfig was created.

        • LastModifiedTime (datetime) –

          When the AppImageConfig was last modified.

        • KernelGatewayImageConfig (dict) –

          The configuration for the file system and kernels in the SageMaker image.

          • KernelSpecs (list) –

            The specification of the Jupyter kernels in the image.

            • (dict) –

              The specification of a Jupyter kernel.

              • Name (string) –

                The name of the Jupyter kernel in the image. This value is case sensitive.

              • DisplayName (string) –

                The display name of the kernel.

          • FileSystemConfig (dict) –

            The Amazon Elastic File System storage configuration for a SageMaker image.

            • MountPath (string) –

              The path within the image to mount the user’s EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

            • DefaultUid (integer) –

              The default POSIX user ID (UID). If not specified, defaults to 1000.

            • DefaultGid (integer) –

              The default POSIX group ID (GID). If not specified, defaults to 100.

        • JupyterLabAppImageConfig (dict) –

          The configuration for the file system and the runtime, such as the environment variables and entry point.

          • FileSystemConfig (dict) –

            The Amazon Elastic File System storage configuration for a SageMaker image.

            • MountPath (string) –

              The path within the image to mount the user’s EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

            • DefaultUid (integer) –

              The default POSIX user ID (UID). If not specified, defaults to 1000.

            • DefaultGid (integer) –

              The default POSIX group ID (GID). If not specified, defaults to 100.

          • ContainerConfig (dict) –

            The configuration used to run the application image container.

            • ContainerArguments (list) –

              The arguments for the container when you’re running the application.

              • (string) –

            • ContainerEntrypoint (list) –

              The entrypoint used to run the application in the container.

              • (string) –

            • ContainerEnvironmentVariables (dict) –

              The environment variables to set in the container

              • (string) –

                • (string) –

        • CodeEditorAppImageConfig (dict) –

          The configuration for the file system and the runtime, such as the environment variables and entry point.

          • FileSystemConfig (dict) –

            The Amazon Elastic File System storage configuration for a SageMaker image.

            • MountPath (string) –

              The path within the image to mount the user’s EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

            • DefaultUid (integer) –

              The default POSIX user ID (UID). If not specified, defaults to 1000.

            • DefaultGid (integer) –

              The default POSIX group ID (GID). If not specified, defaults to 100.

          • ContainerConfig (dict) –

            The configuration used to run the application image container.

            • ContainerArguments (list) –

              The arguments for the container when you’re running the application.

              • (string) –

            • ContainerEntrypoint (list) –

              The entrypoint used to run the application in the container.

              • (string) –

            • ContainerEnvironmentVariables (dict) –

              The environment variables to set in the container

              • (string) –

                • (string) –