Class: Aws::SageMakerRuntime::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::SageMakerRuntime::Client

show all

Includes:: ClientStubs

Defined in:: lib/aws-sdk-sagemakerruntime/client.rb

Overview

An API client for SageMakerRuntime. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::SageMakerRuntime::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#invoke_endpoint(params = {}) ⇒ Types::InvokeEndpointOutput

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.
#invoke_endpoint_async(params = {}) ⇒ Types::InvokeEndpointAsyncOutput

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.
#invoke_endpoint_with_response_stream(params = {}) ⇒ Types::InvokeEndpointWithResponseStreamOutput

Invokes a model at the specified endpoint to return the inference response as a stream.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ Client constructor

A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:plugins (Array<Seahorse::Client::Plugin>) — default: []] —

A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.
- ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.
- ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.
- ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.
- ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.
- ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.
- ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.
- ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.
When ‘:credentials` are not configured directly, the following locations will be searched for credentials:
- ‘Aws.config`
- The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.
- ENV, ENV, ENV, and ENV
- ‘~/.aws/credentials`
- ‘~/.aws/config`
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.
:region (required, String) —
The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:
- ‘Aws.config`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:account_id (String)
:active_endpoint_cache (Boolean) — default: false —

When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.
:adaptive_retry_wait_to_fill (Boolean) — default: true —

Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.
:client_side_monitoring (Boolean) — default: false —

When ‘true`, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —

Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —

Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —

Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —

When ‘true`, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —

Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:defaults_mode (String) — default: "legacy" —

See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
:disable_host_prefix_injection (Boolean) — default: false —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:disable_request_compression (Boolean) — default: false —

When set to ‘true’ the request body will not be compressed for supported operations.
:endpoint (String, URI::HTTPS, URI::HTTP) —
Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:
```
'http://example.com'
'https://example.com'
'http://example.com:123'
```
:endpoint_cache_max_entries (Integer) — default: 1000 —

Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —

Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —

When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —

When set to ‘true`, endpoint discovery will be enabled for operations when available.
:event_stream_handler (Proc) —

When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
:ignore_configured_endpoint_urls (Boolean) —

Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
:input_event_stream_handler (Proc) —

When an EventStream or Proc object is provided, it can be used for sending events for the event stream.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

The log formatter.
:log_level (Symbol) — default: :info —

The log level to send messages to the ‘:logger` at.
:logger (Logger) —

The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 3 —

An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.
:output_event_stream_handler (Proc) —

When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
:profile (String) — default: "default" —

Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
:request_checksum_calculation (String) — default: "when_supported" —
Determines when a checksum will be calculated for request payloads. Values are:
- ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.
- ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.
:request_min_compression_size_bytes (Integer) — default: 10240 —

The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
:response_checksum_validation (String) — default: "when_supported" —
Determines when checksum validation will be performed on response payloads. Values are:
- ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.
- ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.
:retry_backoff (Proc) —

A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.
:retry_base_delay (Float) — default: 0.3 —

The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_jitter (Symbol) — default: :none —

A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

@see www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —

The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.
:retry_max_delay (Integer) — default: 0 —

The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_mode (String) — default: "legacy" —
Specifies which retry algorithm to use. Values are:
- ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.
- ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.
- ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
:sdk_ua_app_id (String) —

A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
:secret_access_key (String)
:session_token (String)
:sigv4a_signing_region_set (Array) —
A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:
- ‘Aws.config`
- ‘ENV`
- ‘~/.aws/config`
:stub_responses (Boolean) — default: false —

Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.
:token_provider (Aws::TokenProvider) —
A Bearer Token Provider. This can be an instance of any one of the following classes:
- ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.
- ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.
When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.
:use_dualstack_endpoint (Boolean) —

When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.
:use_fips_endpoint (Boolean) —

When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.
:validate_params (Boolean) — default: true —

When ‘true`, request parameters are validated before sending the request.
:endpoint_provider (Aws::SageMakerRuntime::EndpointProvider) —

The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SageMakerRuntime::EndpointParameters`.
:http_continue_timeout (Float) — default: 1 —

The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.
:http_idle_timeout (Float) — default: 5 —

The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_open_timeout (Float) — default: 15 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_proxy (URI::HTTP, String) —

A proxy to send requests through. Formatted like ‘proxy.com:123’.
:http_read_timeout (Float) — default: 60 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_wire_trace (Boolean) — default: false —

