Struct DescribeEndpointOutput

#[non_exhaustive]
pub struct DescribeEndpointOutput {

    pub endpoint_name: Option<String>,
    pub endpoint_arn: Option<String>,
    pub endpoint_config_name: Option<String>,
    pub production_variants: Option<Vec<ProductionVariantSummary>>,
    pub data_capture_config: Option<DataCaptureConfigSummary>,
    pub endpoint_status: Option<EndpointStatus>,
    pub failure_reason: Option<String>,
    pub creation_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
    pub last_deployment_config: Option<DeploymentConfig>,
    pub async_inference_config: Option<AsyncInferenceConfig>,
    pub pending_deployment_summary: Option<PendingDeploymentSummary>,
    pub explainer_config: Option<ExplainerConfig>,
    pub shadow_production_variants: Option<Vec<ProductionVariantSummary>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

endpoint_name: Option<String>

Name of the endpoint.

endpoint_arn: Option<String>

The Amazon Resource Name (ARN) of the endpoint.

endpoint_config_name: Option<String>

The name of the endpoint configuration associated with this endpoint.

production_variants: Option<Vec<ProductionVariantSummary>>

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

data_capture_config: Option<DataCaptureConfigSummary>

The currently active data capture configuration used by your Endpoint.

endpoint_status: 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.

failure_reason: Option<String>

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

creation_time: Option<DateTime>

A timestamp that shows when the endpoint was created.

last_modified_time: Option<DateTime>

A timestamp that shows when the endpoint was last modified.

last_deployment_config: Option<DeploymentConfig>

The most recent deployment configuration for the endpoint.

async_inference_config: Option<AsyncInferenceConfig>

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

pending_deployment_summary: 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.

explainer_config: Option<ExplainerConfig>

The configuration parameters for an explainer.

shadow_production_variants: 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.

Implementations

impl DescribeEndpointOutput

pub fn endpoint_name(&self) -> Option<&str>

Name of the endpoint.

pub fn endpoint_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the endpoint.

pub fn endpoint_config_name(&self) -> Option<&str>

The name of the endpoint configuration associated with this endpoint.

pub fn production_variants(&self) -> &[ProductionVariantSummary]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .production_variants.is_none().

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

The currently active data capture configuration used by your Endpoint.

pub fn 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) -> Option<&str>

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

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

A timestamp that shows when the endpoint was created.

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

A timestamp that shows when the endpoint was last modified.

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

The most recent deployment configuration for the endpoint.

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

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

pub fn 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) -> Option<&ExplainerConfig>

The configuration parameters for an explainer.

pub fn shadow_production_variants(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .shadow_production_variants.is_none().

impl DescribeEndpointOutput

pub fn builder() -> DescribeEndpointOutputBuilder

Creates a new builder-style object to manufacture DescribeEndpointOutput.

Trait Implementations

impl Clone for DescribeEndpointOutput

fn clone(&self) -> DescribeEndpointOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeEndpointOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeEndpointOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for DescribeEndpointOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeEndpointOutput