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

View Source
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"
)
View Source
const (
	ServiceName = "runtime.sagemaker" // Name of service.
	EndpointsID = ServiceName         // ID to lookup a service endpoint with.
	ServiceID   = "SageMaker Runtime" // ServiceID is a unique identifier of a specific service.
)

    Service information constants

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type InternalFailure

    type InternalFailure struct {
    	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
    
    	Message_ *string `locationName:"Message" type:"string"`
    	// contains filtered or unexported fields
    }

      An internal failure occurred.

      func (*InternalFailure) Code

      func (s *InternalFailure) Code() string

        Code returns the exception type name.

        func (*InternalFailure) Error

        func (s *InternalFailure) Error() string

        func (InternalFailure) GoString

        func (s InternalFailure) GoString() string

          GoString returns the string representation

          func (*InternalFailure) Message

          func (s *InternalFailure) Message() string

            Message returns the exception's message.

            func (*InternalFailure) OrigErr

            func (s *InternalFailure) OrigErr() error

              OrigErr always returns nil, satisfies awserr.Error interface.

              func (*InternalFailure) RequestID

              func (s *InternalFailure) RequestID() string

                RequestID returns the service's response RequestID for request.

                func (*InternalFailure) StatusCode

                func (s *InternalFailure) StatusCode() int

                  Status code returns the HTTP status code for the request's response error.

                  func (InternalFailure) String

                  func (s InternalFailure) String() string

                    String returns the string representation

                    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).
                    	//
                    	// The code in your model is responsible for setting or updating any custom
                    	// attributes in the response. If your code does not set this value in the response,
                    	// an empty value is returned. For example, if a custom attribute represents
                    	// the trace ID, your model can prepend the custom attribute with Trace ID:
                    	// in your post-processing function.
                    	//
                    	// 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"`
                    
                    	// If you provide a value, it is added to the captured data when you enable
                    	// data capture on the endpoint. For information about data capture, see Capture
                    	// Data (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html).
                    	InferenceId *string `location:"header" locationName:"X-Amzn-SageMaker-Inference-Id" min:"1" type:"string"`
                    
                    	// If the endpoint hosts multiple containers and is configured to use direct
                    	// invocation, this parameter specifies the host name of the container to invoke.
                    	TargetContainerHostname *string `location:"header" locationName:"X-Amzn-SageMaker-Target-Container-Hostname" type:"string"`
                    
                    	// The model to request for inference when invoking a multi-model endpoint.
                    	TargetModel *string `location:"header" locationName:"X-Amzn-SageMaker-Target-Model" min:"1" type:"string"`
                    
                    	// Specify the production variant to send the inference request to when invoking
                    	// an endpoint that is running two or more variants. Note that this parameter
                    	// overrides the default behavior for the endpoint, which is to distribute the
                    	// invocation traffic based on the variant weights.
                    	//
                    	// For information about how to use variant targeting to perform a/b testing,
                    	// see Test models in production (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html)
                    	TargetVariant *string `location:"header" locationName:"X-Amzn-SageMaker-Target-Variant" type:"string"`
                    	// contains filtered or unexported fields
                    }

                    func (InvokeEndpointInput) GoString

                    func (s InvokeEndpointInput) GoString() string

                      GoString returns the string representation

                      func (*InvokeEndpointInput) SetAccept

                        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) SetCustomAttributes

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

                              SetCustomAttributes sets the CustomAttributes field's value.

                              func (*InvokeEndpointInput) SetEndpointName

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

                                SetEndpointName sets the EndpointName field's value.

                                func (*InvokeEndpointInput) SetInferenceId

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

                                  SetInferenceId sets the InferenceId field's value.

                                  func (*InvokeEndpointInput) SetTargetContainerHostname

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

                                    SetTargetContainerHostname sets the TargetContainerHostname field's value.

                                    func (*InvokeEndpointInput) SetTargetModel

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

                                      SetTargetModel sets the TargetModel field's value.

                                      func (*InvokeEndpointInput) SetTargetVariant

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

                                        SetTargetVariant sets the TargetVariant 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.
                                            	//
                                            	// 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.
                                            	//
                                            	// The code in your model is responsible for setting or updating any custom
                                            	// attributes in the response. If your code does not set this value in the response,
                                            	// an empty value is returned. For example, if a custom attribute represents
                                            	// the trace ID, your model can prepend the custom attribute with Trace ID:
                                            	// in your post-processing function.
                                            	//
                                            	// 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) GoString

                                            func (s InvokeEndpointOutput) GoString() string

                                              GoString returns the string representation

                                              func (*InvokeEndpointOutput) SetBody

                                                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) SetCustomAttributes

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

                                                    SetCustomAttributes sets the CustomAttributes 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 ModelError

                                                        type ModelError struct {
                                                        	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                        
                                                        	// The Amazon Resource Name (ARN) of the log stream.
                                                        	LogStreamArn *string `type:"string"`
                                                        
                                                        	Message_ *string `locationName:"Message" type:"string"`
                                                        
                                                        	// Original message.
                                                        	OriginalMessage *string `type:"string"`
                                                        
                                                        	// Original status code.
                                                        	OriginalStatusCode *int64 `type:"integer"`
                                                        	// contains filtered or unexported fields
                                                        }

                                                          Model (owned by the customer in the container) returned 4xx or 5xx error code.

                                                          func (*ModelError) Code

                                                          func (s *ModelError) Code() string

                                                            Code returns the exception type name.

                                                            func (*ModelError) Error

                                                            func (s *ModelError) Error() string

                                                            func (ModelError) GoString

                                                            func (s ModelError) GoString() string

                                                              GoString returns the string representation

                                                              func (*ModelError) Message

                                                              func (s *ModelError) Message() string

                                                                Message returns the exception's message.

                                                                func (*ModelError) OrigErr

                                                                func (s *ModelError) OrigErr() error

                                                                  OrigErr always returns nil, satisfies awserr.Error interface.

                                                                  func (*ModelError) RequestID

                                                                  func (s *ModelError) RequestID() string

                                                                    RequestID returns the service's response RequestID for request.

                                                                    func (*ModelError) StatusCode

                                                                    func (s *ModelError) StatusCode() int

                                                                      Status code returns the HTTP status code for the request's response error.

                                                                      func (ModelError) String

                                                                      func (s ModelError) 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

                                                                            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:

                                                                            mySession := session.Must(session.NewSession())
                                                                            
                                                                            // 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 (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) (https://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 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.

                                                                              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 Types:

                                                                              * InternalFailure
                                                                              An internal failure occurred.
                                                                              
                                                                              * ServiceUnavailable
                                                                              The service is unavailable. Try your call again.
                                                                              
                                                                              * ValidationError
                                                                              Inspect your request and try again.
                                                                              
                                                                              * ModelError
                                                                              Model (owned by the customer in the container) returned 4xx or 5xx error
                                                                              code.
                                                                              

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

                                                                                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.

                                                                                  type ServiceUnavailable

                                                                                  type ServiceUnavailable struct {
                                                                                  	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                                                  
                                                                                  	Message_ *string `locationName:"Message" type:"string"`
                                                                                  	// contains filtered or unexported fields
                                                                                  }

                                                                                    The service is unavailable. Try your call again.

                                                                                    func (*ServiceUnavailable) Code

                                                                                    func (s *ServiceUnavailable) Code() string

                                                                                      Code returns the exception type name.

                                                                                      func (*ServiceUnavailable) Error

                                                                                      func (s *ServiceUnavailable) Error() string

                                                                                      func (ServiceUnavailable) GoString

                                                                                      func (s ServiceUnavailable) GoString() string

                                                                                        GoString returns the string representation

                                                                                        func (*ServiceUnavailable) Message

                                                                                        func (s *ServiceUnavailable) Message() string

                                                                                          Message returns the exception's message.

                                                                                          func (*ServiceUnavailable) OrigErr

                                                                                          func (s *ServiceUnavailable) OrigErr() error

                                                                                            OrigErr always returns nil, satisfies awserr.Error interface.

                                                                                            func (*ServiceUnavailable) RequestID

                                                                                            func (s *ServiceUnavailable) RequestID() string

                                                                                              RequestID returns the service's response RequestID for request.

                                                                                              func (*ServiceUnavailable) StatusCode

                                                                                              func (s *ServiceUnavailable) StatusCode() int

                                                                                                Status code returns the HTTP status code for the request's response error.

                                                                                                func (ServiceUnavailable) String

                                                                                                func (s ServiceUnavailable) String() string

                                                                                                  String returns the string representation

                                                                                                  type ValidationError

                                                                                                  type ValidationError struct {
                                                                                                  	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                                                                  
                                                                                                  	Message_ *string `locationName:"Message" type:"string"`
                                                                                                  	// contains filtered or unexported fields
                                                                                                  }

                                                                                                    Inspect your request and try again.

                                                                                                    func (*ValidationError) Code

                                                                                                    func (s *ValidationError) Code() string

                                                                                                      Code returns the exception type name.

                                                                                                      func (*ValidationError) Error

                                                                                                      func (s *ValidationError) Error() string

                                                                                                      func (ValidationError) GoString

                                                                                                      func (s ValidationError) GoString() string

                                                                                                        GoString returns the string representation

                                                                                                        func (*ValidationError) Message

                                                                                                        func (s *ValidationError) Message() string

                                                                                                          Message returns the exception's message.

                                                                                                          func (*ValidationError) OrigErr

                                                                                                          func (s *ValidationError) OrigErr() error

                                                                                                            OrigErr always returns nil, satisfies awserr.Error interface.

                                                                                                            func (*ValidationError) RequestID

                                                                                                            func (s *ValidationError) RequestID() string

                                                                                                              RequestID returns the service's response RequestID for request.

                                                                                                              func (*ValidationError) StatusCode

                                                                                                              func (s *ValidationError) StatusCode() int

                                                                                                                Status code returns the HTTP status code for the request's response error.

                                                                                                                func (ValidationError) String

                                                                                                                func (s ValidationError) String() string

                                                                                                                  String returns the string representation

                                                                                                                  Directories

                                                                                                                  Path Synopsis
                                                                                                                  Package sagemakerruntimeiface provides an interface to enable mocking the Amazon SageMaker Runtime service client for testing your code.
                                                                                                                  Package sagemakerruntimeiface provides an interface to enable mocking the Amazon SageMaker Runtime service client for testing your code.