When ‘true`, HTTP debug output will be sent to the `:logger`.
:on_chunk_received (Proc) —

When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).
:on_chunk_sent (Proc) —

When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
:raise_response_errors (Boolean) — default: true —

When ‘true`, response errors are raised.
:ssl_ca_bundle (String) —

Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_directory (String) —

Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_store (String) —

Sets the X509::Store to verify peer certificate.
:ssl_cert (OpenSSL::X509::Certificate) —

Sets a client certificate when creating http connections.
:ssl_key (OpenSSL::PKey) —

Sets a client key when creating http connections.
:ssl_timeout (Float) —

Sets the SSL timeout in seconds
:ssl_verify_peer (Boolean) — default: true —

When ‘true`, SSL peer certificates are verified when establishing a connection.



478
479
480

# File 'lib/aws-sdk-sagemakerruntime/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



1112
1113
1114

# File 'lib/aws-sdk-sagemakerruntime/client.rb', line 1112

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



1115
1116
1117

# File 'lib/aws-sdk-sagemakerruntime/client.rb', line 1115

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-sagemakerruntime/client.rb', line 1085

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::SageMakerRuntime')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-sagemakerruntime'
  context[:gem_version] = '1.79.0'
  Seahorse::Client::Request.new(handlers, context)
end

#invoke_endpoint(params = {}) ⇒ `Types::InvokeEndpointOutput`

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

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)] 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.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html

Examples:

Request syntax with placeholder values


resp = client.invoke_endpoint({
  endpoint_name: "EndpointName", # required
  body: "data", # required
  content_type: "Header",
  accept: "Header",
  custom_attributes: "CustomAttributesHeader",
  target_model: "TargetModelHeader",
  target_variant: "TargetVariantHeader",
  target_container_hostname: "TargetContainerHostnameHeader",
  inference_id: "InferenceId",
  enable_explanations: "EnableExplanationsHeader",
  inference_component_name: "InferenceComponentHeader",
  session_id: "SessionIdOrNewSessionConstantHeader",
})

Response structure


resp.body #=> String
resp.content_type #=> String
resp.invoked_production_variant #=> String
resp.custom_attributes #=> String
resp.new_session_id #=> String
resp.closed_session_id #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:endpoint_name (required, String) —

The name of the endpoint that you specified when you created the endpoint using the [CreateEndpoint] API.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html
:body (required, String, StringIO, File) —

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html
:content_type (String) —

The MIME type of the input data in the request body.
:accept (String) —

The desired MIME type of the inference response from the model container.
:custom_attributes (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] 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.

[1]: datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
:target_model (String) —

The model to request for inference when invoking a multi-model endpoint.
:target_variant (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]

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html
:target_container_hostname (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.
:inference_id (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].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html
:enable_explanations (String) —

An optional JMESPath expression used to override the ‘EnableExplanations` parameter of the `ClarifyExplainerConfig` API. See the [EnableExplanations] section in the developer guide for more information.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable
:inference_component_name (String) —

If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
:session_id (String) —
Creates a stateful session or identifies an existing one. You can do one of the following:
- Create a stateful session by specifying the value ‘NEW_SESSION`.
- Send your request to an existing stateful session by specifying the ID of that session.
With a stateful session, you can send multiple requests to a stateful model. When you create a session with a stateful model, the model must create the session ID and set the expiration time. The model must also provide that information in the response to your request. You can get the ID and timestamp from the ‘NewSessionId` response parameter. For any subsequent request where you specify that session ID, SageMaker routes the request to the same instance that supports the session.

Returns:

(Types::InvokeEndpointOutput) —
Returns a response object which responds to the following methods:
- #body => String
- #content_type => String
- #invoked_production_variant => String
- #custom_attributes => String
- #new_session_id => String
- #closed_session_id => String

#invoke_endpoint_async(params = {}) ⇒ `Types::InvokeEndpointAsyncOutput`

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.

