The Amazon SageMaker runtime API.
+ * + */ +export class SageMakerRuntime extends SageMakerRuntimeClient { + /** + * + *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 AWS Signature Version
+ * 4. For information, see Authenticating Requests (AWS 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 the + * /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.
+ *The Amazon SageMaker runtime API.
+ * + */ +export class SageMakerRuntimeClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + SageMakerRuntimeClientResolvedConfig +> { + readonly config: SageMakerRuntimeClientResolvedConfig; + + constructor(configuration: SageMakerRuntimeClientConfig) { + let _config_0 = { + ...__ClientDefaultValues, + ...configuration + }; + let _config_1 = resolveRegionConfig(_config_0); + let _config_2 = resolveEndpointsConfig(_config_1); + let _config_3 = resolveAwsAuthConfig(_config_2); + let _config_4 = resolveRetryConfig(_config_3); + let _config_5 = resolveUserAgentConfig(_config_4); + let _config_6 = resolveHostHeaderConfig(_config_5); + super(_config_6); + this.config = _config_6; + this.middlewareStack.use(getAwsAuthPlugin(this.config)); + this.middlewareStack.use(getRetryPlugin(this.config)); + this.middlewareStack.use(getUserAgentPlugin(this.config)); + this.middlewareStack.use(getContentLengthPlugin(this.config)); + this.middlewareStack.use(getHostHeaderPlugin(this.config)); + } + + destroy(): void {} +} diff --git a/clients/client-sagemaker-runtime/commands/InvokeEndpointCommand.ts b/clients/client-sagemaker-runtime/commands/InvokeEndpointCommand.ts new file mode 100644 index 000000000000..138e290a9d93 --- /dev/null +++ b/clients/client-sagemaker-runtime/commands/InvokeEndpointCommand.ts @@ -0,0 +1,81 @@ +import { + SageMakerRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes +} from "../SageMakerRuntimeClient"; +import { InvokeEndpointInput, InvokeEndpointOutput } from "../models/index"; +import { + deserializeAws_restJson1_1InvokeEndpointCommand, + serializeAws_restJson1_1InvokeEndpointCommand +} from "../protocols/Aws_restJson1_1"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { + HttpRequest as __HttpRequest, + HttpResponse as __HttpResponse +} from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + SerdeContext, + HttpHandlerOptions as __HttpHandlerOptions +} from "@aws-sdk/types"; + +export type InvokeEndpointCommandInput = InvokeEndpointInput; +export type InvokeEndpointCommandOutput = InvokeEndpointOutput; + +export class InvokeEndpointCommand extends $Command< + InvokeEndpointCommandInput, + InvokeEndpointCommandOutput, + SageMakerRuntimeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: InvokeEndpointCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + resolveMiddleware( + clientStack: MiddlewareStackAn internal failure occurred.
+ * + */ +export interface InternalFailure + extends _smithy.SmithyException, + $MetadataBearer { + __type: "InternalFailure"; + $fault: "server"; + Message?: string; +} + +export namespace InternalFailure { + export function isa(o: any): o is InternalFailure { + return _smithy.isa(o, "InternalFailure"); + } +} + +export interface InvokeEndpointInput { + __type?: "InvokeEndpointInput"; + /** + * + *The desired MIME type of the inference in the response.
+ * + */ + Accept?: 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.
+ * + */ + Body: Uint8Array | undefined; + + /** + * + *The MIME type of the input data in the request body.
+ * + */ + ContentType?: 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). This feature is + * currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
+ * + */ + CustomAttributes?: string; + + /** + * + *The name of the endpoint that you specified when you created the endpoint using the + * CreateEndpoint API.
+ * + */ + EndpointName: string | undefined; + + /** + * + *Specifies the model to be requested for an inference when invoking a multi-model endpoint.
+ * + */ + TargetModel?: string; +} + +export namespace InvokeEndpointInput { + export function isa(o: any): o is InvokeEndpointInput { + return _smithy.isa(o, "InvokeEndpointInput"); + } +} + +export interface InvokeEndpointOutput extends $MetadataBearer { + __type?: "InvokeEndpointOutput"; + /** + * + *Includes the inference provided by the model.
+ *For information about the format of the response body, see Common Data + * Formats—Inference.
+ * + */ + Body: Uint8Array | undefined; + + /** + * + *The MIME type of the inference returned in the response body.
+ * + */ + ContentType?: 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 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.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker + * Python SDK.
+ * + */ + CustomAttributes?: string; + + /** + * + *Identifies the production variant that was invoked.
+ * + */ + InvokedProductionVariant?: string; +} + +export namespace InvokeEndpointOutput { + export function isa(o: any): o is InvokeEndpointOutput { + return _smithy.isa(o, "InvokeEndpointOutput"); + } +} + +/** + * + *Model (owned by the customer in the container) returned 4xx or 5xx error code. + *
+ * + */ +export interface ModelError extends _smithy.SmithyException, $MetadataBearer { + __type: "ModelError"; + $fault: "client"; + /** + * + *The Amazon Resource Name (ARN) of the log stream.
+ * + */ + LogStreamArn?: string; + + Message?: string; + /** + * + *Original message.
+ * + */ + OriginalMessage?: string; + + /** + * + *Original status code.
+ * + */ + OriginalStatusCode?: number; +} + +export namespace ModelError { + export function isa(o: any): o is ModelError { + return _smithy.isa(o, "ModelError"); + } +} + +/** + * + *The service is unavailable. Try your call again.
+ * + */ +export interface ServiceUnavailable + extends _smithy.SmithyException, + $MetadataBearer { + __type: "ServiceUnavailable"; + $fault: "server"; + Message?: string; +} + +export namespace ServiceUnavailable { + export function isa(o: any): o is ServiceUnavailable { + return _smithy.isa(o, "ServiceUnavailable"); + } +} + +/** + * + *Inspect your request and try again.
+ * + */ +export interface ValidationError + extends _smithy.SmithyException, + $MetadataBearer { + __type: "ValidationError"; + $fault: "client"; + Message?: string; +} + +export namespace ValidationError { + export function isa(o: any): o is ValidationError { + return _smithy.isa(o, "ValidationError"); + } +} diff --git a/clients/client-sagemaker-runtime/package.json b/clients/client-sagemaker-runtime/package.json new file mode 100644 index 000000000000..92e394682985 --- /dev/null +++ b/clients/client-sagemaker-runtime/package.json @@ -0,0 +1,75 @@ +{ + "name": "@aws-sdk/client-sagemaker-runtime", + "description": "@aws-sdk/client-sagemaker-runtime client", + "version": "0.1.0-preview.1", + "scripts": { + "clean": "npm run remove-definitions && npm run remove-dist && npm run remove-js && npm run remove-maps", + "build-documentation": "npm run clean && typedoc ./", + "prepublishOnly": "yarn build", + "pretest": "tsc", + "remove-definitions": "rimraf ./types", + "remove-dist": "rimraf ./dist", + "remove-documentation": "rimraf ./docs", + "remove-js": "rimraf *.js && rimraf ./commands/*.js && rimraf ./models/*.js && rimraf ./protocols/*.js", + "remove-maps": "rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./models/*.js.map && rimraf ./protocols/*.js.map", + "test": "exit 0", + "smoke-test": "npm run pretest && node ./test/smoke/index.spec.js", + "build:es": "tsc -p tsconfig.es.json", + "build": "yarn pretest && yarn build:es" + }, + "main": "./dist/cjs/index.js", + "types": "./types/index.d.ts", + "module": "./dist/es/index.js", + "browser": { + "./runtimeConfig": "./runtimeConfig.browser" + }, + "sideEffects": false, + "dependencies": { + "tslib": "^1.8.0", + "@aws-crypto/sha256-browser": "^0.1.0-preview.1", + "@aws-sdk/config-resolver": "^0.1.0-preview.5", + "@aws-sdk/credential-provider-node": "^0.1.0-preview.7", + "@aws-sdk/fetch-http-handler": "^0.1.0-preview.5", + "@aws-sdk/hash-node": "^0.1.0-preview.5", + "@aws-sdk/invalid-dependency": "^0.1.0-preview.1", + "@aws-sdk/middleware-content-length": "^0.1.0-preview.5", + "@aws-sdk/middleware-host-header": "^0.1.0-preview.1", + "@aws-sdk/middleware-retry": "^0.1.0-preview.5", + "@aws-sdk/middleware-serde": "^0.1.0-preview.1", + "@aws-sdk/middleware-signing": "^0.1.0-preview.7", + "@aws-sdk/middleware-stack": "^0.1.0-preview.6", + "@aws-sdk/middleware-user-agent": "^0.1.0-preview.1", + "@aws-sdk/node-http-handler": "^0.1.0-preview.6", + "@aws-sdk/protocol-http": "^0.1.0-preview.1", + "@aws-sdk/region-provider": "^0.1.0-preview.5", + "@aws-sdk/smithy-client": "^0.1.0-preview.1", + "@aws-sdk/stream-collector-browser": "^0.1.0-preview.5", + "@aws-sdk/stream-collector-node": "^0.1.0-preview.6", + "@aws-sdk/types": "^0.1.0-preview.5", + "@aws-sdk/url-parser-browser": "^0.1.0-preview.5", + "@aws-sdk/url-parser-node": "^0.1.0-preview.5", + "@aws-sdk/util-base64-browser": "^0.1.0-preview.3", + "@aws-sdk/util-base64-node": "^0.1.0-preview.3", + "@aws-sdk/util-body-length-browser": "^0.1.0-preview.3", + "@aws-sdk/util-body-length-node": "^0.1.0-preview.4", + "@aws-sdk/util-user-agent-browser": "^0.1.0-preview.6", + "@aws-sdk/util-user-agent-node": "^0.1.0-preview.6", + "@aws-sdk/util-utf8-browser": "^0.1.0-preview.3", + "@aws-sdk/util-utf8-node": "^0.1.0-preview.3" + }, + "devDependencies": { + "rimraf": "^3.0.0", + "typedoc": "^0.15.0", + "typescript": "^3.6.3", + "@types/node": "^12.7.5", + "tslib": "^1.8.0" + }, + "engines": { + "node": ">=8.0.0" + }, + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0" +} diff --git a/clients/client-sagemaker-runtime/protocols/Aws_restJson1_1.ts b/clients/client-sagemaker-runtime/protocols/Aws_restJson1_1.ts new file mode 100644 index 000000000000..75158eb6f60b --- /dev/null +++ b/clients/client-sagemaker-runtime/protocols/Aws_restJson1_1.ts @@ -0,0 +1,249 @@ +import { + InvokeEndpointCommandInput, + InvokeEndpointCommandOutput +} from "../commands/InvokeEndpointCommand"; +import { + InternalFailure, + ModelError, + ServiceUnavailable, + ValidationError +} from "../models/index"; +import { + HttpRequest as __HttpRequest, + HttpResponse as __HttpResponse +} from "@aws-sdk/protocol-http"; +import { SmithyException as __SmithyException } from "@aws-sdk/smithy-client"; +import { + Endpoint as __Endpoint, + MetadataBearer as __MetadataBearer, + ResponseMetadata as __ResponseMetadata, + SerdeContext as __SerdeContext +} from "@aws-sdk/types"; + +export async function serializeAws_restJson1_1InvokeEndpointCommand( + input: InvokeEndpointCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/octet-stream"; + if (input.Accept !== undefined) { + headers["Accept"] = input.Accept.toString(); + } + if (input.ContentType !== undefined) { + headers["Content-Type"] = input.ContentType.toString(); + } + if (input.CustomAttributes !== undefined) { + headers[ + "X-Amzn-SageMaker-Custom-Attributes" + ] = input.CustomAttributes.toString(); + } + if (input.TargetModel !== undefined) { + headers["X-Amzn-SageMaker-Target-Model"] = input.TargetModel.toString(); + } + let resolvedPath = "/endpoints/{EndpointName}/invocations"; + if (input.EndpointName !== undefined) { + const labelValue: any = input.EndpointName.toString(); + if (labelValue.length <= 0) { + throw new Error( + "Empty value provided for input HTTP label: EndpointName." + ); + } + resolvedPath = resolvedPath.replace("{EndpointName}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: EndpointName."); + } + let body: any = {}; + if (input.Body !== undefined) { + body = input.Body; + } + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "POST", + headers: headers, + path: resolvedPath, + body: body + }); +} + +export async function deserializeAws_restJson1_1InvokeEndpointCommand( + output: __HttpResponse, + context: __SerdeContext +): Promise