UNPKG

4.94 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class SageMakerRuntime extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: SageMakerRuntime.Types.ClientConfiguration)
13 config: Config & SageMakerRuntime.Types.ClientConfiguration;
14 /**
15 * 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. Cals 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. 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.
16 */
17 invokeEndpoint(params: SageMakerRuntime.Types.InvokeEndpointInput, callback?: (err: AWSError, data: SageMakerRuntime.Types.InvokeEndpointOutput) => void): Request<SageMakerRuntime.Types.InvokeEndpointOutput, AWSError>;
18 /**
19 * 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. Cals 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. 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.
20 */
21 invokeEndpoint(callback?: (err: AWSError, data: SageMakerRuntime.Types.InvokeEndpointOutput) => void): Request<SageMakerRuntime.Types.InvokeEndpointOutput, AWSError>;
22}
23declare namespace SageMakerRuntime {
24 export type BodyBlob = Buffer|Uint8Array|Blob|string;
25 export type CustomAttributesHeader = string;
26 export type EndpointName = string;
27 export type Header = string;
28 export interface InvokeEndpointInput {
29 /**
30 * The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
31 */
32 EndpointName: EndpointName;
33 /**
34 * 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.
35 */
36 Body: BodyBlob;
37 /**
38 * The MIME type of the input data in the request body.
39 */
40 ContentType?: Header;
41 /**
42 * The desired MIME type of the inference in the response.
43 */
44 Accept?: Header;
45 /**
46 *
47 */
48 CustomAttributes?: CustomAttributesHeader;
49 }
50 export interface InvokeEndpointOutput {
51 /**
52 * Includes the inference provided by the model. For information about the format of the response body, see Common Data Formats—Inference.
53 */
54 Body: BodyBlob;
55 /**
56 * The MIME type of the inference returned in the response body.
57 */
58 ContentType?: Header;
59 /**
60 * Identifies the production variant that was invoked.
61 */
62 InvokedProductionVariant?: Header;
63 /**
64 *
65 */
66 CustomAttributes?: CustomAttributesHeader;
67 }
68 /**
69 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
70 */
71 export type apiVersion = "2017-05-13"|"latest"|string;
72 export interface ClientApiVersions {
73 /**
74 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
75 */
76 apiVersion?: apiVersion;
77 }
78 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
79 /**
80 * Contains interfaces for use with the SageMakerRuntime client.
81 */
82 export import Types = SageMakerRuntime;
83}
84export = SageMakerRuntime;