libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.Types.EndpointSummary

Description

 
Synopsis

Documentation

data EndpointSummary Source #

Provides summary information for an endpoint.

See: newEndpointSummary smart constructor.

Constructors

EndpointSummary' 

Fields

  • endpointName :: Text

    The name of the endpoint.

  • endpointArn :: Text

    The Amazon Resource Name (ARN) of the endpoint.

  • creationTime :: POSIX

    A timestamp that shows when the endpoint was created.

  • lastModifiedTime :: POSIX

    A timestamp that shows when the endpoint was last modified.

  • endpointStatus :: 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 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.

Instances

Instances details
Eq EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

Methods

(==) :: EndpointSummary -> EndpointSummary -> Bool #

(/=) :: EndpointSummary -> EndpointSummary -> Bool #

Read EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

Methods

readsPrec :: Int -> ReadS EndpointSummary #

readList :: ReadS [EndpointSummary] #

readPrec :: ReadPrec EndpointSummary #

readListPrec :: ReadPrec [EndpointSummary] #

Show EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

Methods

showsPrec :: Int -> EndpointSummary -> ShowS #

show :: EndpointSummary -> String #

showList :: [EndpointSummary] -> ShowS #

Generic EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

Associated Types

type Rep EndpointSummary :: Type -> Type #

Methods

from :: EndpointSummary -> Rep EndpointSummary x #

to :: Rep EndpointSummary x -> EndpointSummary #

NFData EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

Methods

rnf :: EndpointSummary -> () #

Hashable EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

Methods

hashWithSalt :: Int -> EndpointSummary -> Int #

hash :: EndpointSummary -> Int #

FromJSON EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

Methods

parseJSON :: Value -> Parser EndpointSummary #

parseJSONList :: Value -> Parser [EndpointSummary] #

type Rep EndpointSummary Source # 
Instance details

Defined in Amazonka.SageMaker.Types.EndpointSummary

type Rep EndpointSummary = D1 ('MetaData "EndpointSummary" "Amazonka.SageMaker.Types.EndpointSummary" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "EndpointSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EndpointStatus)))))

newEndpointSummary Source #

Arguments

:: Text

$sel:endpointName:EndpointSummary'

-> Text

$sel:endpointArn:EndpointSummary'

-> UTCTime

$sel:creationTime:EndpointSummary'

-> UTCTime

$sel:lastModifiedTime:EndpointSummary'

-> EndpointStatus

$sel:endpointStatus:EndpointSummary'

-> EndpointSummary 

Create a value of EndpointSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointName:EndpointSummary', endpointSummary_endpointName - The name of the endpoint.

$sel:endpointArn:EndpointSummary', endpointSummary_endpointArn - The Amazon Resource Name (ARN) of the endpoint.

$sel:creationTime:EndpointSummary', endpointSummary_creationTime - A timestamp that shows when the endpoint was created.

$sel:lastModifiedTime:EndpointSummary', endpointSummary_lastModifiedTime - A timestamp that shows when the endpoint was last modified.

$sel:endpointStatus:EndpointSummary', endpointSummary_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 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.

endpointSummary_endpointName :: Lens' EndpointSummary Text Source #

The name of the endpoint.

endpointSummary_endpointArn :: Lens' EndpointSummary Text Source #

The Amazon Resource Name (ARN) of the endpoint.

endpointSummary_creationTime :: Lens' EndpointSummary UTCTime Source #

A timestamp that shows when the endpoint was created.

endpointSummary_lastModifiedTime :: Lens' EndpointSummary UTCTime Source #

A timestamp that shows when the endpoint was last modified.

endpointSummary_endpointStatus :: Lens' EndpointSummary EndpointStatus Source #

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.

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