Calls to ‘InvokeEndpointAsync` 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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html

Examples:

Request syntax with placeholder values


resp = client.invoke_endpoint_async({
  endpoint_name: "EndpointName", # required
  content_type: "Header",
  accept: "Header",
  custom_attributes: "CustomAttributesHeader",
  inference_id: "InferenceId",
  input_location: "InputLocationHeader", # required
  request_ttl_seconds: 1,
  invocation_timeout_seconds: 1,
})

Response structure


resp.inference_id #=> String
resp.output_location #=> String
resp.failure_location #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:endpoint_name (required, String) —

The name of the endpoint that you specified when you created the endpoint using the [CreateEndpoint] API.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html
:content_type (String) —

The MIME type of the input data in the request body.
:accept (String) —

The desired MIME type of the inference response from the model container.
:custom_attributes (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] 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.

[1]: datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
:inference_id (String) —

The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.
:input_location (required, String) —

The Amazon S3 URI where the inference request payload is stored.
:request_ttl_seconds (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.
:invocation_timeout_seconds (Integer) —

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.

Returns:

(Types::InvokeEndpointAsyncOutput) —
Returns a response object which responds to the following methods:
- #inference_id => String
- #output_location => String
- #failure_location => String

#invoke_endpoint_with_response_stream(params = {}) ⇒ `Types::InvokeEndpointWithResponseStreamOutput`

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

For information about how to add streaming support to a model, see [How Containers Serve Requests].
For information about how to process the streaming response, see [Invoke real-time endpoints].

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] in the *IAM Service Authorization Reference*.

Calls to ‘InvokeEndpointWithResponseStream` are authenticated by using Amazon Web Services Signature Version 4. For information, see

