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

We welcome your feedback on this new version of the documentation. Send your comments to


import ""

type EndpointSummary struct { CreationTime *time.Time `type:"timestamp" required:"true"` EndpointArn *string `min:"20" type:"string" required:"true"` EndpointName *string `type:"string" required:"true"` EndpointStatus *string `type:"string" required:"true" enum:"EndpointStatus"` LastModifiedTime *time.Time `type:"timestamp" required:"true"` }

Provides summary information for an endpoint.


Type: *time.Time

A timestamp that shows when the endpoint was created.

CreationTime is a required field


Type: *string

The Amazon Resource Name (ARN) of the endpoint.

EndpointArn is a required field


Type: *string

The name of the endpoint.

EndpointName is a required field


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 mainenance 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.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

EndpointStatus is a required field


Type: *time.Time

A timestamp that shows when the endpoint was last modified.

LastModifiedTime is a required field



func (s EndpointSummary) GoString() string

GoString returns the string representation


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

SetCreationTime sets the CreationTime field's value.


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

SetEndpointArn sets the EndpointArn field's value.


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

SetEndpointName sets the EndpointName field's value.


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

SetEndpointStatus sets the EndpointStatus field's value.


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

SetLastModifiedTime sets the LastModifiedTime field's value.


func (s EndpointSummary) String() string

String returns the string representation

On this page: