# list-endpoints ## Description Lists endpoints. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListEndpoints) `list-endpoints` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument. When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `Endpoints` ## Synopsis ``` list-endpoints [--sort-by ] [--sort-order ] [--name-contains ] [--creation-time-before ] [--creation-time-after ] [--last-modified-time-before ] [--last-modified-time-after ] [--status-equals ] [--starting-token ] [--page-size ] [--max-items ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] ``` ## Options `--sort-by` (string) > Sorts the list of results. The default is `CreationTime` . > Possible values: > * `Name` > * `CreationTime` > * `Status` `--sort-order` (string) > The sort order for results. The default is `Descending` . > Possible values: > * `Ascending` > * `Descending` `--name-contains` (string) > A string in endpoint names. This filter returns only endpoints whose name contains the specified string. > Constraints: > * min: `0` > * max: `63` > * pattern: `[a-zA-Z0-9-]+` `--creation-time-before` (timestamp) > A filter that returns only endpoints that were created before the specified time (timestamp). `--creation-time-after` (timestamp) > A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp). `--last-modified-time-before` (timestamp) > A filter that returns only endpoints that were modified before the specified timestamp. `--last-modified-time-after` (timestamp) > A filter that returns only endpoints that were modified after the specified timestamp. `--status-equals` (string) > A filter that returns only endpoints with the specified status. > Possible values: > * `OutOfService` > * `Creating` > * `Updating` > * `SystemUpdating` > * `RollingBack` > * `InService` > * `Deleting` > * `Failed` > * `UpdateRollbackFailed` `--starting-token` (string) > A token to specify where to start paginating. This is the `NextToken` from a previously truncated response. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--page-size` (integer) > The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . > Constraints: > * min: `1` > * max: `100` `--max-items` (integer) > The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced ## Output Endpoints -> (list) > An array or endpoint objects. > (structure) > > Provides summary information for an endpoint. > > EndpointName -> (string) [required] > > > The name of the endpoint. > > > Constraints: > > > * min: `0` > > > * max: `63` > > > * pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` > > EndpointArn -> (string) [required] > > > The Amazon Resource Name (ARN) of the endpoint. > > > Constraints: > > > * min: `20` > > > * max: `2048` > > > * pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.*` > > CreationTime -> (timestamp) [required] > > > A timestamp that shows when the endpoint was created. > > LastModifiedTime -> (timestamp) [required] > > > A timestamp that shows when the endpoint was last modified. > > EndpointStatus -> (string) [required] > > > The status of the endpoint. > > > * `OutOfService` : Endpoint is not available to take incoming requests. > > > * `Creating` : [CreateEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) is executing. > > > * `Updating` : [UpdateEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) or [UpdateEndpointWeightsAndCapacities](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) is executing. > > > * `SystemUpdating` : Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. > > > * `RollingBack` : Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an `InService` status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an [UpdateEndpointWeightsAndCapacities](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) call or when the [UpdateEndpointWeightsAndCapacities](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) operation is called explicitly. > > > * `InService` : Endpoint is available to process incoming requests. > > > * `Deleting` : [DeleteEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) is executing. > > > * `Failed` : Endpoint could not be created, updated, or re-scaled. Use `DescribeEndpointOutput$FailureReason` for information about the failure. [DeleteEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) is the only operation that can be performed on a failed endpoint. > > > To get a list of endpoints with a specified status, use the `StatusEquals` filter with a call to [ListEndpoints](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html) . > > > Possible values: > > > * `OutOfService` > > > * `Creating` > > > * `Updating` > > > * `SystemUpdating` > > > * `RollingBack` > > > * `InService` > > > * `Deleting` > > > * `Failed` > > > * `UpdateRollbackFailed` NextToken -> (string) > If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request. > Constraints: > * min: `0` > * max: `8192` > * pattern: `.*`