Skip to content

List Images

sagemaker_list_images R Documentation

Lists the images in your account and their properties

Description

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

Usage

sagemaker_list_images(CreationTimeAfter, CreationTimeBefore,
  LastModifiedTimeAfter, LastModifiedTimeBefore, MaxResults, NameContains,
  NextToken, SortBy, SortOrder)

Arguments

CreationTimeAfter

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

CreationTimeBefore

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

LastModifiedTimeAfter

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

LastModifiedTimeBefore

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

MaxResults

The maximum number of images to return in the response. The default value is 10.

NameContains

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

NextToken

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

SortBy

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

SortOrder

The sort order. The default value is DESCENDING.

Value

A list with the following syntax: 

list(
  Images = list(
    list(
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      Description = "string",
      DisplayName = "string",
      FailureReason = "string",
      ImageArn = "string",
      ImageName = "string",
      ImageStatus = "CREATING"|"CREATED"|"CREATE_FAILED"|"UPDATING"|"UPDATE_FAILED"|"DELETING"|"DELETE_FAILED",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_images(
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  MaxResults = 123,
  NameContains = "string",
  NextToken = "string",
  SortBy = "CREATION_TIME"|"LAST_MODIFIED_TIME"|"IMAGE_NAME",
  SortOrder = "ASCENDING"|"DESCENDING"
)