Amazon SageMaker Runtime

2018/08/29 - Amazon SageMaker Runtime - 1 updated api methods

Changes  SageMaker Runtime supports CustomAttributes header which allows customers provide additional information in a request for an inference submitted to a model or in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint.

InvokeEndpoint (updated) Link ¶
Changes (both) 
{'CustomAttributes': 'string'}

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.

Cals to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference .

Note

Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.

See also: AWS API Documentation

Request Syntax

client.invoke_endpoint(
    EndpointName='string',
    Body=b'bytes'|file,
    ContentType='string',
    Accept='string',
    CustomAttributes='string'
)
type EndpointName

string

param EndpointName

[REQUIRED]

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

type Body

bytes or seekable file-like object

param Body

[REQUIRED]

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.

For information about the format of the request body, see Common Data Formats—Inference.

type ContentType

string

param ContentType

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

type Accept

string

param Accept

The desired MIME type of the inference in the response.

type CustomAttributes

string

param CustomAttributes

rtype

dict

returns

Response Syntax

{
    'Body': b'bytes'|file,
    'ContentType': 'string',
    'InvokedProductionVariant': 'string',
    'CustomAttributes': 'string'
}

Response Structure

  • (dict) --

    • Body (bytes or seekable file-like object) --

      Includes the inference provided by the model.

      For information about the format of the response body, see Common Data Formats—Inference.

    • ContentType (string) --

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

    • InvokedProductionVariant (string) --

      Identifies the production variant that was invoked.

    • CustomAttributes (string) --