ListEndpoints
Lists endpoints.
Request Syntax
{
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"LastModifiedTimeAfter": number,
"LastModifiedTimeBefore": number,
"MaxResults": number,
"NameContains": "string",
"NextToken": "string",
"SortBy": "string",
"SortOrder": "string",
"StatusEquals": "string"
}Request Parameters
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. This value defaults to 10.
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
ListEndpointsrequest was truncated, the response includes aNextToken. 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 | StatusRequired: No
- SortOrder
-
The sort order for results. The default is
Descending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that returns only endpoints with the specified status.
Type: String
Valid Values:
OutOfService | Creating | Updating | SystemUpdating | RollingBack | InService | Deleting | Failed | UpdateRollbackFailedRequired: No
Response Syntax
{
"Endpoints": [
{
"CreationTime": number,
"EndpointArn": "string",
"EndpointName": "string",
"EndpointStatus": "string",
"LastModifiedTime": number
}
],
"NextToken": "string"
}Response Elements
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, 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:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