Authenticating Requests (Amazon Web Services Signature Version 4)][4

in the *Amazon S3 API Reference*.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-code-how-containe-serves-requests [2]: docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-test-endpoints.html [3]: docs.aws.amazon.com/service-authorization/latest/reference/list_amazonsagemaker.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html

Examples:

EventStream Operation Example


You can process the event once it arrives immediately, or wait until the
full response is complete and iterate through the eventstream enumerator.

To interact with event immediately, you need to register #invoke_endpoint_with_response_stream
with callbacks. Callbacks can be registered for specific events or for all
events, including error events.

Callbacks can be passed into the `:event_stream_handler` option or within a
block statement attached to the #invoke_endpoint_with_response_stream call directly. Hybrid
pattern of both is also supported.

`:event_stream_handler` option takes in either a Proc object or
Aws::SageMakerRuntime::EventStreams::ResponseStream object.

Usage pattern a): Callbacks with a block attached to #invoke_endpoint_with_response_stream
  Example for registering callbacks for all event types and an error event

  client.invoke_endpoint_with_response_stream( # params input# ) do |stream|
    stream.on_error_event do |event|
      # catch unmodeled error event in the stream
      raise event
      # => Aws::Errors::EventError
      # event.event_type => :error
      # event.error_code => String
      # event.error_message => String
    end

    stream.on_event do |event|
      # process all events arrive
      puts event.event_type
      ...
    end

  end

Usage pattern b): Pass in `:event_stream_handler` for #invoke_endpoint_with_response_stream

  1) Create a Aws::SageMakerRuntime::EventStreams::ResponseStream object
  Example for registering callbacks with specific events

    handler = Aws::SageMakerRuntime::EventStreams::ResponseStream.new
    handler.on_payload_part_event do |event|
      event # => Aws::SageMakerRuntime::Types::PayloadPart
    end
    handler.on_model_stream_error_event do |event|
      event # => Aws::SageMakerRuntime::Types::ModelStreamError
    end
    handler.on_internal_stream_failure_event do |event|
      event # => Aws::SageMakerRuntime::Types::InternalStreamFailure
    end

  client.invoke_endpoint_with_response_stream( # params input #, event_stream_handler: handler)

  2) Use a Ruby Proc object
  Example for registering callbacks with specific events

  handler = Proc.new do |stream|
    stream.on_payload_part_event do |event|
      event # => Aws::SageMakerRuntime::Types::PayloadPart
    end
    stream.on_model_stream_error_event do |event|
      event # => Aws::SageMakerRuntime::Types::ModelStreamError
    end
    stream.on_internal_stream_failure_event do |event|
      event # => Aws::SageMakerRuntime::Types::InternalStreamFailure
    end
  end

  client.invoke_endpoint_with_response_stream( # params input #, event_stream_handler: handler)

Usage pattern c): Hybrid pattern of a) and b)

    handler = Aws::SageMakerRuntime::EventStreams::ResponseStream.new
    handler.on_payload_part_event do |event|
      event # => Aws::SageMakerRuntime::Types::PayloadPart
    end
    handler.on_model_stream_error_event do |event|
      event # => Aws::SageMakerRuntime::Types::ModelStreamError
    end
    handler.on_internal_stream_failure_event do |event|
      event # => Aws::SageMakerRuntime::Types::InternalStreamFailure
    end

  client.invoke_endpoint_with_response_stream( # params input #, event_stream_handler: handler) do |stream|
    stream.on_error_event do |event|
      # catch unmodeled error event in the stream
      raise event
      # => Aws::Errors::EventError
      # event.event_type => :error
      # event.error_code => String
      # event.error_message => String
    end
  end

You can also iterate through events after the response complete.

Events are available at resp.body # => Enumerator
For parameter input example, please refer to following request syntax

Request syntax with placeholder values


resp = client.invoke_endpoint_with_response_stream({
  endpoint_name: "EndpointName", # required
  body: "data", # required
  content_type: "Header",
  accept: "Header",
  custom_attributes: "CustomAttributesHeader",
  target_variant: "TargetVariantHeader",
  target_container_hostname: "TargetContainerHostnameHeader",
  inference_id: "InferenceId",
  inference_component_name: "InferenceComponentHeader",
  session_id: "SessionIdHeader",
})

Response structure


All events are available at resp.body:
resp.body #=> Enumerator
resp.body.event_types #=> [:payload_part, :model_stream_error, :internal_stream_failure]

For :payload_part event available at #on_payload_part_event callback and response eventstream enumerator:
event.bytes #=> String

For :model_stream_error event available at #on_model_stream_error_event callback and response eventstream enumerator:
event.message #=> String
event.error_code #=> String

For :internal_stream_failure event available at #on_internal_stream_failure_event callback and response eventstream enumerator:
event.message #=> String

resp.content_type #=> String
resp.invoked_production_variant #=> String
resp.custom_attributes #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:endpoint_name (required, String) —

The name of the endpoint that you specified when you created the endpoint using the [CreateEndpoint] API.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html
:body (required, String, StringIO, File) —

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html
:content_type (String) —

The MIME type of the input data in the request body.
:accept (String) —

The desired MIME type of the inference response from the model container.
:custom_attributes (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] 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.

[1]: datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
:target_variant (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]

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html
:target_container_hostname (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.
:inference_id (String) —

An identifier that you assign to your request.
:inference_component_name (String) —

If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke for a streaming response.
:session_id (String) —

The ID of a stateful session to handle your request.

You can’t create a stateful session by using the ‘InvokeEndpointWithResponseStream` action. Instead, you can create one by using the ` InvokeEndpoint ` action. In your request, you specify `NEW_SESSION` for the `SessionId` request parameter. The response to that request provides the session ID for the `NewSessionId` response parameter.

Yields:

(event_stream_handler)

Returns:

(Types::InvokeEndpointWithResponseStreamOutput) —
Returns a response object which responds to the following methods:
- #body => Types::ResponseStream
- #content_type => String
- #invoked_production_variant => String
- #custom_attributes => String

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



1105
1106
1107

# File 'lib/aws-sdk-sagemakerruntime/client.rb', line 1105

def waiter_names
  []
end

Class: Aws::SageMakerRuntime::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

#invoke_endpoint(params = {}) ⇒ Types::InvokeEndpointOutput

Examples:

Request syntax with placeholder values

Response structure

#invoke_endpoint_async(params = {}) ⇒ Types::InvokeEndpointAsyncOutput

Examples:

Request syntax with placeholder values

Response structure

#invoke_endpoint_with_response_stream(params = {}) ⇒ Types::InvokeEndpointWithResponseStreamOutput

Examples:

EventStream Operation Example

Request syntax with placeholder values

Response structure

#waiter_names ⇒ Object

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#build_request(operation_name, params = {}) ⇒ `Object`

#invoke_endpoint(params = {}) ⇒ `Types::InvokeEndpointOutput`

#invoke_endpoint_async(params = {}) ⇒ `Types::InvokeEndpointAsyncOutput`

#invoke_endpoint_with_response_stream(params = {}) ⇒ `Types::InvokeEndpointWithResponseStreamOutput`

#waiter_names ⇒ `Object`