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

Description

Returns the description of an endpoint.

Synopsis

Creating a Request

data DescribeEndpoint Source #

See: newDescribeEndpoint smart constructor.

Constructors

DescribeEndpoint' 

Fields

Instances

Instances details
Eq DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

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

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

Read DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

readsPrec :: Int -> ReadS DescribeEndpoint #

readList :: ReadS [DescribeEndpoint] #

readPrec :: ReadPrec DescribeEndpoint #

readListPrec :: ReadPrec [DescribeEndpoint] #

Show DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

showsPrec :: Int -> DescribeEndpoint -> ShowS #

show :: DescribeEndpoint -> String #

showList :: [DescribeEndpoint] -> ShowS #

Generic DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Associated Types

type Rep DescribeEndpoint :: Type -> Type #

Methods

from :: DescribeEndpoint -> Rep DescribeEndpoint x #

to :: Rep DescribeEndpoint x -> DescribeEndpoint #

NFData DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

rnf :: DescribeEndpoint -> () #

Hashable DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

hashWithSalt :: Int -> DescribeEndpoint -> Int #

hash :: DescribeEndpoint -> Int #

ToJSON DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

toJSON :: DescribeEndpoint -> Value #

toEncoding :: DescribeEndpoint -> Encoding #

toJSONList :: [DescribeEndpoint] -> Value #

toEncodingList :: [DescribeEndpoint] -> Encoding #

AWSRequest DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Associated Types

type AWSResponse DescribeEndpoint #

Methods

request :: DescribeEndpoint -> Request DescribeEndpoint #

response :: MonadResource m => Logger -> Service -> Proxy DescribeEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpoint))) #

ToHeaders DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

toHeaders :: DescribeEndpoint -> [Header] #

ToPath DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

toPath :: DescribeEndpoint -> ByteString #

ToQuery DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

toQuery :: DescribeEndpoint -> QueryString #

type Rep DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

