You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Provides summary information for an endpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

A timestamp that shows when the endpoint was created.

Returns:

  • (Time)


5222
5223
5224
5225
5226
5227
5228
5229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5222

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

#endpoint_arnString

The Amazon Resource Name (ARN) of the endpoint.

Returns:

  • (String)


5222
5223
5224
5225
5226
5227
5228
5229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5222

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

#endpoint_nameString

The name of the endpoint.

Returns:

  • (String)


5222
5223
5224
5225
5226
5227
5228
5229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5222

class EndpointSummary < Struct.new(
  :endpoint_name,
  :endpoint_arn,
  :creation_time,
  :last_modified_time,
  :endpoint_status)
  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 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 call or when the UpdateEndpointWeightsAndCapacities 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 ListEndpointsInput$StatusEquals filter.

Returns:

  • (String)


5222
5223
5224
5225
5226
5227
5228
5229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5222

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

#last_modified_timeTime

A timestamp that shows when the endpoint was last modified.

Returns:

  • (Time)


5222
5223
5224
5225
5226
5227
5228
5229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5222

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