@aws-sdk/client-rekognitionstreaming 3.305.0

package/dist-es/runtimeConfig.shared.js

@@ -0,0 +1,17 @@
+import { NoOpLogger } from "@aws-sdk/smithy-client";
+import { parseUrl } from "@aws-sdk/url-parser";
+import { fromBase64, toBase64 } from "@aws-sdk/util-base64";
+import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8";
+import { defaultEndpointResolver } from "./endpoint/endpointResolver";
+export const getRuntimeConfig = (config) => ({
+    apiVersion: "2022-05-30",
+    base64Decoder: config?.base64Decoder ?? fromBase64,
+    base64Encoder: config?.base64Encoder ?? toBase64,
+    disableHostPrefix: config?.disableHostPrefix ?? false,
+    endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
+    logger: config?.logger ?? new NoOpLogger(),
+    serviceId: config?.serviceId ?? "RekognitionStreaming",
+    urlParser: config?.urlParser ?? parseUrl,
+    utf8Decoder: config?.utf8Decoder ?? fromUtf8,
+    utf8Encoder: config?.utf8Encoder ?? toUtf8,
+});

package/dist-types/RekognitionStreaming.d.ts

@@ -0,0 +1,21 @@
+import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
+import { StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput } from "./commands/StartFaceLivenessSessionCommand";
+import { StartStreamingLivenessSessionCommandInput, StartStreamingLivenessSessionCommandOutput } from "./commands/StartStreamingLivenessSessionCommand";
+import { RekognitionStreamingClient } from "./RekognitionStreamingClient";
+/**
+ * @public
+ */
+export declare class RekognitionStreaming extends RekognitionStreamingClient {
+    /**
+     * @public
+     */
+    startFaceLivenessSession(args: StartFaceLivenessSessionCommandInput, options?: __HttpHandlerOptions): Promise<StartFaceLivenessSessionCommandOutput>;
+    startFaceLivenessSession(args: StartFaceLivenessSessionCommandInput, cb: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void): void;
+    startFaceLivenessSession(args: StartFaceLivenessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void): void;
+    /**
+     * @public
+     */
+    startStreamingLivenessSession(args: StartStreamingLivenessSessionCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamingLivenessSessionCommandOutput>;
+    startStreamingLivenessSession(args: StartStreamingLivenessSessionCommandInput, cb: (err: any, data?: StartStreamingLivenessSessionCommandOutput) => void): void;
+    startStreamingLivenessSession(args: StartStreamingLivenessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamingLivenessSessionCommandOutput) => void): void;
+}

package/dist-types/RekognitionStreamingClient.d.ts

@@ -0,0 +1,174 @@
+import { RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver";
+import { EventStreamSerdeInputConfig, EventStreamSerdeResolvedConfig } from "@aws-sdk/eventstream-serde-config-resolver";
+import { EndpointInputConfig, EndpointResolvedConfig } from "@aws-sdk/middleware-endpoint";
+import { EventStreamInputConfig, EventStreamResolvedConfig } from "@aws-sdk/middleware-eventstream";
+import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
+import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
+import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
+import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
+import { WebSocketInputConfig, WebSocketResolvedConfig } from "@aws-sdk/middleware-websocket";
+import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
+import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
+import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, EventStreamPayloadHandlerProvider as __EventStreamPayloadHandlerProvider, EventStreamSerdeProvider as __EventStreamSerdeProvider, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
+import { StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput } from "./commands/StartFaceLivenessSessionCommand";
+import { StartStreamingLivenessSessionCommandInput, StartStreamingLivenessSessionCommandOutput } from "./commands/StartStreamingLivenessSessionCommand";
+import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
+export type ServiceInputTypes = StartFaceLivenessSessionCommandInput | StartStreamingLivenessSessionCommandInput;
+/**
+ * @public
+ */
+export type ServiceOutputTypes = StartFaceLivenessSessionCommandOutput | StartStreamingLivenessSessionCommandOutput;
+/**
+ * @public
+ */
+export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
+    /**
+     * The HTTP handler to use. Fetch in browser and Https in Nodejs.
+     */
+    requestHandler?: __HttpHandler;
+    /**
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
+     * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
+     * @internal
+     */
+    sha256?: __ChecksumConstructor | __HashConstructor;
+    /**
+     * The function that will be used to convert strings into HTTP endpoints.
+     * @internal
+     */
+    urlParser?: __UrlParser;
+    /**
+     * A function that can calculate the length of a request body.
+     * @internal
+     */
+    bodyLengthChecker?: __BodyLengthCalculator;
+    /**
+     * A function that converts a stream into an array of bytes.
+     * @internal
+     */
+    streamCollector?: __StreamCollector;
+    /**
+     * The function that will be used to convert a base64-encoded string to a byte array.
+     * @internal
+     */
+    base64Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a base64-encoded string.
+     * @internal
+     */
+    base64Encoder?: __Encoder;
+    /**
+     * The function that will be used to convert a UTF8-encoded string to a byte array.
+     * @internal
+     */
+    utf8Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a UTF-8 encoded string.
+     * @internal
+     */
+    utf8Encoder?: __Encoder;
+    /**
+     * The runtime environment.
+     * @internal
+     */
+    runtime?: string;
+    /**
+     * Disable dyanamically changing the endpoint of the client based on the hostPrefix
+     * trait of an operation.
+     */
+    disableHostPrefix?: boolean;
+    /**
+     * Unique service identifier.
+     * @internal
+     */
+    serviceId?: string;
+    /**
+     * Enables IPv6/IPv4 dualstack endpoint.
+     */
+    useDualstackEndpoint?: boolean | __Provider<boolean>;
+    /**
+     * Enables FIPS compatible endpoints.
+     */
+    useFipsEndpoint?: boolean | __Provider<boolean>;
+    /**
+     * The AWS region to which this client will send requests
+     */
+    region?: string | __Provider<string>;
+    /**
+     * Default credentials provider; Not available in browser runtime.
+     * @internal
+     */
+    credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
+    /**
+     * The function that provides necessary utilities for handling request event stream.
+     * @internal
+     */
+    eventStreamPayloadHandlerProvider?: __EventStreamPayloadHandlerProvider;
+    /**
+     * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
+     * @internal
+     */
+    defaultUserAgentProvider?: Provider<__UserAgent>;
+    /**
+     * Value for how many times a request will be made at most in case of retry.
+     */
+    maxAttempts?: number | __Provider<number>;
+    /**
+     * Specifies which retry algorithm to use.
+     */
+    retryMode?: string | __Provider<string>;
+    /**
+     * Optional logger for logging debug/info/warn/error.
+     */
+    logger?: __Logger;
+    /**
+     * The function that provides necessary utilities for generating and parsing event stream
+     */
+    eventStreamSerdeProvider?: __EventStreamSerdeProvider;
+    /**
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     */
+    defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
+}
+/**
+ * @public
+ */
+type RekognitionStreamingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & EventStreamInputConfig & WebSocketInputConfig & UserAgentInputConfig & EventStreamSerdeInputConfig & ClientInputEndpointParameters;
+/**
+ * @public
+ *
+ *  The configuration interface of RekognitionStreamingClient class constructor that set the region, credentials and other options.
+ */
+export interface RekognitionStreamingClientConfig extends RekognitionStreamingClientConfigType {
+}
+/**
+ * @public
+ */
+type RekognitionStreamingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & EventStreamResolvedConfig & WebSocketResolvedConfig & UserAgentResolvedConfig & EventStreamSerdeResolvedConfig & ClientResolvedEndpointParameters;
+/**
+ * @public
+ *
+ *  The resolved configuration interface of RekognitionStreamingClient class. This is resolved and normalized from the {@link RekognitionStreamingClientConfig | constructor configuration interface}.
+ */
+export interface RekognitionStreamingClientResolvedConfig extends RekognitionStreamingClientResolvedConfigType {
+}
+/**
+ * @public
+ */
+export declare class RekognitionStreamingClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RekognitionStreamingClientResolvedConfig> {
+    /**
+     * The resolved configuration of RekognitionStreamingClient class. This is resolved and normalized from the {@link RekognitionStreamingClientConfig | constructor configuration interface}.
+     */
+    readonly config: RekognitionStreamingClientResolvedConfig;
+    constructor(configuration: RekognitionStreamingClientConfig);
+    /**
+     * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+     * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+     * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+     */
+    destroy(): void;
+}
+export {};

