sagemakerruntime

package
v1.55.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 17 Imported by: 29

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 (

	// ErrCodeInternalDependencyException for service response error code
	// "InternalDependencyException".
	//
	// Your request caused an exception with an internal dependency. Contact customer
	// support.
	ErrCodeInternalDependencyException = "InternalDependencyException"

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

	// ErrCodeInternalStreamFailure for service response error code
	// "InternalStreamFailure".
	//
	// The stream processing failed because of an unknown error, exception or failure.
	// Try your request again.
	ErrCodeInternalStreamFailure = "InternalStreamFailure"

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

	// ErrCodeModelNotReadyException for service response error code
	// "ModelNotReadyException".
	//
	// Either a serverless endpoint variant's resources are still being provisioned,
	// or a multi-model endpoint is still downloading or loading the target model.
	// Wait and try your request again.
	ErrCodeModelNotReadyException = "ModelNotReadyException"

	// ErrCodeModelStreamError for service response error code
	// "ModelStreamError".
	//
	// An error occurred while streaming the response body. This error can have
	// the following error codes:
	//
	// ModelInvocationTimeExceeded
	//
	// The model failed to finish sending the response within the timeout period
	// allowed by Amazon SageMaker.
	//
	// StreamBroken
	//
	// The Transmission Control Protocol (TCP) connection between the client and
	// the model was reset or closed.
	ErrCodeModelStreamError = "ModelStreamError"

	// 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 InternalDependencyException added in v1.42.17 

type InternalDependencyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Your request caused an exception with an internal dependency. Contact customer support.

func (*InternalDependencyException) Code added in v1.42.17 

func (s *InternalDependencyException) Code() string

Code returns the exception type name.

func (*InternalDependencyException) Error added in v1.42.17 

func (s *InternalDependencyException) Error() string

func (InternalDependencyException) GoString added in v1.42.17 

func (s InternalDependencyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalDependencyException) Message added in v1.42.17 

func (s *InternalDependencyException) Message() string

Message returns the exception's message.

func (*InternalDependencyException) OrigErr added in v1.42.17 

func (s *InternalDependencyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalDependencyException) RequestID added in v1.42.17 

func (s *InternalDependencyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalDependencyException) StatusCode added in v1.42.17 

func (s *InternalDependencyException) StatusCode() int

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

func (InternalDependencyException) String added in v1.42.17 

func (s InternalDependencyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailure added in v1.28.0 

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 added in v1.28.0 

func (s *InternalFailure) Code() string

Code returns the exception type name.

func (*InternalFailure) Error added in v1.28.0 

func (s *InternalFailure) Error() string

func (InternalFailure) GoString added in v1.28.0 

func (s InternalFailure) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailure) Message added in v1.28.0 

func (s *InternalFailure) Message() string

Message returns the exception's message.

func (*InternalFailure) OrigErr added in v1.28.0 

func (s *InternalFailure) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailure) RequestID added in v1.28.0 

func (s *InternalFailure) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailure) StatusCode added in v1.28.0 

func (s *InternalFailure) StatusCode() int

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

func (InternalFailure) String added in v1.28.0 

func (s InternalFailure) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalStreamFailure added in v1.45.1 

type InternalStreamFailure struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The stream processing failed because of an unknown error, exception or failure. Try your request again.

func (*InternalStreamFailure) Code added in v1.45.1 

func (s *InternalStreamFailure) Code() string

Code returns the exception type name.

func (*InternalStreamFailure) Error added in v1.45.1 

func (s *InternalStreamFailure) Error() string

func (InternalStreamFailure) GoString added in v1.45.1 

func (s InternalStreamFailure) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalStreamFailure) MarshalEvent added in v1.45.1 

func (s *InternalStreamFailure) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*InternalStreamFailure) Message added in v1.45.1 

func (s *InternalStreamFailure) Message() string

Message returns the exception's message.

func (*InternalStreamFailure) OrigErr added in v1.45.1 

func (s *InternalStreamFailure) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalStreamFailure) RequestID added in v1.45.1 

func (s *InternalStreamFailure) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalStreamFailure) StatusCode added in v1.45.1 

func (s *InternalStreamFailure) StatusCode() int

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

func (InternalStreamFailure) String added in v1.45.1 

