sagemakerruntime

Documentation

Overview

Package sagemakerruntime provides the client and types for making API requests to Amazon SageMaker Runtime.

The Amazon SageMaker runtime API.

See https://docs.aws.amazon.com/goto/WebAPI/runtime.sagemaker-2017-05-13 for more information on this service.

See sagemakerruntime package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sagemakerruntime/

Using the Client

To use Amazon SageMaker Runtime with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon SageMaker Runtime client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sagemakerruntime/#New

Index

• Constants
• type Client
  • func New(config aws.Config) *Client
  • func (c *Client) InvokeEndpointRequest(input *InvokeEndpointInput) InvokeEndpointRequest
• type InvokeEndpointInput
  • func (s InvokeEndpointInput) MarshalFields(e protocol.FieldEncoder) error
  • func (s InvokeEndpointInput) String() string
  • func (s *InvokeEndpointInput) Validate() error
• type InvokeEndpointOutput
  • func (s InvokeEndpointOutput) MarshalFields(e protocol.FieldEncoder) error
  • func (s InvokeEndpointOutput) String() string
• type InvokeEndpointRequest
  • func (r InvokeEndpointRequest) Send(ctx context.Context) (*InvokeEndpointResponse, error)
• type InvokeEndpointResponse
  • func (r *InvokeEndpointResponse) SDKResponseMetdata() *aws.Response

Constants

const (
	ServiceName = "Amazon SageMaker Runtime" // Service's name
	ServiceID   = "SageMakerRuntime"         // Service's identifier
	EndpointsID = "runtime.sagemaker"        // Service's Endpoint identifier
)

const (

	// ErrCodeInternalFailure for service response error code
	// "InternalFailure".
	//
	// An internal failure occurred.
	ErrCodeInternalFailure = "InternalFailure"

	// ErrCodeModelError for service response error code
	// "ModelError".
	//
	// Model (owned by the customer in the container) returned 4xx or 5xx error
	// code.
	ErrCodeModelError = "ModelError"

	// ErrCodeServiceUnavailable for service response error code
	// "ServiceUnavailable".
	//
	// The service is unavailable. Try your call again.
	ErrCodeServiceUnavailable = "ServiceUnavailable"

	// ErrCodeValidationError for service response error code
	// "ValidationError".
	//
	// Inspect your request and try again.
	ErrCodeValidationError = "ValidationError"
)

Types

type Client

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon SageMaker Runtime. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := sagemakerruntime.New(myConfig)

func (*Client) InvokeEndpointRequest

func (c *Client) InvokeEndpointRequest(input *InvokeEndpointInput) InvokeEndpointRequest

InvokeEndpointRequest returns a request value for making API operation for Amazon SageMaker Runtime.

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 (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html).

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.

Calls to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) (http://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) in the Amazon S3 API Reference.

A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to the /invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.

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.

// Example sending a request using InvokeEndpointRequest.
req := client.InvokeEndpointRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/runtime.sagemaker-2017-05-13/InvokeEndpoint

type InvokeEndpointInput

type InvokeEndpointInput struct {

	// The desired MIME type of the inference in the response.
	Accept *string `location:"header" locationName:"Accept" type:"string"`

	// 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
	// (https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html).
	//
	// Body is a required field
	Body []byte `type:"blob" required:"true" sensitive:"true"`

	// The MIME type of the input data in the request body.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// Provides additional information about a request for an inference submitted
	// to a model hosted at an Amazon SageMaker endpoint. The information is an
	// opaque value that is forwarded verbatim. You could use this value, for example,
	// to provide an ID that you can use to track a request or to provide other
	// metadata that a service endpoint was programmed to process. The value must
	// consist of no more than 1024 visible US-ASCII characters as specified in
	// Section 3.3.6. Field Value Components (https://tools.ietf.org/html/rfc7230#section-3.2.6)
	// of the Hypertext Transfer Protocol (HTTP/1.1). This feature is currently
	// supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
	CustomAttributes *string `location:"header" locationName:"X-Amzn-SageMaker-Custom-Attributes" type:"string" sensitive:"true"`

	// The name of the endpoint that you specified when you created the endpoint
	// using the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html)
	// API.
	//
	// EndpointName is a required field
	EndpointName *string `location:"uri" locationName:"EndpointName" type:"string" required:"true"`

	// Specifies the model to be requested for an inference when invoking a multi-model
	// endpoint.
	TargetModel *string `location:"header" locationName:"X-Amzn-SageMaker-Target-Model" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (InvokeEndpointInput) MarshalFields

func (s InvokeEndpointInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InvokeEndpointInput) String

func (s InvokeEndpointInput) String() string

String returns the string representation

func (*InvokeEndpointInput) Validate

func (s *InvokeEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InvokeEndpointOutput

type InvokeEndpointOutput struct {

	// Includes the inference provided by the model.
	//
	// For information about the format of the response body, see Common Data Formats—Inference
	// (https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html).
	//
	// Body is a required field
	Body []byte `type:"blob" required:"true" sensitive:"true"`

	// The MIME type of the inference returned in the response body.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// Provides additional information in the response about the inference returned
	// by a model hosted at an Amazon SageMaker endpoint. The information is an
	// opaque value that is forwarded verbatim. You could use this value, for example,
	// to return an ID received in the CustomAttributes header of a request or other
	// metadata that a service endpoint was programmed to produce. The value must
	// consist of no more than 1024 visible US-ASCII characters as specified in
	// Section 3.3.6. Field Value Components (https://tools.ietf.org/html/rfc7230#section-3.2.6)
	// of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the
	// custom attribute returned, the model must set the custom attribute to be
	// included on the way back.
	//
	// This feature is currently supported in the AWS SDKs but not in the Amazon
	// SageMaker Python SDK.
	CustomAttributes *string `location:"header" locationName:"X-Amzn-SageMaker-Custom-Attributes" type:"string" sensitive:"true"`

	// Identifies the production variant that was invoked.
	InvokedProductionVariant *string `location:"header" locationName:"x-Amzn-Invoked-Production-Variant" type:"string"`
	// contains filtered or unexported fields
}

func (InvokeEndpointOutput) MarshalFields

func (s InvokeEndpointOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InvokeEndpointOutput) String

func (s InvokeEndpointOutput) String() string

String returns the string representation

type InvokeEndpointRequest

type InvokeEndpointRequest struct {
	*aws.Request
	Input *InvokeEndpointInput
	Copy  func(*InvokeEndpointInput) InvokeEndpointRequest
}

InvokeEndpointRequest is the request type for the InvokeEndpoint API operation.

func (InvokeEndpointRequest) Send

func (r InvokeEndpointRequest) Send(ctx context.Context) (*InvokeEndpointResponse, error)

Send marshals and sends the InvokeEndpoint API request.

type InvokeEndpointResponse

type InvokeEndpointResponse struct {
	*InvokeEndpointOutput
	// contains filtered or unexported fields
}

InvokeEndpointResponse is the response type for the InvokeEndpoint API operation.

func (*InvokeEndpointResponse) SDKResponseMetdata

func (r *InvokeEndpointResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the InvokeEndpoint request.