1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeEndpointOutput {
/// <p>Name of the endpoint.</p>
pub endpoint_name: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the endpoint.</p>
pub endpoint_arn: ::std::option::Option<::std::string::String>,
/// <p>The name of the endpoint configuration associated with this endpoint.</p>
pub endpoint_config_name: ::std::option::Option<::std::string::String>,
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model hosted behind this endpoint.</p>
pub production_variants: ::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>>,
/// <p>The currently active data capture configuration used by your Endpoint.</p>
pub data_capture_config: ::std::option::Option<crate::types::DataCaptureConfigSummary>,
/// <p>The status of the endpoint.</p>
/// <ul>
/// <li>
/// <p><code>OutOfService</code>: Endpoint is not available to take incoming requests.</p></li>
/// <li>
/// <p><code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p></li>
/// <li>
/// <p><code>SystemUpdating</code>: 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.</p></li>
/// <li>
/// <p><code>RollingBack</code>: 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 <code>InService</code> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called explicitly.</p></li>
/// <li>
/// <p><code>InService</code>: Endpoint is available to process incoming requests.</p></li>
/// <li>
/// <p><code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use the <code>FailureReason</code> value returned by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a failed endpoint.</p></li>
/// <li>
/// <p><code>UpdateRollbackFailed</code>: 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 <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling Deployments</a>.</p></li>
/// </ul>
pub endpoint_status: ::std::option::Option<crate::types::EndpointStatus>,
/// <p>If the status of the endpoint is <code>Failed</code>, the reason why it failed.</p>
pub failure_reason: ::std::option::Option<::std::string::String>,
/// <p>A timestamp that shows when the endpoint was created.</p>
pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>A timestamp that shows when the endpoint was last modified.</p>
pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The most recent deployment configuration for the endpoint.</p>
pub last_deployment_config: ::std::option::Option<crate::types::DeploymentConfig>,
/// <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html"> <code>CreateEndpointConfig</code> </a> API.</p>
pub async_inference_config: ::std::option::Option<crate::types::AsyncInferenceConfig>,
/// <p>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.</p>
pub pending_deployment_summary: ::std::option::Option<crate::types::PendingDeploymentSummary>,
/// <p>The configuration parameters for an explainer.</p>
pub explainer_config: ::std::option::Option<crate::types::ExplainerConfig>,
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> 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 <code>ProductionVariants</code>.</p>
pub shadow_production_variants: ::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>>,
_request_id: Option<String>,
}
impl DescribeEndpointOutput {
/// <p>Name of the endpoint.</p>
pub fn endpoint_name(&self) -> ::std::option::Option<&str> {
self.endpoint_name.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the endpoint.</p>
pub fn endpoint_arn(&self) -> ::std::option::Option<&str> {
self.endpoint_arn.as_deref()
}
/// <p>The name of the endpoint configuration associated with this endpoint.</p>
pub fn endpoint_config_name(&self) -> ::std::option::Option<&str> {
self.endpoint_config_name.as_deref()
}
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model hosted behind this endpoint.</p>
///
/// 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 production_variants(&self) -> &[crate::types::ProductionVariantSummary] {
self.production_variants.as_deref().unwrap_or_default()
}
/// <p>The currently active data capture configuration used by your Endpoint.</p>
pub fn data_capture_config(&self) -> ::std::option::Option<&crate::types::DataCaptureConfigSummary> {
self.data_capture_config.as_ref()
}
/// <p>The status of the endpoint.</p>
/// <ul>
/// <li>
/// <p><code>OutOfService</code>: Endpoint is not available to take incoming requests.</p></li>
/// <li>
/// <p><code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p></li>
/// <li>
/// <p><code>SystemUpdating</code>: 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.</p></li>
/// <li>
/// <p><code>RollingBack</code>: 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 <code>InService</code> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called explicitly.</p></li>
/// <li>
/// <p><code>InService</code>: Endpoint is available to process incoming requests.</p></li>
/// <li>
/// <p><code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use the <code>FailureReason</code> value returned by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a failed endpoint.</p></li>
/// <li>
/// <p><code>UpdateRollbackFailed</code>: 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 <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling Deployments</a>.</p></li>
/// </ul>
pub fn endpoint_status(&self) -> ::std::option::Option<&crate::types::EndpointStatus> {
self.endpoint_status.as_ref()
}
/// <p>If the status of the endpoint is <code>Failed</code>, the reason why it failed.</p>
pub fn failure_reason(&self) -> ::std::option::Option<&str> {
self.failure_reason.as_deref()
}
/// <p>A timestamp that shows when the endpoint was created.</p>
pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.creation_time.as_ref()
}
/// <p>A timestamp that shows when the endpoint was last modified.</p>
pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.last_modified_time.as_ref()
}
/// <p>The most recent deployment configuration for the endpoint.</p>
pub fn last_deployment_config(&self) -> ::std::option::Option<&crate::types::DeploymentConfig> {
self.last_deployment_config.as_ref()
}
/// <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html"> <code>CreateEndpointConfig</code> </a> API.</p>
pub fn async_inference_config(&self) -> ::std::option::Option<&crate::types::AsyncInferenceConfig> {
self.async_inference_config.as_ref()
}
/// <p>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.</p>
pub fn pending_deployment_summary(&self) -> ::std::option::Option<&crate::types::PendingDeploymentSummary> {
self.pending_deployment_summary.as_ref()
}
/// <p>The configuration parameters for an explainer.</p>
pub fn explainer_config(&self) -> ::std::option::Option<&crate::types::ExplainerConfig> {
self.explainer_config.as_ref()
}
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> 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 <code>ProductionVariants</code>.</p>
///
/// 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()`.
pub fn shadow_production_variants(&self) -> &[crate::types::ProductionVariantSummary] {
self.shadow_production_variants.as_deref().unwrap_or_default()
}
}
impl ::aws_types::request_id::RequestId for DescribeEndpointOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeEndpointOutput {
/// Creates a new builder-style object to manufacture [`DescribeEndpointOutput`](crate::operation::describe_endpoint::DescribeEndpointOutput).
pub fn builder() -> crate::operation::describe_endpoint::builders::DescribeEndpointOutputBuilder {
crate::operation::describe_endpoint::builders::DescribeEndpointOutputBuilder::default()
}
}
/// A builder for [`DescribeEndpointOutput`](crate::operation::describe_endpoint::DescribeEndpointOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeEndpointOutputBuilder {
pub(crate) endpoint_name: ::std::option::Option<::std::string::String>,
pub(crate) endpoint_arn: ::std::option::Option<::std::string::String>,
pub(crate) endpoint_config_name: ::std::option::Option<::std::string::String>,
pub(crate) production_variants: ::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>>,
pub(crate) data_capture_config: ::std::option::Option<crate::types::DataCaptureConfigSummary>,
pub(crate) endpoint_status: ::std::option::Option<crate::types::EndpointStatus>,
pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) last_deployment_config: ::std::option::Option<crate::types::DeploymentConfig>,
pub(crate) async_inference_config: ::std::option::Option<crate::types::AsyncInferenceConfig>,
pub(crate) pending_deployment_summary: ::std::option::Option<crate::types::PendingDeploymentSummary>,
pub(crate) explainer_config: ::std::option::Option<crate::types::ExplainerConfig>,
pub(crate) shadow_production_variants: ::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>>,
_request_id: Option<String>,
}
impl DescribeEndpointOutputBuilder {
/// <p>Name of the endpoint.</p>
/// This field is required.
pub fn endpoint_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.endpoint_name = ::std::option::Option::Some(input.into());
self
}
/// <p>Name of the endpoint.</p>
pub fn set_endpoint_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.endpoint_name = input;
self
}
/// <p>Name of the endpoint.</p>
pub fn get_endpoint_name(&self) -> &::std::option::Option<::std::string::String> {
&self.endpoint_name
}
/// <p>The Amazon Resource Name (ARN) of the endpoint.</p>
/// This field is required.
pub fn endpoint_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.endpoint_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the endpoint.</p>
pub fn set_endpoint_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.endpoint_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the endpoint.</p>
pub fn get_endpoint_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.endpoint_arn
}
/// <p>The name of the endpoint configuration associated with this endpoint.</p>
pub fn endpoint_config_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.endpoint_config_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the endpoint configuration associated with this endpoint.</p>
pub fn set_endpoint_config_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.endpoint_config_name = input;
self
}
/// <p>The name of the endpoint configuration associated with this endpoint.</p>
pub fn get_endpoint_config_name(&self) -> &::std::option::Option<::std::string::String> {
&self.endpoint_config_name
}
/// Appends an item to `production_variants`.
///
/// To override the contents of this collection use [`set_production_variants`](Self::set_production_variants).
///
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model hosted behind this endpoint.</p>
pub fn production_variants(mut self, input: crate::types::ProductionVariantSummary) -> Self {
let mut v = self.production_variants.unwrap_or_default();
v.push(input);
self.production_variants = ::std::option::Option::Some(v);
self
}
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model hosted behind this endpoint.</p>
pub fn set_production_variants(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>>) -> Self {
self.production_variants = input;
self
}
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model hosted behind this endpoint.</p>
pub fn get_production_variants(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>> {
&self.production_variants
}
/// <p>The currently active data capture configuration used by your Endpoint.</p>
pub fn data_capture_config(mut self, input: crate::types::DataCaptureConfigSummary) -> Self {
self.data_capture_config = ::std::option::Option::Some(input);
self
}
/// <p>The currently active data capture configuration used by your Endpoint.</p>
pub fn set_data_capture_config(mut self, input: ::std::option::Option<crate::types::DataCaptureConfigSummary>) -> Self {
self.data_capture_config = input;
self
}
/// <p>The currently active data capture configuration used by your Endpoint.</p>
pub fn get_data_capture_config(&self) -> &::std::option::Option<crate::types::DataCaptureConfigSummary> {
&self.data_capture_config
}
/// <p>The status of the endpoint.</p>
/// <ul>
/// <li>
/// <p><code>OutOfService</code>: Endpoint is not available to take incoming requests.</p></li>
/// <li>
/// <p><code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p></li>
/// <li>
/// <p><code>SystemUpdating</code>: 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.</p></li>
/// <li>
/// <p><code>RollingBack</code>: 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 <code>InService</code> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called explicitly.</p></li>
/// <li>
/// <p><code>InService</code>: Endpoint is available to process incoming requests.</p></li>
/// <li>
/// <p><code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use the <code>FailureReason</code> value returned by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a failed endpoint.</p></li>
/// <li>
/// <p><code>UpdateRollbackFailed</code>: 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 <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling Deployments</a>.</p></li>
/// </ul>
/// This field is required.
pub fn endpoint_status(mut self, input: crate::types::EndpointStatus) -> Self {
self.endpoint_status = ::std::option::Option::Some(input);
self
}
/// <p>The status of the endpoint.</p>
/// <ul>
/// <li>
/// <p><code>OutOfService</code>: Endpoint is not available to take incoming requests.</p></li>
/// <li>
/// <p><code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p></li>
/// <li>
/// <p><code>SystemUpdating</code>: 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.</p></li>
/// <li>
/// <p><code>RollingBack</code>: 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 <code>InService</code> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called explicitly.</p></li>
/// <li>
/// <p><code>InService</code>: Endpoint is available to process incoming requests.</p></li>
/// <li>
/// <p><code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use the <code>FailureReason</code> value returned by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a failed endpoint.</p></li>
/// <li>
/// <p><code>UpdateRollbackFailed</code>: 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 <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling Deployments</a>.</p></li>
/// </ul>
pub fn set_endpoint_status(mut self, input: ::std::option::Option<crate::types::EndpointStatus>) -> Self {
self.endpoint_status = input;
self
}
/// <p>The status of the endpoint.</p>
/// <ul>
/// <li>
/// <p><code>OutOfService</code>: Endpoint is not available to take incoming requests.</p></li>
/// <li>
/// <p><code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p></li>
/// <li>
/// <p><code>SystemUpdating</code>: 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.</p></li>
/// <li>
/// <p><code>RollingBack</code>: 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 <code>InService</code> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called explicitly.</p></li>
/// <li>
/// <p><code>InService</code>: Endpoint is available to process incoming requests.</p></li>
/// <li>
/// <p><code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p></li>
/// <li>
/// <p><code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use the <code>FailureReason</code> value returned by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a failed endpoint.</p></li>
/// <li>
/// <p><code>UpdateRollbackFailed</code>: 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 <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling Deployments</a>.</p></li>
/// </ul>
pub fn get_endpoint_status(&self) -> &::std::option::Option<crate::types::EndpointStatus> {
&self.endpoint_status
}
/// <p>If the status of the endpoint is <code>Failed</code>, the reason why it failed.</p>
pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.failure_reason = ::std::option::Option::Some(input.into());
self
}
/// <p>If the status of the endpoint is <code>Failed</code>, the reason why it failed.</p>
pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.failure_reason = input;
self
}
/// <p>If the status of the endpoint is <code>Failed</code>, the reason why it failed.</p>
pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
&self.failure_reason
}
/// <p>A timestamp that shows when the endpoint was created.</p>
/// This field is required.
pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.creation_time = ::std::option::Option::Some(input);
self
}
/// <p>A timestamp that shows when the endpoint was created.</p>
pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.creation_time = input;
self
}
/// <p>A timestamp that shows when the endpoint was created.</p>
pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.creation_time
}
/// <p>A timestamp that shows when the endpoint was last modified.</p>
/// This field is required.
pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.last_modified_time = ::std::option::Option::Some(input);
self
}
/// <p>A timestamp that shows when the endpoint was last modified.</p>
pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.last_modified_time = input;
self
}
/// <p>A timestamp that shows when the endpoint was last modified.</p>
pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.last_modified_time
}
/// <p>The most recent deployment configuration for the endpoint.</p>
pub fn last_deployment_config(mut self, input: crate::types::DeploymentConfig) -> Self {
self.last_deployment_config = ::std::option::Option::Some(input);
self
}
/// <p>The most recent deployment configuration for the endpoint.</p>
pub fn set_last_deployment_config(mut self, input: ::std::option::Option<crate::types::DeploymentConfig>) -> Self {
self.last_deployment_config = input;
self
}
/// <p>The most recent deployment configuration for the endpoint.</p>
pub fn get_last_deployment_config(&self) -> &::std::option::Option<crate::types::DeploymentConfig> {
&self.last_deployment_config
}
/// <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html"> <code>CreateEndpointConfig</code> </a> API.</p>
pub fn async_inference_config(mut self, input: crate::types::AsyncInferenceConfig) -> Self {
self.async_inference_config = ::std::option::Option::Some(input);
self
}
/// <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html"> <code>CreateEndpointConfig</code> </a> API.</p>
pub fn set_async_inference_config(mut self, input: ::std::option::Option<crate::types::AsyncInferenceConfig>) -> Self {
self.async_inference_config = input;
self
}
/// <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html"> <code>CreateEndpointConfig</code> </a> API.</p>
pub fn get_async_inference_config(&self) -> &::std::option::Option<crate::types::AsyncInferenceConfig> {
&self.async_inference_config
}
/// <p>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.</p>
pub fn pending_deployment_summary(mut self, input: crate::types::PendingDeploymentSummary) -> Self {
self.pending_deployment_summary = ::std::option::Option::Some(input);
self
}
/// <p>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.</p>
pub fn set_pending_deployment_summary(mut self, input: ::std::option::Option<crate::types::PendingDeploymentSummary>) -> Self {
self.pending_deployment_summary = input;
self
}
/// <p>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.</p>
pub fn get_pending_deployment_summary(&self) -> &::std::option::Option<crate::types::PendingDeploymentSummary> {
&self.pending_deployment_summary
}
/// <p>The configuration parameters for an explainer.</p>
pub fn explainer_config(mut self, input: crate::types::ExplainerConfig) -> Self {
self.explainer_config = ::std::option::Option::Some(input);
self
}
/// <p>The configuration parameters for an explainer.</p>
pub fn set_explainer_config(mut self, input: ::std::option::Option<crate::types::ExplainerConfig>) -> Self {
self.explainer_config = input;
self
}
/// <p>The configuration parameters for an explainer.</p>
pub fn get_explainer_config(&self) -> &::std::option::Option<crate::types::ExplainerConfig> {
&self.explainer_config
}
/// Appends an item to `shadow_production_variants`.
///
/// To override the contents of this collection use [`set_shadow_production_variants`](Self::set_shadow_production_variants).
///
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> 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 <code>ProductionVariants</code>.</p>
pub fn shadow_production_variants(mut self, input: crate::types::ProductionVariantSummary) -> Self {
let mut v = self.shadow_production_variants.unwrap_or_default();
v.push(input);
self.shadow_production_variants = ::std::option::Option::Some(v);
self
}
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> 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 <code>ProductionVariants</code>.</p>
pub fn set_shadow_production_variants(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>>) -> Self {
self.shadow_production_variants = input;
self
}
/// <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> 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 <code>ProductionVariants</code>.</p>
pub fn get_shadow_production_variants(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProductionVariantSummary>> {
&self.shadow_production_variants
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeEndpointOutput`](crate::operation::describe_endpoint::DescribeEndpointOutput).
pub fn build(self) -> crate::operation::describe_endpoint::DescribeEndpointOutput {
crate::operation::describe_endpoint::DescribeEndpointOutput {
endpoint_name: self.endpoint_name,
endpoint_arn: self.endpoint_arn,
endpoint_config_name: self.endpoint_config_name,
production_variants: self.production_variants,
data_capture_config: self.data_capture_config,
endpoint_status: self.endpoint_status,
failure_reason: self.failure_reason,
creation_time: self.creation_time,
last_modified_time: self.last_modified_time,
last_deployment_config: self.last_deployment_config,
async_inference_config: self.async_inference_config,
pending_deployment_summary: self.pending_deployment_summary,
explainer_config: self.explainer_config,
shadow_production_variants: self.shadow_production_variants,
_request_id: self._request_id,
}
}
}