sagemakerruntime

Documentation

Overview

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

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 contact 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 SageMakerRuntime for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sagemakerruntime/#New

Index

• Constants
• type InvokeEndpointInput
  • func (s InvokeEndpointInput) GoString() string
  • func (s *InvokeEndpointInput) SetAccept(v string) *InvokeEndpointInput
  • func (s *InvokeEndpointInput) SetBody(v []byte) *InvokeEndpointInput
  • func (s *InvokeEndpointInput) SetContentType(v string) *InvokeEndpointInput
  • func (s *InvokeEndpointInput) SetEndpointName(v string) *InvokeEndpointInput
  • func (s InvokeEndpointInput) String() string
  • func (s *InvokeEndpointInput) Validate() error
• type InvokeEndpointOutput
  • func (s InvokeEndpointOutput) GoString() string
  • func (s *InvokeEndpointOutput) SetBody(v []byte) *InvokeEndpointOutput
  • func (s *InvokeEndpointOutput) SetContentType(v string) *InvokeEndpointOutput
  • func (s *InvokeEndpointOutput) SetInvokedProductionVariant(v string) *InvokeEndpointOutput
  • func (s InvokeEndpointOutput) String() string
• type SageMakerRuntime
  • func New(p client.ConfigProvider, cfgs ...*aws.Config) *SageMakerRuntime
  • func (c *SageMakerRuntime) InvokeEndpoint(input *InvokeEndpointInput) (*InvokeEndpointOutput, error)
  • func (c *SageMakerRuntime) InvokeEndpointRequest(input *InvokeEndpointInput) (req *request.Request, output *InvokeEndpointOutput)
  • func (c *SageMakerRuntime) InvokeEndpointWithContext(ctx aws.Context, input *InvokeEndpointInput, opts ...request.Option) (*InvokeEndpointOutput, error)

Constants

const (

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

	// ErrCodeModelError for service response error code
	// "ModelError".
	//
	// Model (owned by the customer in the container) returned an error 500.
	ErrCodeModelError = "ModelError"

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

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

const (
	ServiceName = "runtime.sagemaker" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName         // Service ID for Regions and Endpoints metadata.
)

Service information constants

Types

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.
	//
	// Body is a required field
	Body []byte `type:"blob" required:"true"`

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

	// The name of the endpoint that you specified when you created the endpoint
	// using the CreateEndpoint (http://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"`
	// contains filtered or unexported fields
}

func (InvokeEndpointInput) GoString

func (s InvokeEndpointInput) GoString() string

GoString returns the string representation

func (*InvokeEndpointInput) SetAccept

func (s *InvokeEndpointInput) SetAccept(v string) *InvokeEndpointInput

SetAccept sets the Accept field's value.

func (*InvokeEndpointInput) SetBody

func (s *InvokeEndpointInput) SetBody(v []byte) *InvokeEndpointInput

SetBody sets the Body field's value.

func (*InvokeEndpointInput) SetContentType

func (s *InvokeEndpointInput) SetContentType(v string) *InvokeEndpointInput

SetContentType sets the ContentType field's value.

func (*InvokeEndpointInput) SetEndpointName

func (s *InvokeEndpointInput) SetEndpointName(v string) *InvokeEndpointInput

SetEndpointName sets the EndpointName field's value.

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.
	//
	// Body is a required field
	Body []byte `type:"blob" required:"true"`

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

	// 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) GoString

func (s InvokeEndpointOutput) GoString() string

GoString returns the string representation

func (*InvokeEndpointOutput) SetBody

func (s *InvokeEndpointOutput) SetBody(v []byte) *InvokeEndpointOutput

SetBody sets the Body field's value.

func (*InvokeEndpointOutput) SetContentType

func (s *InvokeEndpointOutput) SetContentType(v string) *InvokeEndpointOutput

SetContentType sets the ContentType field's value.

func (*InvokeEndpointOutput) SetInvokedProductionVariant

func (s *InvokeEndpointOutput) SetInvokedProductionVariant(v string) *InvokeEndpointOutput

SetInvokedProductionVariant sets the InvokedProductionVariant field's value.

func (InvokeEndpointOutput) String

func (s InvokeEndpointOutput) String() string

String returns the string representation

type SageMakerRuntime

type SageMakerRuntime struct {
	*client.Client
}

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

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

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SageMakerRuntime

New creates a new instance of the SageMakerRuntime client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a SageMakerRuntime client from just a session.
svc := sagemakerruntime.New(mySession)

// Create a SageMakerRuntime client with additional configuration
svc := sagemakerruntime.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SageMakerRuntime) InvokeEndpoint

func (c *SageMakerRuntime) InvokeEndpoint(input *InvokeEndpointInput) (*InvokeEndpointOutput, error)

InvokeEndpoint 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 (http://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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon SageMaker Runtime's API operation InvokeEndpoint for usage and error information.

Returned Error Codes:

• ErrCodeInternalFailure "InternalFailure" Internal failure occurred.

• ErrCodeServiceUnavailable "ServiceUnavailable" Service is unavailable. Try your call again.

• ErrCodeValidationError "ValidationError" Inspect your request and try again.

• ErrCodeModelError "ModelError" Model (owned by the customer in the container) returned an error 500.

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

func (*SageMakerRuntime) InvokeEndpointRequest

func (c *SageMakerRuntime) InvokeEndpointRequest(input *InvokeEndpointInput) (req *request.Request, output *InvokeEndpointOutput)

InvokeEndpointRequest generates a "aws/request.Request" representing the client's request for the InvokeEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InvokeEndpoint for more information on using the InvokeEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the InvokeEndpointRequest method.
req, resp := client.InvokeEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*SageMakerRuntime) InvokeEndpointWithContext

func (c *SageMakerRuntime) InvokeEndpointWithContext(ctx aws.Context, input *InvokeEndpointInput, opts ...request.Option) (*InvokeEndpointOutput, error)

InvokeEndpointWithContext is the same as InvokeEndpoint with the addition of the ability to pass a context and additional request options.

See InvokeEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.