type Rep DescribeEndpoint = D1 ('MetaData "DescribeEndpoint" "Amazonka.SageMaker.DescribeEndpoint" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeEndpoint Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

type AWSResponse DescribeEndpoint = DescribeEndpointResponse

newDescribeEndpoint Source #

Arguments

:: Text

$sel:endpointName:DescribeEndpoint'

-> DescribeEndpoint 

Create a value of DescribeEndpoint 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:DescribeEndpoint', describeEndpoint_endpointName - The name of the endpoint.

Request Lenses

describeEndpoint_endpointName :: Lens' DescribeEndpoint Text Source #

The name of the endpoint.

Destructuring the Response

data DescribeEndpointResponse Source #

See: newDescribeEndpointResponse smart constructor.

Constructors

DescribeEndpointResponse' 

Fields

  • failureReason :: Maybe Text

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

  • asyncInferenceConfig :: Maybe AsyncInferenceConfig

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

  • productionVariants :: Maybe (NonEmpty ProductionVariantSummary)

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

  • lastDeploymentConfig :: Maybe DeploymentConfig

    The most recent deployment configuration for the endpoint.

  • dataCaptureConfig :: Maybe DataCaptureConfigSummary
     
  • httpStatus :: Int

    The response's http status code.

  • endpointName :: Text

    Name of the endpoint.

  • endpointArn :: Text

    The Amazon Resource Name (ARN) of the endpoint.

  • endpointConfigName :: Text

    The name of the endpoint configuration associated with this endpoint.

  • 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.
  • creationTime :: POSIX

    A timestamp that shows when the endpoint was created.

  • lastModifiedTime :: POSIX

    A timestamp that shows when the endpoint was last modified.

Instances

Instances details
Eq DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

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

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

Read DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

readsPrec :: Int -> ReadS DescribeEndpointResponse #

readList :: ReadS [DescribeEndpointResponse] #

readPrec :: ReadPrec DescribeEndpointResponse #

readListPrec :: ReadPrec [DescribeEndpointResponse] #

Show DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

showsPrec :: Int -> DescribeEndpointResponse -> ShowS #

show :: DescribeEndpointResponse -> String #

showList :: [DescribeEndpointResponse] -> ShowS #

Generic DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Associated Types

type Rep DescribeEndpointResponse :: Type -> Type #

Methods

from :: DescribeEndpointResponse -> Rep DescribeEndpointResponse x #

to :: Rep DescribeEndpointResponse x -> DescribeEndpointResponse #

NFData DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

Methods

rnf :: DescribeEndpointResponse -> () #

type Rep DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeEndpoint

type Rep DescribeEndpointResponse = D1 ('MetaData "DescribeEndpointResponse" "Amazonka.SageMaker.DescribeEndpoint" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeEndpointResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "asyncInferenceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AsyncInferenceConfig)) :*: S1 ('MetaSel ('Just "productionVariants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ProductionVariantSummary))))) :*: (S1 ('MetaSel ('Just "lastDeploymentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentConfig)) :*: (S1 ('MetaSel ('Just "dataCaptureConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataCaptureConfigSummary)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endpointConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "endpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EndpointStatus) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribeEndpointResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeEndpointResponse'

-> Text

$sel:endpointName:DescribeEndpoint'

-> Text

$sel:endpointArn:DescribeEndpointResponse'

-> Text

$sel:endpointConfigName:DescribeEndpointResponse'

-> EndpointStatus

$sel:endpointStatus:DescribeEndpointResponse'

-> UTCTime

$sel:creationTime:DescribeEndpointResponse'

-> UTCTime

$sel:lastModifiedTime:DescribeEndpointResponse'

-> DescribeEndpointResponse 

Create a value of DescribeEndpointResponse 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:failureReason:DescribeEndpointResponse', describeEndpointResponse_failureReason - If the status of the endpoint is Failed, the reason why it failed.

$sel:asyncInferenceConfig:DescribeEndpointResponse', describeEndpointResponse_asyncInferenceConfig - Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

$sel:productionVariants:DescribeEndpointResponse', describeEndpointResponse_productionVariants - An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

$sel:lastDeploymentConfig:DescribeEndpointResponse', describeEndpointResponse_lastDeploymentConfig - The most recent deployment configuration for the endpoint.

$sel:dataCaptureConfig:DescribeEndpointResponse', describeEndpointResponse_dataCaptureConfig - Undocumented member.

$sel:httpStatus:DescribeEndpointResponse', describeEndpointResponse_httpStatus - The response's http status code.

$sel:endpointName:DescribeEndpoint', describeEndpointResponse_endpointName - Name of the endpoint.

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

$sel:endpointConfigName:DescribeEndpointResponse', describeEndpointResponse_endpointConfigName - The name of the endpoint configuration associated with this endpoint.

$sel:endpointStatus:DescribeEndpointResponse', describeEndpointResponse_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.

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

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

Response Lenses

describeEndpointResponse_failureReason :: Lens' DescribeEndpointResponse (Maybe Text) Source #

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

describeEndpointResponse_asyncInferenceConfig :: Lens' DescribeEndpointResponse (Maybe AsyncInferenceConfig) Source #

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

describeEndpointResponse_productionVariants :: Lens' DescribeEndpointResponse (Maybe (NonEmpty ProductionVariantSummary)) Source #

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

describeEndpointResponse_lastDeploymentConfig :: Lens' DescribeEndpointResponse (Maybe DeploymentConfig) Source #

The most recent deployment configuration for the endpoint.

describeEndpointResponse_dataCaptureConfig :: Lens' DescribeEndpointResponse (Maybe DataCaptureConfigSummary) Source #

Undocumented member.

describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #

The response's http status code.

describeEndpointResponse_endpointName :: Lens' DescribeEndpointResponse Text Source #

Name of the endpoint.

describeEndpointResponse_endpointArn :: Lens' DescribeEndpointResponse Text Source #

The Amazon Resource Name (ARN) of the endpoint.

describeEndpointResponse_endpointConfigName :: Lens' DescribeEndpointResponse Text Source #

The name of the endpoint configuration associated with this endpoint.

describeEndpointResponse_endpointStatus :: Lens' DescribeEndpointResponse 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.

describeEndpointResponse_creationTime :: Lens' DescribeEndpointResponse UTCTime Source #

A timestamp that shows when the endpoint was created.

describeEndpointResponse_lastModifiedTime :: Lens' DescribeEndpointResponse UTCTime Source #

A timestamp that shows when the endpoint was last modified.