Skip to content

List Endpoints

sagemaker_list_endpoints R Documentation

Lists endpoints

Description

Lists endpoints.

Usage

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

Arguments

SortBy

Sorts the list of results. The default is CreationTime.

SortOrder

The sort order for results. The default is Descending.

NextToken

If the result of a list_endpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

MaxResults

The maximum number of endpoints to return in the response. This value defaults to 10.

NameContains

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

CreationTimeBefore

A filter that returns only endpoints that were created before the specified time (timestamp).

CreationTimeAfter

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

LastModifiedTimeBefore

A filter that returns only endpoints that were modified before the specified timestamp.

LastModifiedTimeAfter

A filter that returns only endpoints that were modified after the specified timestamp.

StatusEquals

A filter that returns only endpoints with the specified status.

Value

A list with the following syntax: 

list(
  Endpoints = list(
    list(
      EndpointName = "string",
      EndpointArn = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      EndpointStatus = "OutOfService"|"Creating"|"Updating"|"SystemUpdating"|"RollingBack"|"InService"|"Deleting"|"Failed"|"UpdateRollbackFailed"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_endpoints(
  SortBy = "Name"|"CreationTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  NameContains = "string",
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  StatusEquals = "OutOfService"|"Creating"|"Updating"|"SystemUpdating"|"RollingBack"|"InService"|"Deleting"|"Failed"|"UpdateRollbackFailed"
)