ListEndpoints

Lists endpoints.

{
   "[CreationTimeAfter](#SageMaker-ListEndpoints-request-CreationTimeAfter)": number,
   "[CreationTimeBefore](#SageMaker-ListEndpoints-request-CreationTimeBefore)": number,
   "[LastModifiedTimeAfter](#SageMaker-ListEndpoints-request-LastModifiedTimeAfter)": number,
   "[LastModifiedTimeBefore](#SageMaker-ListEndpoints-request-LastModifiedTimeBefore)": number,
   "[MaxResults](#SageMaker-ListEndpoints-request-MaxResults)": number,
   "[NameContains](#SageMaker-ListEndpoints-request-NameContains)": "string",
   "[NextToken](#SageMaker-ListEndpoints-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListEndpoints-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListEndpoints-request-SortOrder)": "string",
   "[StatusEquals](#SageMaker-ListEndpoints-request-StatusEquals)": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

** CreationTimeAfter ** A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
Type: Timestamp
Required: No

** CreationTimeBefore ** A filter that returns only endpoints that were created before the specified time (timestamp).
Type: Timestamp
Required: No

** LastModifiedTimeAfter ** A filter that returns only endpoints that were modified after the specified timestamp.
Type: Timestamp
Required: No

** LastModifiedTimeBefore ** A filter that returns only endpoints that were modified before the specified timestamp.
Type: Timestamp
Required: No

** MaxResults ** The maximum number of endpoints to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No

** NameContains ** A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern: [a-zA-Z0-9-]+
Required: No

** NextToken ** If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*
Required: No

** SortBy ** Sorts the list of results. The default is CreationTime.
Type: String
Valid Values:Name | CreationTime | Status
Required: No

** SortOrder ** The sort order for results. The default is Descending.
Type: String
Valid Values:Ascending | Descending
Required: No

{
   "[Endpoints](#SageMaker-ListEndpoints-response-Endpoints)": [ 
      { 
         "[CreationTime](API_EndpointSummary.md#SageMaker-Type-EndpointSummary-CreationTime)": number,
         "[EndpointArn](API_EndpointSummary.md#SageMaker-Type-EndpointSummary-EndpointArn)": "string",
         "[EndpointName](API_EndpointSummary.md#SageMaker-Type-EndpointSummary-EndpointName)": "string",
         "[EndpointStatus](API_EndpointSummary.md#SageMaker-Type-EndpointSummary-EndpointStatus)": "string",
         "[LastModifiedTime](API_EndpointSummary.md#SageMaker-Type-EndpointSummary-LastModifiedTime)": number
      }
   ],
   "[NextToken](#SageMaker-ListEndpoints-response-NextToken)": "string"
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

** Endpoints ** An array or endpoint objects.
Type: Array of EndpointSummary objects

** NextToken ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*

For information about the errors that are common to all actions, see Common Errors.

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2