SageMaker / Client / list_app_image_configs

list_app_image_configs#

SageMaker.Client.list_app_image_configs(**kwargs)#

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

See also: AWS API Documentation

Request Syntax

response = client.list_app_image_configs(
    MaxResults=123,
    NextToken='string',
    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'
)
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 ListImages didn’t return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    '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
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      A token for getting the next set of AppImageConfigs, if there are any.

    • AppImageConfigs (list) –

      A list of AppImageConfigs and their properties.

      • (dict) –

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

        • AppImageConfigArn (string) –

          The Amazon Resource Name (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 (EFS) 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.