Documentation
¶
Overview ¶
Package sagemakerruntimehttp2 provides the API client, operations, and parameter types for Amazon SageMaker Runtime HTTP2.
The Amazon SageMaker AI runtime HTTP/2 API.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type HTTPClient
- type HTTPSignerV4
- type InvokeEndpointWithBidirectionalStreamEventStream
- func (es *InvokeEndpointWithBidirectionalStreamEventStream) Close() error
- func (es *InvokeEndpointWithBidirectionalStreamEventStream) Err() error
- func (es *InvokeEndpointWithBidirectionalStreamEventStream) Events() <-chan types.ResponseStreamEvent
- func (es *InvokeEndpointWithBidirectionalStreamEventStream) Send(ctx context.Context, event types.RequestStreamEvent) error
- type InvokeEndpointWithBidirectionalStreamInitialReply
- type InvokeEndpointWithBidirectionalStreamInput
- type InvokeEndpointWithBidirectionalStreamOutput
- type Options
- type PartialResult
- type RequestStreamEventWriter
- type ResolveEndpoint
- type ResponseStreamEventReader
- type UnknownEventMessageError
Constants ¶
const ServiceAPIVersion = "2025-10-01"
const ServiceID = "SageMaker Runtime HTTP2"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AuthResolverParameters ¶
type AuthResolverParameters struct {
// The name of the operation being invoked.
Operation string
// The region in which the operation is being invoked.
Region string
}
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon SageMaker Runtime HTTP2.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) InvokeEndpointWithBidirectionalStream ¶ added in v1.0.12
func (c *Client) InvokeEndpointWithBidirectionalStream(ctx context.Context, params *InvokeEndpointWithBidirectionalStreamInput, optFns ...func(*Options)) (*InvokeEndpointWithBidirectionalStreamOutput, error)
Invokes a model endpoint with bidirectional streaming capabilities. This operation establishes a persistent connection that allows you to send multiple requests and receive streaming responses from the model in real-time.
Bidirectional streaming is useful for interactive applications such as chatbots, real-time translation, or any scenario where you need to maintain a conversation-like interaction with the model. The connection remains open, allowing you to send additional input and receive responses without establishing a new connection for each request.
For an overview of Amazon SageMaker AI, see How It Works.
Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.
Calls to InvokeEndpointWithBidirectionalStream are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4)in the Amazon S3 API Reference.
The bidirectional stream maintains the connection until either the client closes it or the model indicates completion. Each request and response in the stream is sent as an event with optional headers for data type and completion state.
Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker AI determines the account ID from the authentication token that is supplied by the caller.
type EndpointParameters ¶
type EndpointParameters struct {
// When true, use the dual-stack endpoint. If the configured endpoint does not
// support dual-stack, dispatching the request MAY return an error.
//
// Defaults to
// false if no value is provided.
//
// AWS::UseDualStack
UseDualStack *bool
// When true, send this request to the FIPS-compliant regional endpoint. If the
// configured endpoint does not have a FIPS compliant endpoint, dispatching the
// request will return an error.
//
// Defaults to false if no value is
// provided.
//
// AWS::UseFIPS
UseFIPS *bool
// Override the endpoint used to send this request
//
// Parameter is
// required.
//
// SDK::Endpoint
Endpoint *string
// The AWS region used to dispatch the request.
//
// Parameter is
// required.
//
// AWS::Region
Region *string
}
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface {
ResolveEndpoint(ctx context.Context, params EndpointParameters) (
smithyendpoints.Endpoint, error,
)
}
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type HTTPSignerV4 ¶
type InvokeEndpointWithBidirectionalStreamEventStream ¶ added in v1.0.12
type InvokeEndpointWithBidirectionalStreamEventStream struct {
// RequestStreamEventWriter is the EventStream writer for the RequestStreamEvent
// 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
// Writer.
//
// Must not be nil.
Writer RequestStreamEventWriter
// ResponseStreamEventReader is the EventStream reader for the ResponseStreamEvent
// 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 ResponseStreamEventReader
// contains filtered or unexported fields
}
InvokeEndpointWithBidirectionalStreamEventStream provides the event stream handling for the InvokeEndpointWithBidirectionalStream operation.
For testing and mocking the event stream this type should be initialized via the NewInvokeEndpointWithBidirectionalStreamEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewInvokeEndpointWithBidirectionalStreamEventStream ¶ added in v1.0.12
func NewInvokeEndpointWithBidirectionalStreamEventStream(optFns ...func(*InvokeEndpointWithBidirectionalStreamEventStream)) *InvokeEndpointWithBidirectionalStreamEventStream
NewInvokeEndpointWithBidirectionalStreamEventStream initializes an InvokeEndpointWithBidirectionalStreamEventStream. This function should only be used for testing and mocking the InvokeEndpointWithBidirectionalStreamEventStream stream within your application.
The Writer member must be set before writing events to the stream.
The Reader member must be set before reading events from the stream.
func (*InvokeEndpointWithBidirectionalStreamEventStream) Close ¶ added in v1.0.12
func (es *InvokeEndpointWithBidirectionalStreamEventStream) Close() 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.
Will close the underlying EventStream writer and reader, and no more events can be sent or received.
func (*InvokeEndpointWithBidirectionalStreamEventStream) Err ¶ added in v1.0.12
func (es *InvokeEndpointWithBidirectionalStreamEventStream) 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 (*InvokeEndpointWithBidirectionalStreamEventStream) Events ¶ added in v1.0.12
func (es *InvokeEndpointWithBidirectionalStreamEventStream) Events() <-chan types.ResponseStreamEvent
Events returns a channel to read events from.
func (*InvokeEndpointWithBidirectionalStreamEventStream) Send ¶ added in v1.0.12
func (es *InvokeEndpointWithBidirectionalStreamEventStream) Send(ctx context.Context, event types.RequestStreamEvent) error
Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.
type InvokeEndpointWithBidirectionalStreamInitialReply ¶ added in v1.0.12
type InvokeEndpointWithBidirectionalStreamInitialReply struct {
// The invoked production variant.
InvokedProductionVariant *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type InvokeEndpointWithBidirectionalStreamInput ¶ added in v1.0.12
type InvokeEndpointWithBidirectionalStreamInput struct {
// The name of the endpoint to invoke.
//
// This member is required.
EndpointName *string
// Model invocation path.
ModelInvocationPath *string
// Model query string.
ModelQueryString *string
// Target variant for the request.
TargetVariant *string
// contains filtered or unexported fields
}
type InvokeEndpointWithBidirectionalStreamOutput ¶ added in v1.0.12
type InvokeEndpointWithBidirectionalStreamOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*InvokeEndpointWithBidirectionalStreamOutput) GetInitialReply ¶ added in v1.0.12
func (o *InvokeEndpointWithBidirectionalStreamOutput) GetInitialReply() <-chan InvokeEndpointWithBidirectionalStreamInitialReply
func (*InvokeEndpointWithBidirectionalStreamOutput) GetStream ¶ added in v1.0.12
func (o *InvokeEndpointWithBidirectionalStreamOutput) GetStream() *InvokeEndpointWithBidirectionalStreamEventStream
GetStream returns the type to interact with the event stream.
type Options ¶
type Options struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// The optional application specific identifier appended to the User-Agent header.
AppID string
// This endpoint will be given as input to an EndpointResolverV2. It is used for
// providing a custom base endpoint that is subject to modifications by the
// processing EndpointResolverV2.
BaseEndpoint *string
// Configures the events that will be sent to the configured logger.
ClientLogMode aws.ClientLogMode
// The credentials object to use when signing requests.
Credentials aws.CredentialsProvider
// The configuration DefaultsMode that the SDK should use when constructing the
// clients initial default settings.
DefaultsMode aws.DefaultsMode
// Disables SDK clock skew correction. When set, the SDK will not adjust request
// signing timestamps to compensate for clock drift between the client and the
// service.
DisableClockSkewCorrection bool
// The endpoint options to be used when attempting to resolve an endpoint.
EndpointOptions EndpointResolverOptions
// The service endpoint resolver.
//
// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
// value for this field will likely prevent you from using any endpoint-related
// service features released after the introduction of EndpointResolverV2 and
// BaseEndpoint.
//
// To migrate an EndpointResolver implementation that uses a custom endpoint, set
// the client option BaseEndpoint instead.
EndpointResolver EndpointResolver
// Resolves the endpoint used for a particular service operation.
EndpointResolverV2 EndpointResolverV2
// Signature Version 4 (SigV4) Signer
HTTPSignerV4 HTTPSignerV4
// The logger writer interface to write logging messages to.
Logger logging.Logger
// The client meter provider.
MeterProvider metrics.MeterProvider
// The region to send requests to. (Required)
Region string
// RetryMaxAttempts specifies the maximum number attempts an API client will call
// an operation that fails with a retryable error. A value of 0 is ignored, and
// will not be used to configure the API client created default retryer, or modify
// per operation call's retry max attempts.
//
// If specified in an operation call's functional options with a value that is
// different than the constructed client's Options, the Client's Retryer will be
// wrapped to use the operation's specific RetryMaxAttempts value.
RetryMaxAttempts int
// RetryMode specifies the retry mode the API client will be created with, if
// Retryer option is not also specified.
//
// When creating a new API Clients this member will only be used if the Retryer
// Options member is nil. This value will be ignored if Retryer is not nil.
//
// Currently does not support per operation call overrides, may in the future.
RetryMode aws.RetryMode
// Retryer guides how HTTP requests should be retried in case of recoverable
// failures. When nil the API client will use a default retryer. The kind of
// default retry created by the API client can be changed with the RetryMode
// option.
Retryer aws.Retryer
// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
// should not populate this structure programmatically, or rely on the values here
// within your applications.
RuntimeEnvironment aws.RuntimeEnvironment
// The client tracer provider.
TracerProvider tracing.TracerProvider
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
// Client registry of operation interceptors.
Interceptors smithyhttp.InterceptorRegistry
// The auth scheme resolver which determines how to authenticate for each
// operation.
AuthSchemeResolver AuthSchemeResolver
// The list of auth schemes supported by the client.
AuthSchemes []smithyhttp.AuthScheme
// Priority list of preferred auth scheme names (e.g. sigv4a).
AuthSchemePreference []string
// contains filtered or unexported fields
}
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PartialResult ¶ added in v1.0.12
type PartialResult struct {
Output any
Metadata middleware.Metadata
Error error
}
PartialResult represents a placeholder value to return immediately when calling an event streaming operation. This contains no meaningful result for the caller
type RequestStreamEventWriter ¶ added in v1.0.12
type RequestStreamEventWriter interface {
Send(context.Context, types.RequestStreamEvent) error
Close() error
Err() error
}
RequestStreamEventWriter provides the interface for writing events to a stream.
The writer's Close method must allow multiple concurrent calls.
type ResolveEndpoint ¶
type ResolveEndpoint struct {
Resolver EndpointResolver
Options EndpointResolverOptions
}
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResponseStreamEventReader ¶ added in v1.0.12
type ResponseStreamEventReader interface {
Events() <-chan types.ResponseStreamEvent
Close() error
Err() error
}
ResponseStreamEventReader provides the interface for reading events from a stream.
The writer's Close method must allow multiple concurrent calls.
type UnknownEventMessageError ¶ added in v1.0.12
type UnknownEventMessageError struct {
Type string
Message *eventstream.Message
}
UnknownEventMessageError provides an error when a message is received from the stream, but the reader is unable to determine what kind of message it is.
func (*UnknownEventMessageError) Error ¶ added in v1.0.12
func (e *UnknownEventMessageError) Error() string
Error retruns the error message string.