Class: Aws::SageMaker::Types::EndpointSummary

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

Provides summary information for an endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

A timestamp that shows when the endpoint was created.

Returns:

  • (Time)


20095
20096
20097
20098
20099
20100
20101
20102
20103
# File 'lib/aws-sdk-sagemaker/types.rb', line 20095

class EndpointSummary < Struct.new(
  :endpoint_name,
  :endpoint_arn,
  :creation_time,
  :last_modified_time,
  :endpoint_status)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_arnString

The Amazon Resource Name (ARN) of the endpoint.

Returns:

  • (String)


20095
20096
20097
20098
20099
20100
20101
20102
20103
# File 'lib/aws-sdk-sagemaker/types.rb', line 20095

class EndpointSummary < Struct.new(
  :endpoint_name,
  :endpoint_arn,
  :creation_time,
  :last_modified_time,
  :endpoint_status)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_nameString

The name of the endpoint.

Returns:

  • (String)


20095
20096
20097
20098
20099
20100
20101
20102
20103
# File 'lib/aws-sdk-sagemaker/types.rb', line 20095

class EndpointSummary < Struct.new(
  :endpoint_name,
  :endpoint_arn,
  :creation_time,
  :last_modified_time,
  :endpoint_status)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_statusString

The status of the endpoint.

  • ‘OutOfService`: Endpoint is not available to take incoming requests.

  • ‘Creating`: [CreateEndpoint] is executing.

  • ‘Updating`: [UpdateEndpoint] or

    UpdateEndpointWeightsAndCapacities][3

    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][3

    call or when the

    UpdateEndpointWeightsAndCapacities][3

    operation is called

    explicitly.

  • ‘InService`: Endpoint is available to process incoming requests.

  • ‘Deleting`: [DeleteEndpoint] is executing.

  • ‘Failed`: Endpoint could not be created, updated, or re-scaled. Use `DescribeEndpointOutput$FailureReason` for information about the failure. [DeleteEndpoint] 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].

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html [2]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html [3]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html [4]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html [5]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html

Returns:

  • (String)


20095
20096
20097
20098
20099
20100
20101
20102
20103
# File 'lib/aws-sdk-sagemaker/types.rb', line 20095

class EndpointSummary < Struct.new(
  :endpoint_name,
  :endpoint_arn,
  :creation_time,
  :last_modified_time,
  :endpoint_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timeTime

A timestamp that shows when the endpoint was last modified.

Returns:

  • (Time)


20095
20096
20097
20098
20099
20100
20101
20102
20103
# File 'lib/aws-sdk-sagemaker/types.rb', line 20095

class EndpointSummary < Struct.new(
  :endpoint_name,
  :endpoint_arn,
  :creation_time,
  :last_modified_time,
  :endpoint_status)
  SENSITIVE = []
  include Aws::Structure
end