package/dist-types/commands/StartFaceLivenessSessionCommand.d.ts

@@ -0,0 +1,39 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { StartFaceLivenessSessionRequest, StartFaceLivenessSessionResponse } from "../models/models_0";
+import { RekognitionStreamingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionStreamingClient";
+/**
+ * @public
+ *
+ * The input for {@link StartFaceLivenessSessionCommand}.
+ */
+export interface StartFaceLivenessSessionCommandInput extends StartFaceLivenessSessionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartFaceLivenessSessionCommand}.
+ */
+export interface StartFaceLivenessSessionCommandOutput extends StartFaceLivenessSessionResponse, __MetadataBearer {
+}
+export declare class StartFaceLivenessSessionCommand extends $Command<StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput, RekognitionStreamingClientResolvedConfig> {
+    readonly input: StartFaceLivenessSessionCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: StartFaceLivenessSessionCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionStreamingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/StartStreamingLivenessSessionCommand.d.ts

@@ -0,0 +1,39 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { StartStreamingLivenessSessionRequest, StartStreamingLivenessSessionResponse } from "../models/models_0";
+import { RekognitionStreamingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionStreamingClient";
+/**
+ * @public
+ *
+ * The input for {@link StartStreamingLivenessSessionCommand}.
+ */
+export interface StartStreamingLivenessSessionCommandInput extends StartStreamingLivenessSessionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartStreamingLivenessSessionCommand}.
+ */
+export interface StartStreamingLivenessSessionCommandOutput extends StartStreamingLivenessSessionResponse, __MetadataBearer {
+}
+export declare class StartStreamingLivenessSessionCommand extends $Command<StartStreamingLivenessSessionCommandInput, StartStreamingLivenessSessionCommandOutput, RekognitionStreamingClientResolvedConfig> {
+    readonly input: StartStreamingLivenessSessionCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: StartStreamingLivenessSessionCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionStreamingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartStreamingLivenessSessionCommandInput, StartStreamingLivenessSessionCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./StartFaceLivenessSessionCommand";
+export * from "./StartStreamingLivenessSessionCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,19 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@aws-sdk/types";
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@aws-sdk/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@aws-sdk/util-endpoints";
+export declare const ruleSet: RuleSetObject;

package/dist-types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./RekognitionStreaming";
+export * from "./RekognitionStreamingClient";
+export * from "./commands";
+export * from "./models";
+export { RekognitionStreamingServiceException } from "./models/RekognitionStreamingServiceException";

package/dist-types/models/RekognitionStreamingServiceException.d.ts

@@ -0,0 +1,12 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from RekognitionStreaming service.
+ */
+export declare class RekognitionStreamingServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";