func (s InternalStreamFailure) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalStreamFailure) UnmarshalEvent added in v1.45.1 

func (s *InternalStreamFailure) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the InternalStreamFailure value. This method is only used internally within the SDK's EventStream handling.

type InvokeEndpointAsyncInput added in v1.40.25 

type InvokeEndpointAsyncInput struct {

	// The desired MIME type of the inference response from the model container.
	Accept *string `location:"header" locationName:"X-Amzn-SageMaker-Accept" type:"string"`

	// The MIME type of the input data in the request body.
	ContentType *string `location:"header" locationName:"X-Amzn-SageMaker-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://datatracker.ietf.org/doc/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 Amazon Web Services SDKs but not
	// in the Amazon SageMaker Python SDK.
	//
	// CustomAttributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointAsyncInput's
	// String and GoString methods.
	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"`

	// The identifier for the inference request. Amazon SageMaker will generate
	// an identifier for you if none is specified.
	InferenceId *string `location:"header" locationName:"X-Amzn-SageMaker-Inference-Id" min:"1" type:"string"`

	// The Amazon S3 URI where the inference request payload is stored.
	//
	// InputLocation is a required field
	InputLocation *string `location:"header" locationName:"X-Amzn-SageMaker-InputLocation" min:"1" type:"string" required:"true"`

	// Maximum amount of time in seconds a request can be processed before it is
	// marked as expired. The default is 15 minutes, or 900 seconds.
	InvocationTimeoutSeconds *int64 `location:"header" locationName:"X-Amzn-SageMaker-InvocationTimeoutSeconds" min:"1" type:"integer"`

	// Maximum age in seconds a request can be in the queue before it is marked
	// as expired. The default is 6 hours, or 21,600 seconds.
	RequestTTLSeconds *int64 `location:"header" locationName:"X-Amzn-SageMaker-RequestTTLSeconds" min:"60" type:"integer"`
	// contains filtered or unexported fields
}

func (InvokeEndpointAsyncInput) GoString added in v1.40.25 

func (s InvokeEndpointAsyncInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeEndpointAsyncInput) SetAccept added in v1.40.25 

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

SetAccept sets the Accept field's value.

func (*InvokeEndpointAsyncInput) SetContentType added in v1.40.25 

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

SetContentType sets the ContentType field's value.

func (*InvokeEndpointAsyncInput) SetCustomAttributes added in v1.40.25 

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

SetCustomAttributes sets the CustomAttributes field's value.

func (*InvokeEndpointAsyncInput) SetEndpointName added in v1.40.25 

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

SetEndpointName sets the EndpointName field's value.

func (*InvokeEndpointAsyncInput) SetInferenceId added in v1.40.25 

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

SetInferenceId sets the InferenceId field's value.

func (*InvokeEndpointAsyncInput) SetInputLocation added in v1.40.25 

func (s *InvokeEndpointAsyncInput) SetInputLocation(v string) *InvokeEndpointAsyncInput

SetInputLocation sets the InputLocation field's value.

func (*InvokeEndpointAsyncInput) SetInvocationTimeoutSeconds added in v1.44.189 

func (s *InvokeEndpointAsyncInput) SetInvocationTimeoutSeconds(v int64) *InvokeEndpointAsyncInput

SetInvocationTimeoutSeconds sets the InvocationTimeoutSeconds field's value.

func (*InvokeEndpointAsyncInput) SetRequestTTLSeconds added in v1.40.25 

func (s *InvokeEndpointAsyncInput) SetRequestTTLSeconds(v int64) *InvokeEndpointAsyncInput

SetRequestTTLSeconds sets the RequestTTLSeconds field's value.

func (InvokeEndpointAsyncInput) String added in v1.40.25 

func (s InvokeEndpointAsyncInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeEndpointAsyncInput) Validate added in v1.40.25 

func (s *InvokeEndpointAsyncInput) Validate() error

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

type InvokeEndpointAsyncOutput added in v1.40.25 

type InvokeEndpointAsyncOutput struct {

	// The Amazon S3 URI where the inference failure response payload is stored.
	FailureLocation *string `location:"header" locationName:"X-Amzn-SageMaker-FailureLocation" type:"string"`

	// Identifier for an inference request. This will be the same as the InferenceId
	// specified in the input. Amazon SageMaker will generate an identifier for
	// you if you do not specify one.
	InferenceId *string `type:"string"`

	// The Amazon S3 URI where the inference response payload is stored.
	OutputLocation *string `location:"header" locationName:"X-Amzn-SageMaker-OutputLocation" type:"string"`
	// contains filtered or unexported fields
}

func (InvokeEndpointAsyncOutput) GoString added in v1.40.25 

func (s InvokeEndpointAsyncOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeEndpointAsyncOutput) SetFailureLocation added in v1.44.236 

func (s *InvokeEndpointAsyncOutput) SetFailureLocation(v string) *InvokeEndpointAsyncOutput

SetFailureLocation sets the FailureLocation field's value.

func (*InvokeEndpointAsyncOutput) SetInferenceId added in v1.40.25 

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

SetInferenceId sets the InferenceId field's value.

func (*InvokeEndpointAsyncOutput) SetOutputLocation added in v1.40.25 

func (s *InvokeEndpointAsyncOutput) SetOutputLocation(v string) *InvokeEndpointAsyncOutput

SetOutputLocation sets the OutputLocation field's value.

func (InvokeEndpointAsyncOutput) String added in v1.40.25 

func (s InvokeEndpointAsyncOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvokeEndpointInput 

type InvokeEndpointInput struct {

	// The desired MIME type of the inference response from the model container.
	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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointInput's
	// String and GoString methods.
	//
	// 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://datatracker.ietf.org/doc/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 Amazon Web Services SDKs but not
	// in the Amazon SageMaker Python SDK.
	//
	// CustomAttributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointInput's
	// String and GoString methods.
	CustomAttributes *string `location:"header" locationName:"X-Amzn-SageMaker-Custom-Attributes" type:"string" sensitive:"true"`

	// An optional JMESPath expression used to override the EnableExplanations parameter
	// of the ClarifyExplainerConfig API. See the EnableExplanations (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable)
	// section in the developer guide for more information.
	EnableExplanations *string `location:"header" locationName:"X-Amzn-SageMaker-Enable-Explanations" min:"1" type:"string"`

	// 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 the endpoint hosts one or more inference components, this parameter specifies
	// the name of inference component to invoke.
	InferenceComponentName *string `location:"header" locationName:"X-Amzn-SageMaker-Inference-Component" type:"string"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCustomAttributes added in v1.15.24 

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

SetCustomAttributes sets the CustomAttributes field's value.

func (*InvokeEndpointInput) SetEnableExplanations added in v1.44.109 

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

SetEnableExplanations sets the EnableExplanations field's value.

func (*InvokeEndpointInput) SetEndpointName 

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

SetEndpointName sets the EndpointName field's value.

func (*InvokeEndpointInput) SetInferenceComponentName added in v1.48.8 

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

SetInferenceComponentName sets the InferenceComponentName field's value.

func (*InvokeEndpointInput) SetInferenceId added in v1.36.4 

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

SetInferenceId sets the InferenceId field's value.

func (*InvokeEndpointInput) SetTargetContainerHostname added in v1.37.16 

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

SetTargetContainerHostname sets the TargetContainerHostname field's value.

func (*InvokeEndpointInput) SetTargetModel added in v1.25.37 

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

SetTargetModel sets the TargetModel field's value.

func (*InvokeEndpointInput) SetTargetVariant added in v1.31.12 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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).
	//
	// If the explainer is activated, the body includes the explanations provided
	// by the model. For more information, see the Response section under Invoke
	// the Endpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response)
	// in the Developer Guide.
	//
	// Body is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointOutput's
	// String and GoString methods.
	//
	// Body is a required field
	Body []byte `type:"blob" required:"true" sensitive:"true"`

	// The MIME type of the inference returned from the model container.
	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 Amazon Web Services SDKs but not
	// in the Amazon SageMaker Python SDK.
	//
	// CustomAttributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointOutput's
	// String and GoString methods.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCustomAttributes added in v1.15.24 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvokeEndpointWithResponseStreamEventStream added in v1.45.1 

type InvokeEndpointWithResponseStreamEventStream struct {

	// Reader is the EventStream reader for the ResponseStream
	// events. This value is automatically set by the SDK when the API call is made
	// Use this member when unit testing your code with the SDK to mock out the
	// EventStream Reader.
	//
	// Must not be nil.
	Reader ResponseStreamReader
	// contains filtered or unexported fields
}

InvokeEndpointWithResponseStreamEventStream provides the event stream handling for the InvokeEndpointWithResponseStream.

For testing and mocking the event stream this type should be initialized via the NewInvokeEndpointWithResponseStreamEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewInvokeEndpointWithResponseStreamEventStream added in v1.45.1 

func NewInvokeEndpointWithResponseStreamEventStream(opts ...func(*InvokeEndpointWithResponseStreamEventStream)) *InvokeEndpointWithResponseStreamEventStream

NewInvokeEndpointWithResponseStreamEventStream initializes an InvokeEndpointWithResponseStreamEventStream. This function should only be used for testing and mocking the InvokeEndpointWithResponseStreamEventStream stream within your application.

The Reader member must be set before reading events from the stream. 

es := NewInvokeEndpointWithResponseStreamEventStream(func(o *InvokeEndpointWithResponseStreamEventStream){
    es.Reader = myMockStreamReader
})

func (*InvokeEndpointWithResponseStreamEventStream) Close added in v1.45.1 

func (es *InvokeEndpointWithResponseStreamEventStream) Close() (err error)

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*InvokeEndpointWithResponseStreamEventStream) Err added in v1.45.1 

func (es *InvokeEndpointWithResponseStreamEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*InvokeEndpointWithResponseStreamEventStream) Events added in v1.45.1 

func (es *InvokeEndpointWithResponseStreamEventStream) Events() <-chan ResponseStreamEvent

Events returns a channel to read events from.

These events are:

  • PayloadPart
  • ResponseStreamUnknownEvent

type InvokeEndpointWithResponseStreamInput added in v1.45.1 

type InvokeEndpointWithResponseStreamInput struct {

	// The desired MIME type of the inference response from the model container.
	Accept *string `location:"header" locationName:"X-Amzn-SageMaker-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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointWithResponseStreamInput's
	// String and GoString methods.
	//
	// 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://datatracker.ietf.org/doc/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 Amazon Web Services SDKs but not
	// in the Amazon SageMaker Python SDK.
	//
	// CustomAttributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointWithResponseStreamInput's
	// String and GoString methods.
	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 the endpoint hosts one or more inference components, this parameter specifies
	// the name of inference component to invoke for a streaming response.
	InferenceComponentName *string `location:"header" locationName:"X-Amzn-SageMaker-Inference-Component" type:"string"`

	// An identifier that you assign to your request.
	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"`

	// 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 (InvokeEndpointWithResponseStreamInput) GoString added in v1.45.1 

func (s InvokeEndpointWithResponseStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeEndpointWithResponseStreamInput) SetAccept added in v1.45.1 

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

SetAccept sets the Accept field's value.

func (*InvokeEndpointWithResponseStreamInput) SetBody added in v1.45.1 

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

SetBody sets the Body field's value.

func (*InvokeEndpointWithResponseStreamInput) SetContentType added in v1.45.1 

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

SetContentType sets the ContentType field's value.

func (*InvokeEndpointWithResponseStreamInput) SetCustomAttributes added in v1.45.1 

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

SetCustomAttributes sets the CustomAttributes field's value.

func (*InvokeEndpointWithResponseStreamInput) SetEndpointName added in v1.45.1 

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

SetEndpointName sets the EndpointName field's value.

func (*InvokeEndpointWithResponseStreamInput) SetInferenceComponentName added in v1.48.8 

func (s *InvokeEndpointWithResponseStreamInput) SetInferenceComponentName(v string) *InvokeEndpointWithResponseStreamInput

SetInferenceComponentName sets the InferenceComponentName field's value.

func (*InvokeEndpointWithResponseStreamInput) SetInferenceId added in v1.45.1 

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

SetInferenceId sets the InferenceId field's value.

func (*InvokeEndpointWithResponseStreamInput) SetTargetContainerHostname added in v1.45.1 

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

SetTargetContainerHostname sets the TargetContainerHostname field's value.

func (*InvokeEndpointWithResponseStreamInput) SetTargetVariant added in v1.45.1 

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

SetTargetVariant sets the TargetVariant field's value.

func (InvokeEndpointWithResponseStreamInput) String added in v1.45.1 

func (s InvokeEndpointWithResponseStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeEndpointWithResponseStreamInput) Validate added in v1.45.1 

func (s *InvokeEndpointWithResponseStreamInput) Validate() error

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

type InvokeEndpointWithResponseStreamOutput added in v1.45.1 

type InvokeEndpointWithResponseStreamOutput struct {

	// The MIME type of the inference returned from the model container.
	ContentType *string `location:"header" locationName:"X-Amzn-SageMaker-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 Amazon Web Services SDKs but not
	// in the Amazon SageMaker Python SDK.
	//
	// CustomAttributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by InvokeEndpointWithResponseStreamOutput's
	// String and GoString methods.
	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 (*InvokeEndpointWithResponseStreamOutput) GetStream added in v1.45.1 

func (s *InvokeEndpointWithResponseStreamOutput) GetStream() *InvokeEndpointWithResponseStreamEventStream

GetStream returns the type to interact with the event stream.

func (InvokeEndpointWithResponseStreamOutput) GoString added in v1.45.1 

func (s InvokeEndpointWithResponseStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvokeEndpointWithResponseStreamOutput) SetContentType added in v1.45.1 

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

SetContentType sets the ContentType field's value.

func (*InvokeEndpointWithResponseStreamOutput) SetCustomAttributes added in v1.45.1 

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

SetCustomAttributes sets the CustomAttributes field's value.

func (*InvokeEndpointWithResponseStreamOutput) SetInvokedProductionVariant added in v1.45.1 

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

SetInvokedProductionVariant sets the InvokedProductionVariant field's value.

func (InvokeEndpointWithResponseStreamOutput) String added in v1.45.1 

func (s InvokeEndpointWithResponseStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModelError added in v1.28.0 

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 added in v1.28.0 

func (s *ModelError) Code() string

Code returns the exception type name.

func (*ModelError) Error added in v1.28.0 

func (s *ModelError) Error() string

func (ModelError) GoString added in v1.28.0 

func (s ModelError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModelError) Message added in v1.28.0 

func (s *ModelError) Message() string

Message returns the exception's message.

func (*ModelError) OrigErr added in v1.28.0 

func (s *ModelError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ModelError) RequestID added in v1.28.0 

func (s *ModelError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ModelError) StatusCode added in v1.28.0 

func (s *ModelError) StatusCode() int

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

func (ModelError) String added in v1.28.0 

func (s ModelError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModelNotReadyException added in v1.42.17 

type ModelNotReadyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again.

func (*ModelNotReadyException) Code added in v1.42.17 

func (s *ModelNotReadyException) Code() string

Code returns the exception type name.

func (*ModelNotReadyException) Error added in v1.42.17 

func (s *ModelNotReadyException) Error() string

func (ModelNotReadyException) GoString added in v1.42.17 

func (s ModelNotReadyException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModelNotReadyException) Message added in v1.42.17 

func (s *ModelNotReadyException) Message() string

Message returns the exception's message.

func (*ModelNotReadyException) OrigErr added in v1.42.17 

func (s *ModelNotReadyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ModelNotReadyException) RequestID added in v1.42.17 

func (s *ModelNotReadyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ModelNotReadyException) StatusCode added in v1.42.17 

func (s *ModelNotReadyException) StatusCode() int

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

func (ModelNotReadyException) String added in v1.42.17 

func (s ModelNotReadyException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModelStreamError added in v1.45.1 

type ModelStreamError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// This error can have the following error codes:
	//
	// ModelInvocationTimeExceeded
	//
	// The model failed to finish sending the response within the timeout period
	// allowed by Amazon SageMaker.
	//
	// StreamBroken
	//
	// The Transmission Control Protocol (TCP) connection between the client and
	// the model was reset or closed.
	ErrorCode *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred while streaming the response body. This error can have the following error codes:

ModelInvocationTimeExceeded

The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker.

StreamBroken

The Transmission Control Protocol (TCP) connection between the client and the model was reset or closed.

func (*ModelStreamError) Code added in v1.45.1 

func (s *ModelStreamError) Code() string

Code returns the exception type name.

func (*ModelStreamError) Error added in v1.45.1 

func (s *ModelStreamError) Error() string

func (ModelStreamError) GoString added in v1.45.1 

func (s ModelStreamError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModelStreamError) MarshalEvent added in v1.45.1 

func (s *ModelStreamError) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ModelStreamError) Message added in v1.45.1 

func (s *ModelStreamError) Message() string

Message returns the exception's message.

func (*ModelStreamError) OrigErr added in v1.45.1 

func (s *ModelStreamError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ModelStreamError) RequestID added in v1.45.1 

func (s *ModelStreamError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ModelStreamError) StatusCode added in v1.45.1 

func (s *ModelStreamError) StatusCode() int

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

func (ModelStreamError) String added in v1.45.1 

func (s ModelStreamError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModelStreamError) UnmarshalEvent added in v1.45.1 

func (s *ModelStreamError) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ModelStreamError value. This method is only used internally within the SDK's EventStream handling.

type PayloadPart added in v1.45.1 

type PayloadPart struct {

	// A blob that contains part of the response for your streaming inference request.
	//
	// Bytes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PayloadPart's
	// String and GoString methods.
	//
	// Bytes is automatically base64 encoded/decoded by the SDK.
	Bytes []byte `type:"blob" sensitive:"true"`
	// contains filtered or unexported fields
}

A wrapper for pieces of the payload that's returned in response to a streaming inference request. A streaming inference response consists of one or more payload parts.

func (PayloadPart) GoString added in v1.45.1 

func (s PayloadPart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PayloadPart) MarshalEvent added in v1.45.1 

func (s *PayloadPart) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*PayloadPart) SetBytes added in v1.45.1 

func (s *PayloadPart) SetBytes(v []byte) *PayloadPart

SetBytes sets the Bytes field's value.

func (PayloadPart) String added in v1.45.1 

func (s PayloadPart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PayloadPart) UnmarshalEvent added in v1.45.1 

func (s *PayloadPart) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the PayloadPart value. This method is only used internally within the SDK's EventStream handling.

type ResponseStreamEvent added in v1.45.1 

type ResponseStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

ResponseStreamEvent groups together all EventStream events writes for ResponseStream.

These events are:

  • PayloadPart

type ResponseStreamReader added in v1.45.1 

type ResponseStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan ResponseStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

ResponseStreamReader provides the interface for reading to the stream. The default implementation for this interface will be ResponseStream.

The reader's Close method must allow multiple concurrent calls.

These events are:

  • PayloadPart
  • ResponseStreamUnknownEvent

type ResponseStreamUnknownEvent added in v1.45.1 

type ResponseStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

ResponseStreamUnknownEvent provides a failsafe event for the ResponseStream group of events when an unknown event is received.

func (*ResponseStreamUnknownEvent) MarshalEvent added in v1.45.1 

func (e *ResponseStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
	msg eventstream.Message, err error,
)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ResponseStreamUnknownEvent) UnmarshalEvent added in v1.45.1 

func (e *ResponseStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ResponseStream value. This method is only used internally within the SDK's EventStream handling.

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: 

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 Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services 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.

  • InternalDependencyException Your request caused an exception with an internal dependency. Contact customer support.

  • ModelNotReadyException Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again.

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

func (*SageMakerRuntime) InvokeEndpointAsync added in v1.40.25 

func (c *SageMakerRuntime) InvokeEndpointAsync(input *InvokeEndpointAsyncInput) (*InvokeEndpointAsyncOutput, error)

InvokeEndpointAsync 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 in an asynchronous manner.

Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it.

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 InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) in the Amazon S3 API Reference.

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

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

func (*SageMakerRuntime) InvokeEndpointAsyncRequest added in v1.40.25 

func (c *SageMakerRuntime) InvokeEndpointAsyncRequest(input *InvokeEndpointAsyncInput) (req *request.Request, output *InvokeEndpointAsyncOutput)

InvokeEndpointAsyncRequest generates a "aws/request.Request" representing the client's request for the InvokeEndpointAsync 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 InvokeEndpointAsync for more information on using the InvokeEndpointAsync 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 InvokeEndpointAsyncRequest method.
req, resp := client.InvokeEndpointAsyncRequest(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/InvokeEndpointAsync

func (*SageMakerRuntime) InvokeEndpointAsyncWithContext added in v1.40.25 

func (c *SageMakerRuntime) InvokeEndpointAsyncWithContext(ctx aws.Context, input *InvokeEndpointAsyncInput, opts ...request.Option) (*InvokeEndpointAsyncOutput, error)

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

See InvokeEndpointAsync 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.

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.

func (*SageMakerRuntime) InvokeEndpointWithResponseStream added in v1.45.1 

func (c *SageMakerRuntime) InvokeEndpointWithResponseStream(input *InvokeEndpointWithResponseStreamInput) (*InvokeEndpointWithResponseStreamOutput, error)

InvokeEndpointWithResponseStream API operation for Amazon SageMaker Runtime.

Invokes a model at the specified endpoint to return the inference response as a stream. The inference stream provides the response payload incrementally as a series of parts. Before you can get an inference stream, you must have access to a model that's deployed using Amazon SageMaker hosting services, and the container for that model must support inference streaming.

For more information that can help you use this API, see the following sections in the Amazon SageMaker Developer Guide:

Before you can use this operation, your IAM permissions must allow the sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker actions for IAM policies, see Actions, resources, and condition keys for Amazon SageMaker (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonsagemaker.html) in the IAM Service Authorization Reference.

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 InvokeEndpointWithResponseStream are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) in the Amazon S3 API Reference.

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

  • ModelStreamError An error occurred while streaming the response body. This error can have the following error codes:

    ModelInvocationTimeExceeded

    The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker.

    StreamBroken

    The Transmission Control Protocol (TCP) connection between the client and the model was reset or closed.

  • InternalStreamFailure The stream processing failed because of an unknown error, exception or failure. Try your request again.

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

func (*SageMakerRuntime) InvokeEndpointWithResponseStreamRequest added in v1.45.1 

func (c *SageMakerRuntime) InvokeEndpointWithResponseStreamRequest(input *InvokeEndpointWithResponseStreamInput) (req *request.Request, output *InvokeEndpointWithResponseStreamOutput)

InvokeEndpointWithResponseStreamRequest generates a "aws/request.Request" representing the client's request for the InvokeEndpointWithResponseStream 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 InvokeEndpointWithResponseStream for more information on using the InvokeEndpointWithResponseStream 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 InvokeEndpointWithResponseStreamRequest method.
req, resp := client.InvokeEndpointWithResponseStreamRequest(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/InvokeEndpointWithResponseStream

func (*SageMakerRuntime) InvokeEndpointWithResponseStreamWithContext added in v1.45.1 

func (c *SageMakerRuntime) InvokeEndpointWithResponseStreamWithContext(ctx aws.Context, input *InvokeEndpointWithResponseStreamInput, opts ...request.Option) (*InvokeEndpointWithResponseStreamOutput, error)

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

See InvokeEndpointWithResponseStream 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 added in v1.28.0 

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 added in v1.28.0 

func (s *ServiceUnavailable) Code() string

Code returns the exception type name.

func (*ServiceUnavailable) Error added in v1.28.0 

func (s *ServiceUnavailable) Error() string

func (ServiceUnavailable) GoString added in v1.28.0 

func (s ServiceUnavailable) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailable) Message added in v1.28.0 

func (s *ServiceUnavailable) Message() string

Message returns the exception's message.

func (*ServiceUnavailable) OrigErr added in v1.28.0 

func (s *ServiceUnavailable) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailable) RequestID added in v1.28.0 

func (s *ServiceUnavailable) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailable) StatusCode added in v1.28.0 

func (s *ServiceUnavailable) StatusCode() int

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

func (ServiceUnavailable) String added in v1.28.0 

func (s ServiceUnavailable) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationError added in v1.28.0 

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 added in v1.28.0 

func (s *ValidationError) Code() string

Code returns the exception type name.

func (*ValidationError) Error added in v1.28.0 

func (s *ValidationError) Error() string

func (ValidationError) GoString added in v1.28.0 

func (s ValidationError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationError) Message added in v1.28.0 

func (s *ValidationError) Message() string

Message returns the exception's message.

func (*ValidationError) OrigErr added in v1.28.0 

func (s *ValidationError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationError) RequestID added in v1.28.0 

func (s *ValidationError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationError) StatusCode added in v1.28.0 

func (s *ValidationError) StatusCode() int

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

func (ValidationError) String added in v1.28.0 

func (s ValidationError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.