AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeEndpointOutput

import "github.com/aws/aws-sdk-go/service/sagemaker"

type DescribeEndpointOutput struct { CreationTime *time.Time `type:"timestamp" required:"true"` EndpointArn *string `min:"20" type:"string" required:"true"` EndpointConfigName *string `type:"string" required:"true"` EndpointName *string `type:"string" required:"true"` EndpointStatus *string `type:"string" required:"true" enum:"EndpointStatus"` FailureReason *string `type:"string"` LastModifiedTime *time.Time `type:"timestamp" required:"true"` ProductionVariants []*ProductionVariantSummary `min:"1" type:"list"` }

CreationTime

Type: *time.Time

A timestamp that shows when the endpoint was created.

CreationTime is a required field

EndpointArn

Type: *string

The Amazon Resource Name (ARN) of the endpoint.

EndpointArn is a required field

EndpointConfigName

Type: *string

The name of the endpoint configuration associated with this endpoint.

EndpointConfigName is a required field

EndpointName

Type: *string

Name of the endpoint.

EndpointName is a required field

EndpointStatus

Type: *string

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

EndpointStatus is a required field

FailureReason

Type: *string

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

LastModifiedTime

Type: *time.Time

A timestamp that shows when the endpoint was last modified.

LastModifiedTime is a required field

ProductionVariants

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

Method

GoString

func (s DescribeEndpointOutput) GoString() string

GoString returns the string representation

SetCreationTime

func (s *DescribeEndpointOutput) SetCreationTime(v time.Time) *DescribeEndpointOutput

SetCreationTime sets the CreationTime field's value.

SetEndpointArn

func (s *DescribeEndpointOutput) SetEndpointArn(v string) *DescribeEndpointOutput

SetEndpointArn sets the EndpointArn field's value.

SetEndpointConfigName

func (s *DescribeEndpointOutput) SetEndpointConfigName(v string) *DescribeEndpointOutput

SetEndpointConfigName sets the EndpointConfigName field's value.

SetEndpointName

func (s *DescribeEndpointOutput) SetEndpointName(v string) *DescribeEndpointOutput

SetEndpointName sets the EndpointName field's value.

SetEndpointStatus

func (s *DescribeEndpointOutput) SetEndpointStatus(v string) *DescribeEndpointOutput

SetEndpointStatus sets the EndpointStatus field's value.

SetFailureReason

func (s *DescribeEndpointOutput) SetFailureReason(v string) *DescribeEndpointOutput

SetFailureReason sets the FailureReason field's value.

SetLastModifiedTime

func (s *DescribeEndpointOutput) SetLastModifiedTime(v time.Time) *DescribeEndpointOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

SetProductionVariants

func (s *DescribeEndpointOutput) SetProductionVariants(v []*ProductionVariantSummary) *DescribeEndpointOutput

SetProductionVariants sets the ProductionVariants field's value.

String

func (s DescribeEndpointOutput) String() string

String returns the string representation

On this page: