Module Values_1.DescribeEndpointOutputSource

Returns the description of an endpoint.

Sourcetype nonrec t = {
  1. endpointName : Values_0.EndpointName.t option;
    (*

    Name of the endpoint.

    *)
  2. endpointArn : Values_0.EndpointArn.t option;
    (*

    The Amazon Resource Name (ARN) of the endpoint.

    *)
  3. endpointConfigName : Values_0.EndpointConfigName.t option;
    (*

    The name of the endpoint configuration associated with this endpoint.

    *)
  4. productionVariants : ProductionVariantSummaryList.t option;
    (*

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

    *)
  5. dataCaptureConfig : DataCaptureConfigSummary.t option;
  6. endpointStatus : EndpointStatus.t option;
    (*

    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.

    *)
  7. failureReason : Values_0.FailureReason.t option;
    (*

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

    *)
  8. creationTime : Values_0.Timestamp.t option;
    (*

    A timestamp that shows when the endpoint was created.

    *)
  9. lastModifiedTime : Values_0.Timestamp.t option;
    (*

    A timestamp that shows when the endpoint was last modified.

    *)
  10. lastDeploymentConfig : Values_0.DeploymentConfig.t option;
    (*

    The most recent deployment configuration for the endpoint.

    *)
  11. asyncInferenceConfig : Values_0.AsyncInferenceConfig.t option;
    (*

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

    *)
  12. pendingDeploymentSummary : PendingDeploymentSummary.t option;
    (*

    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.

    *)
  13. explainerConfig : Values_0.ExplainerConfig.t option;
    (*

    The configuration parameters for an explainer.

    *)
  14. shadowProductionVariants : ProductionVariantSummaryList.t option;
    (*

    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.

    *)
  15. metricsConfig : Values_0.MetricsConfig.t option;
    (*

    The configuration parameters for utilization metrics.

    *)
}
Sourcetype nonrec error = [
  1. | `Unknown_operation_error of string * string option
]
Sourceval make : ?endpointName:??? -> ?endpointArn:??? -> ?endpointConfigName:??? -> ?productionVariants:??? -> ?dataCaptureConfig:??? -> ?endpointStatus:??? -> ?failureReason:??? -> ?creationTime:??? -> ?lastModifiedTime:??? -> ?lastDeploymentConfig:??? -> ?asyncInferenceConfig:??? -> ?pendingDeploymentSummary:??? -> ?explainerConfig:??? -> ?shadowProductionVariants:??? -> ?metricsConfig:??? -> unit -> t
Sourceval error_of_json : 'a -> Yojson.Safe.t -> [> `Unknown_operation_error of 'a * string option ]
Sourceval error_of_xml : 'a -> Awso.Xml.t -> [> `Unknown_operation_error of 'a * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Float of Values_0.VariantWeight.t | `Integer of TaskCount.t | `List of [> `Structure of (string * [> `Enum of string | `Integer of TaskCount.t | `String of Values_0.ContainerImage.t | `Timestamp of Values_0.Timestamp.t ]) list ] list | `String of Values_0.VariantName.t | `Structure of (string * [> `Enum of string | `Integer of int | `List of [> `Structure of (string * [> `Integer of TaskCount.t | `String of Ec2CapacityReservationId.t ]) list ] list | `String of Values_0.MlReservationArn.t | `Structure of (string * [> `Enum of string | `Integer of int ]) list ]) list ]) list ] list | `String of Values_0.EndpointName.t | `Structure of (string * [> `Boolean of Values_0.EnableCapture.t | `Enum of string | `Integer of Values_0.SamplingPercentage.t | `List of [> `Structure of (string * [> `Enum of string | `Float of Values_0.VariantWeight.t | `Integer of TaskCount.t | `List of [> `Structure of (string * [> `Enum of string | `Integer of TaskCount.t | `String of Values_0.ContainerImage.t | `Timestamp of Values_0.Timestamp.t ]) list ] list | `String of Values_0.VariantName.t | `Structure of (string * [> `Enum of string | `Integer of int | `Structure of (string * [> `Enum of string | `Integer of int ]) list ]) list ]) list ] list | `String of Values_0.DestinationS3Uri.t | `Structure of (string * [> `Integer of int | `List of [> `Structure of (string * [> `String of string ]) list ] list | `String of string | `Structure of (string * [> `Boolean of bool | `Enum of string | `Integer of int | `List of [> `Enum of string | `String of string ] list | `String of string | `Structure of (string * [> `Enum of string | `Integer of int | `String of string ]) list ]) list ]) list | `Timestamp of Values_0.Timestamp.t ]) list | `Timestamp of Values_0.Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t