Class: Aws::SageMaker::Types::ProductionVariantSummary

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ProductionVariantSummary

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capacity_reservation_config ⇒ Types::ProductionVariantCapacityReservationSummary

  Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

• #current_instance_count ⇒ Integer

  The number of instances associated with the variant.

• #current_serverless_config ⇒ Types::ProductionVariantServerlessConfig

  The serverless configuration for the endpoint.

• #current_weight ⇒ Float

  The weight associated with the variant.

• #deployed_images ⇒ Array<Types::DeployedImage>

  An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

• #desired_instance_count ⇒ Integer

  The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

• #desired_serverless_config ⇒ Types::ProductionVariantServerlessConfig

  The serverless configuration requested for the endpoint update.

• #desired_weight ⇒ Float

  The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

• #instance_pools ⇒ Array<Types::InstancePoolSummary>

  A list of instance pools for the production variant.

• #managed_instance_scaling ⇒ Types::ProductionVariantManagedInstanceScaling

  Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

• #routing_config ⇒ Types::ProductionVariantRoutingConfig

  Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

• #variant_name ⇒ String

  The name of the variant.

• #variant_status ⇒ Array<Types::ProductionVariantStatus>

  The endpoint variant status which describes the current deployment stage status or operational status.

Instance Attribute Details

#capacity_reservation_config ⇒ Types::ProductionVariantCapacityReservationSummary

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

Returns:

• (Types::ProductionVariantCapacityReservationSummary)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#current_instance_count ⇒ Integer

The number of instances associated with the variant.

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#current_serverless_config ⇒ Types::ProductionVariantServerlessConfig

The serverless configuration for the endpoint.

Returns:

• (Types::ProductionVariantServerlessConfig)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#current_weight ⇒ Float

The weight associated with the variant.

Returns:

• (Float)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#deployed_images ⇒ Array<Types::DeployedImage>

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

Returns:

• (Array<Types::DeployedImage>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#desired_instance_count ⇒ Integer

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#desired_serverless_config ⇒ Types::ProductionVariantServerlessConfig

The serverless configuration requested for the endpoint update.

Returns:

• (Types::ProductionVariantServerlessConfig)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#desired_weight ⇒ Float

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

Returns:

• (Float)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_pools ⇒ Array<Types::InstancePoolSummary>

A list of instance pools for the production variant. Each pool indicates the instance type and the current number of instances of that type.

Returns:

• (Array<Types::InstancePoolSummary>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#managed_instance_scaling ⇒ Types::ProductionVariantManagedInstanceScaling

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

Returns:

• (Types::ProductionVariantManagedInstanceScaling)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#routing_config ⇒ Types::ProductionVariantRoutingConfig

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

Returns:

• (Types::ProductionVariantRoutingConfig)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#variant_name ⇒ String

The name of the variant.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end

#variant_status ⇒ Array<Types::ProductionVariantStatus>

The endpoint variant status which describes the current deployment stage status or operational status.

Returns:

• (Array<Types::ProductionVariantStatus>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 47934

class ProductionVariantSummary < Struct.new(
  :variant_name,
  :deployed_images,
  :current_weight,
  :desired_weight,
  :current_instance_count,
  :desired_instance_count,
  :instance_pools,
  :variant_status,
  :current_serverless_config,
  :desired_serverless_config,
  :managed_instance_scaling,
  :routing_config,
  :capacity_reservation_config)
  SENSITIVE = []
  include Aws::Structure
end