Network.AWS.SageMakerRuntime.InvokeEndpoint

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.

For an overview of Amazon SageMaker, see How It Works

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Creating a Request

invokeEndpoint

Arguments

:: Text

ieEndpointName

-> ByteString

ieBody

-> InvokeEndpoint

Creates a value of InvokeEndpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ieAccept - The desired MIME type of the inference in the response.
• ieContentType - The MIME type of the input data in the request body.
• ieEndpointName - The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
• ieBody - Provides input data, in the format specified in the ContentType request header. Amazon SageMaker passes all of the data in the body to the model.

data InvokeEndpoint

See: invokeEndpoint smart constructor.

Instances

Eq InvokeEndpoint

Methods

(==) :: InvokeEndpoint -> InvokeEndpoint -> Bool

(/=) :: InvokeEndpoint -> InvokeEndpoint -> Bool

Data InvokeEndpoint

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InvokeEndpoint -> c InvokeEndpoint

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InvokeEndpoint

toConstr :: InvokeEndpoint -> Constr

dataTypeOf :: InvokeEndpoint -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c InvokeEndpoint)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InvokeEndpoint)

gmapT :: (forall b. Data b => b -> b) -> InvokeEndpoint -> InvokeEndpoint

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InvokeEndpoint -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InvokeEndpoint -> r

gmapQ :: (forall d. Data d => d -> u) -> InvokeEndpoint -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InvokeEndpoint -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InvokeEndpoint -> m InvokeEndpoint

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InvokeEndpoint -> m InvokeEndpoint

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InvokeEndpoint -> m InvokeEndpoint

Read InvokeEndpoint

Methods

readsPrec :: Int -> ReadS InvokeEndpoint

readList :: ReadS [InvokeEndpoint]

readPrec :: ReadPrec InvokeEndpoint

readListPrec :: ReadPrec [InvokeEndpoint]

Show InvokeEndpoint

Methods

showsPrec :: Int -> InvokeEndpoint -> ShowS

show :: InvokeEndpoint -> String

showList :: [InvokeEndpoint] -> ShowS

Generic InvokeEndpoint

Associated Types

type Rep InvokeEndpoint :: * -> *

Methods

from :: InvokeEndpoint -> Rep InvokeEndpoint x

to :: Rep InvokeEndpoint x -> InvokeEndpoint

Hashable InvokeEndpoint

Methods

hashWithSalt :: Int -> InvokeEndpoint -> Int

hash :: InvokeEndpoint -> Int

NFData InvokeEndpoint

Methods

rnf :: InvokeEndpoint -> ()

AWSRequest InvokeEndpoint

Associated Types

type Rs InvokeEndpoint :: *

Methods

request :: InvokeEndpoint -> Request InvokeEndpoint

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * InvokeEndpoint -> ClientResponse -> m (Response InvokeEndpoint)

ToBody InvokeEndpoint

Methods

toBody :: InvokeEndpoint -> RqBody

ToHeaders InvokeEndpoint

Methods

toHeaders :: InvokeEndpoint -> [Header]

ToPath InvokeEndpoint

Methods

toPath :: InvokeEndpoint -> ByteString

ToQuery InvokeEndpoint

Methods

toQuery :: InvokeEndpoint -> QueryString

type Rep InvokeEndpoint

type Rep InvokeEndpoint = D1 * (MetaData "InvokeEndpoint" "Network.AWS.SageMakerRuntime.InvokeEndpoint" "amazonka-sagemaker-runtime-1.6.0-7TCucxy2RauBXhfkmSNsvw" False) (C1 * (MetaCons "InvokeEndpoint'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ieAccept") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ieContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ieEndpointName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_ieBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ByteString)))))

type Rs InvokeEndpoint

type Rs InvokeEndpoint = InvokeEndpointResponse

Request Lenses

ieAccept :: Lens' InvokeEndpoint (Maybe Text)

The desired MIME type of the inference in the response.

ieContentType :: Lens' InvokeEndpoint (Maybe Text)

The MIME type of the input data in the request body.

ieEndpointName :: Lens' InvokeEndpoint Text

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

ieBody :: Lens' InvokeEndpoint ByteString

Provides input data, in the format specified in the ContentType request header. Amazon SageMaker passes all of the data in the body to the model.

Destructuring the Response

invokeEndpointResponse

Arguments

:: Int

iersResponseStatus

-> ByteString

iersBody

-> InvokeEndpointResponse

Creates a value of InvokeEndpointResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• iersInvokedProductionVariant - Identifies the production variant that was invoked.
• iersContentType - The MIME type of the inference returned in the response body.
• iersResponseStatus - -- | The response status code.
• iersBody - Includes the inference provided by the model.

data InvokeEndpointResponse

See: invokeEndpointResponse smart constructor.

Instances

Eq InvokeEndpointResponse

Methods

(==) :: InvokeEndpointResponse -> InvokeEndpointResponse -> Bool

(/=) :: InvokeEndpointResponse -> InvokeEndpointResponse -> Bool

Data InvokeEndpointResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InvokeEndpointResponse -> c InvokeEndpointResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InvokeEndpointResponse

toConstr :: InvokeEndpointResponse -> Constr

dataTypeOf :: InvokeEndpointResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c InvokeEndpointResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InvokeEndpointResponse)

gmapT :: (forall b. Data b => b -> b) -> InvokeEndpointResponse -> InvokeEndpointResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InvokeEndpointResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InvokeEndpointResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> InvokeEndpointResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InvokeEndpointResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InvokeEndpointResponse -> m InvokeEndpointResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InvokeEndpointResponse -> m InvokeEndpointResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InvokeEndpointResponse -> m InvokeEndpointResponse

Read InvokeEndpointResponse

Methods

readsPrec :: Int -> ReadS InvokeEndpointResponse

readList :: ReadS [InvokeEndpointResponse]

readPrec :: ReadPrec InvokeEndpointResponse

readListPrec :: ReadPrec [InvokeEndpointResponse]

Show InvokeEndpointResponse

Methods

showsPrec :: Int -> InvokeEndpointResponse -> ShowS

show :: InvokeEndpointResponse -> String

showList :: [InvokeEndpointResponse] -> ShowS

Generic InvokeEndpointResponse

Associated Types

type Rep InvokeEndpointResponse :: * -> *

Methods

from :: InvokeEndpointResponse -> Rep InvokeEndpointResponse x

to :: Rep InvokeEndpointResponse x -> InvokeEndpointResponse

NFData InvokeEndpointResponse

Methods

rnf :: InvokeEndpointResponse -> ()

type Rep InvokeEndpointResponse

type Rep InvokeEndpointResponse = D1 * (MetaData "InvokeEndpointResponse" "Network.AWS.SageMakerRuntime.InvokeEndpoint" "amazonka-sagemaker-runtime-1.6.0-7TCucxy2RauBXhfkmSNsvw" False) (C1 * (MetaCons "InvokeEndpointResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_iersInvokedProductionVariant") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_iersContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_iersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_iersBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ByteString)))))

Response Lenses

iersInvokedProductionVariant :: Lens' InvokeEndpointResponse (Maybe Text)

Identifies the production variant that was invoked.

iersContentType :: Lens' InvokeEndpointResponse (Maybe Text)

The MIME type of the inference returned in the response body.

iersResponseStatus :: Lens' InvokeEndpointResponse Int

• - | The response status code.

iersBody :: Lens' InvokeEndpointResponse ByteString

Includes the inference provided by the model.