Struct aws_sdk_sagemaker::operation::describe_endpoint::builders::DescribeEndpointOutputBuilder

#[non_exhaustive]
pub struct DescribeEndpointOutputBuilder { /* private fields */ }

A builder for DescribeEndpointOutput.

Implementations

impl DescribeEndpointOutputBuilder

pub fn endpoint_name(self, input: impl Into<String>) -> Self

Name of the endpoint.

This field is required.

pub fn set_endpoint_name(self, input: Option<String>) -> Self

Name of the endpoint.

pub fn get_endpoint_name(&self) -> &Option<String>

Name of the endpoint.

pub fn endpoint_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the endpoint.

This field is required.

pub fn set_endpoint_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the endpoint.

pub fn get_endpoint_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the endpoint.

pub fn endpoint_config_name(self, input: impl Into<String>) -> Self

The name of the endpoint configuration associated with this endpoint.

This field is required.

pub fn set_endpoint_config_name(self, input: Option<String>) -> Self

The name of the endpoint configuration associated with this endpoint.

pub fn get_endpoint_config_name(&self) -> &Option<String>

The name of the endpoint configuration associated with this endpoint.

pub fn production_variants(self, input: ProductionVariantSummary) -> Self

Appends an item to production_variants.

To override the contents of this collection use set_production_variants.

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

pub fn set_production_variants( self, input: Option<Vec<ProductionVariantSummary>> ) -> Self

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

pub fn get_production_variants(&self) -> &Option<Vec<ProductionVariantSummary>>

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

pub fn data_capture_config(self, input: DataCaptureConfigSummary) -> Self

The currently active data capture configuration used by your Endpoint.

pub fn set_data_capture_config( self, input: Option<DataCaptureConfigSummary> ) -> Self

The currently active data capture configuration used by your Endpoint.

pub fn get_data_capture_config(&self) -> &Option<DataCaptureConfigSummary>

The currently active data capture configuration used by your Endpoint.

pub fn endpoint_status(self, input: EndpointStatus) -> Self

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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

• UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

This field is required.

pub fn set_endpoint_status(self, input: Option<EndpointStatus>) -> Self

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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

• UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

pub fn get_endpoint_status(&self) -> &Option<EndpointStatus>

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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

• UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

pub fn failure_reason(self, input: impl Into<String>) -> Self

If the status of the endpoint is Failed, the reason why it failed.

pub fn set_failure_reason(self, input: Option<String>) -> Self

If the status of the endpoint is Failed, the reason why it failed.

pub fn get_failure_reason(&self) -> &Option<String>

If the status of the endpoint is Failed, the reason why it failed.

pub fn creation_time(self, input: DateTime) -> Self

A timestamp that shows when the endpoint was created.

This field is required.

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

A timestamp that shows when the endpoint was created.

pub fn get_creation_time(&self) -> &Option<DateTime>

A timestamp that shows when the endpoint was created.

pub fn last_modified_time(self, input: DateTime) -> Self

A timestamp that shows when the endpoint was last modified.

This field is required.

pub fn set_last_modified_time(self, input: Option<DateTime>) -> Self

A timestamp that shows when the endpoint was last modified.

pub fn get_last_modified_time(&self) -> &Option<DateTime>

A timestamp that shows when the endpoint was last modified.

pub fn last_deployment_config(self, input: DeploymentConfig) -> Self

The most recent deployment configuration for the endpoint.

pub fn set_last_deployment_config(self, input: Option<DeploymentConfig>) -> Self

The most recent deployment configuration for the endpoint.

pub fn get_last_deployment_config(&self) -> &Option<DeploymentConfig>

The most recent deployment configuration for the endpoint.

pub fn async_inference_config(self, input: AsyncInferenceConfig) -> Self

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

pub fn set_async_inference_config( self, input: Option<AsyncInferenceConfig> ) -> Self

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

pub fn get_async_inference_config(&self) -> &Option<AsyncInferenceConfig>

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

pub fn pending_deployment_summary(self, input: PendingDeploymentSummary) -> Self

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

pub fn set_pending_deployment_summary( self, input: Option<PendingDeploymentSummary> ) -> Self

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

pub fn get_pending_deployment_summary( &self ) -> &Option<PendingDeploymentSummary>

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

pub fn explainer_config(self, input: ExplainerConfig) -> Self

The configuration parameters for an explainer.

pub fn set_explainer_config(self, input: Option<ExplainerConfig>) -> Self

The configuration parameters for an explainer.

pub fn get_explainer_config(&self) -> &Option<ExplainerConfig>

The configuration parameters for an explainer.

pub fn shadow_production_variants(self, input: ProductionVariantSummary) -> Self

Appends an item to shadow_production_variants.

To override the contents of this collection use set_shadow_production_variants.

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

pub fn set_shadow_production_variants( self, input: Option<Vec<ProductionVariantSummary>> ) -> Self

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

pub fn get_shadow_production_variants( &self ) -> &Option<Vec<ProductionVariantSummary>>

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

pub fn build(self) -> DescribeEndpointOutput

Consumes the builder and constructs a DescribeEndpointOutput.

Trait Implementations

impl Clone for DescribeEndpointOutputBuilder

fn clone(&self) -> DescribeEndpointOutputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeEndpointOutputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribeEndpointOutputBuilder

fn default() -> DescribeEndpointOutputBuilder

Returns the “default value” for a type.

impl PartialEq for DescribeEndpointOutputBuilder

fn eq(&self, other: &DescribeEndpointOutputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeEndpointOutputBuilder