/AWS1/CL_SGMDESCRENDPTOUTPUT

DescribeEndpointOutput

CONSTRUCTOR

IMPORTING

Required arguments:

iv_endpointname TYPE /AWS1/SGMENDPOINTNAME /AWS1/SGMENDPOINTNAME

Name of the endpoint.

iv_endpointarn TYPE /AWS1/SGMENDPOINTARN /AWS1/SGMENDPOINTARN

The Amazon Resource Name (ARN) of the endpoint.

iv_endpointstatus TYPE /AWS1/SGMENDPOINTSTATUS /AWS1/SGMENDPOINTSTATUS

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.

iv_creationtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A timestamp that shows when the endpoint was created.

iv_lastmodifiedtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A timestamp that shows when the endpoint was last modified.

Optional arguments:

iv_endpointconfigname TYPE /AWS1/SGMENDPOINTCONFIGNAME /AWS1/SGMENDPOINTCONFIGNAME

The name of the endpoint configuration associated with this endpoint.

it_productionvariants TYPE /AWS1/CL_SGMPRODUCTIONVARIAN02=>TT_PRODUCTIONVARIANTSUMMLIST TT_PRODUCTIONVARIANTSUMMLIST

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

io_datacaptureconfig TYPE REF TO /AWS1/CL_SGMDATACAPTURECFGSUMM /AWS1/CL_SGMDATACAPTURECFGSUMM

DataCaptureConfig

iv_failurereason TYPE /AWS1/SGMFAILUREREASON /AWS1/SGMFAILUREREASON

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

io_lastdeploymentconfig TYPE REF TO /AWS1/CL_SGMDEPLOYMENTCONFIG /AWS1/CL_SGMDEPLOYMENTCONFIG

The most recent deployment configuration for the endpoint.

io_asyncinferenceconfig TYPE REF TO /AWS1/CL_SGMASYNCINFERENCECFG /AWS1/CL_SGMASYNCINFERENCECFG

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

io_pendingdeploymentsummary TYPE REF TO /AWS1/CL_SGMPENDINGDEPLOYMEN00 /AWS1/CL_SGMPENDINGDEPLOYMEN00

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.

io_explainerconfig TYPE REF TO /AWS1/CL_SGMEXPLAINERCONFIG /AWS1/CL_SGMEXPLAINERCONFIG

The configuration parameters for an explainer.

it_shadowproductionvariants TYPE /AWS1/CL_SGMPRODUCTIONVARIAN02=>TT_PRODUCTIONVARIANTSUMMLIST TT_PRODUCTIONVARIANTSUMMLIST

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.

---

Queryable Attributes

EndpointName

Name of the endpoint.

Accessible with the following methods

Method	Description
GET_ENDPOINTNAME()	Getter for ENDPOINTNAME, with configurable default
ASK_ENDPOINTNAME()	Getter for ENDPOINTNAME w/ exceptions if field has no value
HAS_ENDPOINTNAME()	Determine if ENDPOINTNAME has a value

EndpointArn

The Amazon Resource Name (ARN) of the endpoint.

Accessible with the following methods

Method	Description
GET_ENDPOINTARN()	Getter for ENDPOINTARN, with configurable default
ASK_ENDPOINTARN()	Getter for ENDPOINTARN w/ exceptions if field has no value
HAS_ENDPOINTARN()	Determine if ENDPOINTARN has a value

EndpointConfigName

The name of the endpoint configuration associated with this endpoint.

Accessible with the following methods

Method	Description
GET_ENDPOINTCONFIGNAME()	Getter for ENDPOINTCONFIGNAME, with configurable default
ASK_ENDPOINTCONFIGNAME()	Getter for ENDPOINTCONFIGNAME w/ exceptions if field has no
HAS_ENDPOINTCONFIGNAME()	Determine if ENDPOINTCONFIGNAME has a value

ProductionVariants

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

Accessible with the following methods

Method	Description
GET_PRODUCTIONVARIANTS()	Getter for PRODUCTIONVARIANTS, with configurable default
ASK_PRODUCTIONVARIANTS()	Getter for PRODUCTIONVARIANTS w/ exceptions if field has no
HAS_PRODUCTIONVARIANTS()	Determine if PRODUCTIONVARIANTS has a value

DataCaptureConfig

DataCaptureConfig

Accessible with the following methods

Method	Description
GET_DATACAPTURECONFIG()	Getter for DATACAPTURECONFIG

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.

Accessible with the following methods

Method	Description
GET_ENDPOINTSTATUS()	Getter for ENDPOINTSTATUS, with configurable default
ASK_ENDPOINTSTATUS()	Getter for ENDPOINTSTATUS w/ exceptions if field has no valu
HAS_ENDPOINTSTATUS()	Determine if ENDPOINTSTATUS has a value

FailureReason

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

Accessible with the following methods

Method	Description
GET_FAILUREREASON()	Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON()	Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON()	Determine if FAILUREREASON has a value

CreationTime

A timestamp that shows when the endpoint was created.

Accessible with the following methods

Method	Description
GET_CREATIONTIME()	Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME()	Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME()	Determine if CREATIONTIME has a value

LastModifiedTime

A timestamp that shows when the endpoint was last modified.

Accessible with the following methods

Method	Description
GET_LASTMODIFIEDTIME()	Getter for LASTMODIFIEDTIME, with configurable default
ASK_LASTMODIFIEDTIME()	Getter for LASTMODIFIEDTIME w/ exceptions if field has no va
HAS_LASTMODIFIEDTIME()	Determine if LASTMODIFIEDTIME has a value

LastDeploymentConfig

The most recent deployment configuration for the endpoint.

Accessible with the following methods

Method	Description
GET_LASTDEPLOYMENTCONFIG()	Getter for LASTDEPLOYMENTCONFIG

AsyncInferenceConfig

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

Accessible with the following methods

Method	Description
GET_ASYNCINFERENCECONFIG()	Getter for ASYNCINFERENCECONFIG

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.

Accessible with the following methods

Method	Description
GET_PENDINGDEPLOYMENTSUMMARY()	Getter for PENDINGDEPLOYMENTSUMMARY

ExplainerConfig

The configuration parameters for an explainer.

Accessible with the following methods

Method	Description
GET_EXPLAINERCONFIG()	Getter for EXPLAINERCONFIG

ShadowProductionVariants

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.

Accessible with the following methods

Method	Description
GET_SHADOWPRODUCTIONVARIANTS()	Getter for SHADOWPRODUCTIONVARIANTS, with configurable defau
ASK_SHADOWPRODUCTIONVARIANTS()	Getter for SHADOWPRODUCTIONVARIANTS w/ exceptions if field h
HAS_SHADOWPRODUCTIONVARIANTS()	Determine if SHADOWPRODUCTIONVARIANTS has a value