UNPKG

2.13 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 ApiGatewayManagementApi extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: ApiGatewayManagementApi.Types.ClientConfiguration)
13 config: Config & ApiGatewayManagementApi.Types.ClientConfiguration;
14 /**
15 * Sends the provided data to the specified connection.
16 */
17 postToConnection(params: ApiGatewayManagementApi.Types.PostToConnectionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
18 /**
19 * Sends the provided data to the specified connection.
20 */
21 postToConnection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
22}
23declare namespace ApiGatewayManagementApi {
24 export type Data = Buffer|Uint8Array|Blob|string;
25 export interface PostToConnectionRequest {
26 /**
27 * The data to be sent to the client specified by its connection id.
28 */
29 Data: Data;
30 /**
31 * The identifier of the connection that a specific client is using.
32 */
33 ConnectionId: __string;
34 }
35 export type __string = string;
36 /**
37 * 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.
38 */
39 export type apiVersion = "2018-11-29"|"latest"|string;
40 export interface ClientApiVersions {
41 /**
42 * 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.
43 */
44 apiVersion?: apiVersion;
45 }
46 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
47 /**
48 * Contains interfaces for use with the ApiGatewayManagementApi client.
49 */
50 export import Types = ApiGatewayManagementApi;
51}
52export = ApiGatewayManagementApi;