Skip to content

List App Image Configs

sagemaker_list_app_image_configs R Documentation

Lists the AppImageConfigs in your account and their properties

Description

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.

Usage

sagemaker_list_app_image_configs(MaxResults, NextToken, NameContains,
  CreationTimeBefore, CreationTimeAfter, ModifiedTimeBefore,
  ModifiedTimeAfter, SortBy, SortOrder)

Arguments

MaxResults

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

If the previous call to list_images didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

NameContains

A filter that returns only AppImageConfigs whose name contains the specified string.

CreationTimeBefore

A filter that returns only AppImageConfigs created on or before the specified time.

CreationTimeAfter

A filter that returns only AppImageConfigs created on or after the specified time.

ModifiedTimeBefore

A filter that returns only AppImageConfigs modified on or before the specified time.

ModifiedTimeAfter

A filter that returns only AppImageConfigs modified on or after the specified time.

SortBy

The property used to sort results. The default value is CreationTime.

SortOrder

The sort order. The default value is Descending.

Value

A list with the following syntax:

list(
  NextToken = "string",
  AppImageConfigs = list(
    list(
      AppImageConfigArn = "string",
      AppImageConfigName = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      KernelGatewayImageConfig = list(
        KernelSpecs = list(
          list(
            Name = "string",
            DisplayName = "string"
          )
        ),
        FileSystemConfig = list(
          MountPath = "string",
          DefaultUid = 123,
          DefaultGid = 123
        )
      ),
      JupyterLabAppImageConfig = list(
        FileSystemConfig = list(
          MountPath = "string",
          DefaultUid = 123,
          DefaultGid = 123
        ),
        ContainerConfig = list(
          ContainerArguments = list(
            "string"
          ),
          ContainerEntrypoint = list(
            "string"
          ),
          ContainerEnvironmentVariables = list(
            "string"
          )
        )
      ),
      CodeEditorAppImageConfig = list(
        FileSystemConfig = list(
          MountPath = "string",
          DefaultUid = 123,
          DefaultGid = 123
        ),
        ContainerConfig = list(
          ContainerArguments = list(
            "string"
          ),
          ContainerEntrypoint = list(
            "string"
          ),
          ContainerEnvironmentVariables = list(
            "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$list_app_image_configs(
  MaxResults = 123,
  NextToken = "string",
  NameContains = "string",
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  ModifiedTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  ModifiedTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  SortBy = "CreationTime"|"LastModifiedTime"|"Name",
  SortOrder = "Ascending"|"Descending"
)