@aws-sdk/client-ivs-realtime 3.298.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +373 -0
- package/dist-cjs/IVSRealTime.js +157 -0
- package/dist-cjs/IVSRealTimeClient.js +40 -0
- package/dist-cjs/commands/CreateParticipantTokenCommand.js +45 -0
- package/dist-cjs/commands/CreateStageCommand.js +45 -0
- package/dist-cjs/commands/DeleteStageCommand.js +45 -0
- package/dist-cjs/commands/DisconnectParticipantCommand.js +45 -0
- package/dist-cjs/commands/GetStageCommand.js +45 -0
- package/dist-cjs/commands/ListStagesCommand.js +45 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +45 -0
- package/dist-cjs/commands/TagResourceCommand.js +45 -0
- package/dist-cjs/commands/UntagResourceCommand.js +45 -0
- package/dist-cjs/commands/UpdateStageCommand.js +45 -0
- package/dist-cjs/commands/index.js +13 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/IVSRealTimeServiceException.js +11 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +107 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListStagesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/protocols/Aws_restJson1.js +922 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +48 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +21 -0
- package/dist-es/IVSRealTime.js +153 -0
- package/dist-es/IVSRealTimeClient.js +36 -0
- package/dist-es/commands/CreateParticipantTokenCommand.js +41 -0
- package/dist-es/commands/CreateStageCommand.js +41 -0
- package/dist-es/commands/DeleteStageCommand.js +41 -0
- package/dist-es/commands/DisconnectParticipantCommand.js +41 -0
- package/dist-es/commands/GetStageCommand.js +41 -0
- package/dist-es/commands/ListStagesCommand.js +41 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +41 -0
- package/dist-es/commands/TagResourceCommand.js +41 -0
- package/dist-es/commands/UntagResourceCommand.js +41 -0
- package/dist-es/commands/UpdateStageCommand.js +41 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/IVSRealTimeServiceException.js +7 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +97 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListStagesPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +899 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +17 -0
- package/dist-types/IVSRealTime.d.ts +175 -0
- package/dist-types/IVSRealTimeClient.d.ts +256 -0
- package/dist-types/commands/CreateParticipantTokenCommand.d.ts +77 -0
- package/dist-types/commands/CreateStageCommand.d.ts +72 -0
- package/dist-types/commands/DeleteStageCommand.d.ts +75 -0
- package/dist-types/commands/DisconnectParticipantCommand.d.ts +72 -0
- package/dist-types/commands/GetStageCommand.d.ts +69 -0
- package/dist-types/commands/ListStagesCommand.d.ts +69 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +69 -0
- package/dist-types/commands/TagResourceCommand.d.ts +69 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +69 -0
- package/dist-types/commands/UpdateStageCommand.d.ts +75 -0
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +19 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/index.d.ts +6 -0
- package/dist-types/models/IVSRealTimeServiceException.d.ts +12 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +477 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListStagesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +32 -0
- package/dist-types/runtimeConfig.browser.d.ts +42 -0
- package/dist-types/runtimeConfig.d.ts +42 -0
- package/dist-types/runtimeConfig.native.d.ts +41 -0
- package/dist-types/runtimeConfig.shared.d.ts +18 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +174 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +172 -0
- package/dist-types/ts3.4/commands/CreateParticipantTokenCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateStageCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeleteStageCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DisconnectParticipantCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetStageCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListStagesCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/UpdateStageCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/IVSRealTimeServiceException.d.ts +7 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +153 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListStagesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +125 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +80 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +18 -0
- package/package.json +98 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import packageInfo from "../package.json";
|
|
2
|
+
import { Sha256 } from "@aws-crypto/sha256-browser";
|
|
3
|
+
import { DEFAULT_USE_DUALSTACK_ENDPOINT, DEFAULT_USE_FIPS_ENDPOINT } from "@aws-sdk/config-resolver";
|
|
4
|
+
import { FetchHttpHandler as RequestHandler, streamCollector } from "@aws-sdk/fetch-http-handler";
|
|
5
|
+
import { invalidProvider } from "@aws-sdk/invalid-dependency";
|
|
6
|
+
import { calculateBodyLength } from "@aws-sdk/util-body-length-browser";
|
|
7
|
+
import { DEFAULT_MAX_ATTEMPTS, DEFAULT_RETRY_MODE } from "@aws-sdk/util-retry";
|
|
8
|
+
import { defaultUserAgent } from "@aws-sdk/util-user-agent-browser";
|
|
9
|
+
import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
|
|
10
|
+
import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
|
|
11
|
+
import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-browser";
|
|
12
|
+
export const getRuntimeConfig = (config) => {
|
|
13
|
+
const defaultsMode = resolveDefaultsModeConfig(config);
|
|
14
|
+
const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
|
|
15
|
+
const clientSharedValues = getSharedRuntimeConfig(config);
|
|
16
|
+
return {
|
|
17
|
+
...clientSharedValues,
|
|
18
|
+
...config,
|
|
19
|
+
runtime: "browser",
|
|
20
|
+
defaultsMode,
|
|
21
|
+
bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
|
|
22
|
+
credentialDefaultProvider: config?.credentialDefaultProvider ?? ((_) => () => Promise.reject(new Error("Credential is missing"))),
|
|
23
|
+
defaultUserAgentProvider: config?.defaultUserAgentProvider ??
|
|
24
|
+
defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
|
|
25
|
+
maxAttempts: config?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS,
|
|
26
|
+
region: config?.region ?? invalidProvider("Region is missing"),
|
|
27
|
+
requestHandler: config?.requestHandler ?? new RequestHandler(defaultConfigProvider),
|
|
28
|
+
retryMode: config?.retryMode ?? (async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE),
|
|
29
|
+
sha256: config?.sha256 ?? Sha256,
|
|
30
|
+
streamCollector: config?.streamCollector ?? streamCollector,
|
|
31
|
+
useDualstackEndpoint: config?.useDualstackEndpoint ?? (() => Promise.resolve(DEFAULT_USE_DUALSTACK_ENDPOINT)),
|
|
32
|
+
useFipsEndpoint: config?.useFipsEndpoint ?? (() => Promise.resolve(DEFAULT_USE_FIPS_ENDPOINT)),
|
|
33
|
+
};
|
|
34
|
+
};
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import packageInfo from "../package.json";
|
|
2
|
+
import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
|
|
3
|
+
import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@aws-sdk/config-resolver";
|
|
4
|
+
import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
|
|
5
|
+
import { Hash } from "@aws-sdk/hash-node";
|
|
6
|
+
import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@aws-sdk/middleware-retry";
|
|
7
|
+
import { loadConfig as loadNodeConfig } from "@aws-sdk/node-config-provider";
|
|
8
|
+
import { NodeHttpHandler as RequestHandler, streamCollector } from "@aws-sdk/node-http-handler";
|
|
9
|
+
import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
|
|
10
|
+
import { DEFAULT_RETRY_MODE } from "@aws-sdk/util-retry";
|
|
11
|
+
import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
|
|
12
|
+
import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
|
|
13
|
+
import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
|
|
14
|
+
import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-node";
|
|
15
|
+
import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
|
|
16
|
+
export const getRuntimeConfig = (config) => {
|
|
17
|
+
emitWarningIfUnsupportedVersion(process.version);
|
|
18
|
+
const defaultsMode = resolveDefaultsModeConfig(config);
|
|
19
|
+
const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
|
|
20
|
+
const clientSharedValues = getSharedRuntimeConfig(config);
|
|
21
|
+
return {
|
|
22
|
+
...clientSharedValues,
|
|
23
|
+
...config,
|
|
24
|
+
runtime: "node",
|
|
25
|
+
defaultsMode,
|
|
26
|
+
bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
|
|
27
|
+
credentialDefaultProvider: config?.credentialDefaultProvider ?? decorateDefaultCredentialProvider(credentialDefaultProvider),
|
|
28
|
+
defaultUserAgentProvider: config?.defaultUserAgentProvider ??
|
|
29
|
+
defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
|
|
30
|
+
maxAttempts: config?.maxAttempts ?? loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
|
|
31
|
+
region: config?.region ?? loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
|
|
32
|
+
requestHandler: config?.requestHandler ?? new RequestHandler(defaultConfigProvider),
|
|
33
|
+
retryMode: config?.retryMode ??
|
|
34
|
+
loadNodeConfig({
|
|
35
|
+
...NODE_RETRY_MODE_CONFIG_OPTIONS,
|
|
36
|
+
default: async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE,
|
|
37
|
+
}),
|
|
38
|
+
sha256: config?.sha256 ?? Hash.bind(null, "sha256"),
|
|
39
|
+
streamCollector: config?.streamCollector ?? streamCollector,
|
|
40
|
+
useDualstackEndpoint: config?.useDualstackEndpoint ?? loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
|
|
41
|
+
useFipsEndpoint: config?.useFipsEndpoint ?? loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
|
|
42
|
+
};
|
|
43
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Sha256 } from "@aws-crypto/sha256-js";
|
|
2
|
+
import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";
|
|
3
|
+
export const getRuntimeConfig = (config) => {
|
|
4
|
+
const browserDefaults = getBrowserRuntimeConfig(config);
|
|
5
|
+
return {
|
|
6
|
+
...browserDefaults,
|
|
7
|
+
...config,
|
|
8
|
+
runtime: "react-native",
|
|
9
|
+
sha256: config?.sha256 ?? Sha256,
|
|
10
|
+
};
|
|
11
|
+
};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { NoOpLogger } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { parseUrl } from "@aws-sdk/url-parser";
|
|
3
|
+
import { fromBase64, toBase64 } from "@aws-sdk/util-base64";
|
|
4
|
+
import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8";
|
|
5
|
+
import { defaultEndpointResolver } from "./endpoint/endpointResolver";
|
|
6
|
+
export const getRuntimeConfig = (config) => ({
|
|
7
|
+
apiVersion: "2020-07-14",
|
|
8
|
+
base64Decoder: config?.base64Decoder ?? fromBase64,
|
|
9
|
+
base64Encoder: config?.base64Encoder ?? toBase64,
|
|
10
|
+
disableHostPrefix: config?.disableHostPrefix ?? false,
|
|
11
|
+
endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
|
|
12
|
+
logger: config?.logger ?? new NoOpLogger(),
|
|
13
|
+
serviceId: config?.serviceId ?? "IVS RealTime",
|
|
14
|
+
urlParser: config?.urlParser ?? parseUrl,
|
|
15
|
+
utf8Decoder: config?.utf8Decoder ?? fromUtf8,
|
|
16
|
+
utf8Encoder: config?.utf8Encoder ?? toUtf8,
|
|
17
|
+
});
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
|
+
import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput } from "./commands/CreateParticipantTokenCommand";
|
|
3
|
+
import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
|
|
4
|
+
import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
|
|
5
|
+
import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
|
|
6
|
+
import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
|
|
7
|
+
import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
|
|
8
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
9
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
10
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
11
|
+
import { UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand";
|
|
12
|
+
import { IVSRealTimeClient } from "./IVSRealTimeClient";
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
* <p>
|
|
16
|
+
* <b>Introduction</b>
|
|
17
|
+
* </p>
|
|
18
|
+
* <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
|
|
19
|
+
* API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
|
|
20
|
+
* including errors.
|
|
21
|
+
* </p>
|
|
22
|
+
* <p>Terminology: The IVS stage API sometimes is referred to as the IVS RealTime API.</p>
|
|
23
|
+
* <p>
|
|
24
|
+
* <b>Resources</b>
|
|
25
|
+
* </p>
|
|
26
|
+
* <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html">Getting Started with Amazon IVS</a>):</p>
|
|
27
|
+
* <ul>
|
|
28
|
+
* <li>
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
|
|
31
|
+
* </li>
|
|
32
|
+
* </ul>
|
|
33
|
+
* <p>
|
|
34
|
+
* <b>Tagging</b>
|
|
35
|
+
* </p>
|
|
36
|
+
* <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
|
|
37
|
+
* comprises a <i>key</i> and a <i>value</i>, both set by you. For
|
|
38
|
+
* example, you might set a tag as <code>topic:nature</code> to label a particular video
|
|
39
|
+
* category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
|
|
40
|
+
* tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific
|
|
41
|
+
* constraints beyond what is documented there.</p>
|
|
42
|
+
* <p>Tags can help you identify and organize your AWS resources. For example, you can use the
|
|
43
|
+
* same tag for different resources to indicate that they are related. You can also use tags to
|
|
44
|
+
* manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
|
|
45
|
+
* <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
|
|
46
|
+
* <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
|
|
47
|
+
* <p>At most 50 tags can be applied to a resource.</p>
|
|
48
|
+
* <p>
|
|
49
|
+
* <b>Stages Endpoints</b>
|
|
50
|
+
* </p>
|
|
51
|
+
* <ul>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>
|
|
54
|
+
* <a>CreateParticipantToken</a> — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.</p>
|
|
55
|
+
* </li>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>
|
|
58
|
+
* <a>CreateStage</a> — Creates a new stage (and optionally participant tokens).</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>
|
|
62
|
+
* <a>DeleteStage</a> — Shuts down and deletes the specified stage (disconnecting all participants).</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>
|
|
66
|
+
* <a>DisconnectParticipant</a> — Disconnects a specified participant and revokes the participant permanently from a specified stage.</p>
|
|
67
|
+
* </li>
|
|
68
|
+
* <li>
|
|
69
|
+
* <p>
|
|
70
|
+
* <a>GetStage</a> — Gets information for the specified stage.</p>
|
|
71
|
+
* </li>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>
|
|
74
|
+
* <a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
|
|
75
|
+
* </li>
|
|
76
|
+
* <li>
|
|
77
|
+
* <p>
|
|
78
|
+
* <a>UpdateStage</a> — Updates a stage’s configuration.</p>
|
|
79
|
+
* </li>
|
|
80
|
+
* </ul>
|
|
81
|
+
* <p>
|
|
82
|
+
* <b>Tags Endpoints</b>
|
|
83
|
+
* </p>
|
|
84
|
+
* <ul>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>
|
|
87
|
+
* <a>ListTagsForResource</a> — Gets information about AWS tags for the
|
|
88
|
+
* specified ARN.</p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>
|
|
92
|
+
* <a>TagResource</a> — Adds or updates tags for the AWS resource with
|
|
93
|
+
* the specified ARN.</p>
|
|
94
|
+
* </li>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>
|
|
97
|
+
* <a>UntagResource</a> — Removes tags from the resource with the
|
|
98
|
+
* specified ARN.</p>
|
|
99
|
+
* </li>
|
|
100
|
+
* </ul>
|
|
101
|
+
*/
|
|
102
|
+
export declare class IVSRealTime extends IVSRealTimeClient {
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
* <p>Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
|
|
106
|
+
* Tokens always are scoped to the stage for which they are created.</p>
|
|
107
|
+
* <p>Encryption keys are owned by Amazon IVS and never used directly by your application.</p>
|
|
108
|
+
*/
|
|
109
|
+
createParticipantToken(args: CreateParticipantTokenCommandInput, options?: __HttpHandlerOptions): Promise<CreateParticipantTokenCommandOutput>;
|
|
110
|
+
createParticipantToken(args: CreateParticipantTokenCommandInput, cb: (err: any, data?: CreateParticipantTokenCommandOutput) => void): void;
|
|
111
|
+
createParticipantToken(args: CreateParticipantTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParticipantTokenCommandOutput) => void): void;
|
|
112
|
+
/**
|
|
113
|
+
* @public
|
|
114
|
+
* <p>Creates a new stage (and optionally participant tokens).</p>
|
|
115
|
+
*/
|
|
116
|
+
createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise<CreateStageCommandOutput>;
|
|
117
|
+
createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void;
|
|
118
|
+
createStage(args: CreateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStageCommandOutput) => void): void;
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
* <p>Shuts down and deletes the specified stage (disconnecting all participants).</p>
|
|
122
|
+
*/
|
|
123
|
+
deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStageCommandOutput>;
|
|
124
|
+
deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void;
|
|
125
|
+
deleteStage(args: DeleteStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStageCommandOutput) => void): void;
|
|
126
|
+
/**
|
|
127
|
+
* @public
|
|
128
|
+
* <p>Disconnects a specified participant and revokes the participant permanently from a specified stage.</p>
|
|
129
|
+
*/
|
|
130
|
+
disconnectParticipant(args: DisconnectParticipantCommandInput, options?: __HttpHandlerOptions): Promise<DisconnectParticipantCommandOutput>;
|
|
131
|
+
disconnectParticipant(args: DisconnectParticipantCommandInput, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void): void;
|
|
132
|
+
disconnectParticipant(args: DisconnectParticipantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void): void;
|
|
133
|
+
/**
|
|
134
|
+
* @public
|
|
135
|
+
* <p>Gets information for the specified stage.</p>
|
|
136
|
+
*/
|
|
137
|
+
getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise<GetStageCommandOutput>;
|
|
138
|
+
getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void;
|
|
139
|
+
getStage(args: GetStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStageCommandOutput) => void): void;
|
|
140
|
+
/**
|
|
141
|
+
* @public
|
|
142
|
+
* <p>Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
|
|
143
|
+
*/
|
|
144
|
+
listStages(args: ListStagesCommandInput, options?: __HttpHandlerOptions): Promise<ListStagesCommandOutput>;
|
|
145
|
+
listStages(args: ListStagesCommandInput, cb: (err: any, data?: ListStagesCommandOutput) => void): void;
|
|
146
|
+
listStages(args: ListStagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStagesCommandOutput) => void): void;
|
|
147
|
+
/**
|
|
148
|
+
* @public
|
|
149
|
+
* <p>Gets information about AWS tags for the specified ARN.</p>
|
|
150
|
+
*/
|
|
151
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
152
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
153
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
154
|
+
/**
|
|
155
|
+
* @public
|
|
156
|
+
* <p>Adds or updates tags for the AWS resource with the specified ARN.</p>
|
|
157
|
+
*/
|
|
158
|
+
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
159
|
+
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
160
|
+
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
161
|
+
/**
|
|
162
|
+
* @public
|
|
163
|
+
* <p>Removes tags from the resource with the specified ARN.</p>
|
|
164
|
+
*/
|
|
165
|
+
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
166
|
+
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
167
|
+
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
168
|
+
/**
|
|
169
|
+
* @public
|
|
170
|
+
* <p>Updates a stage’s configuration.</p>
|
|
171
|
+
*/
|
|
172
|
+
updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStageCommandOutput>;
|
|
173
|
+
updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void;
|
|
174
|
+
updateStage(args: UpdateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStageCommandOutput) => void): void;
|
|
175
|
+
}
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
import { RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver";
|
|
2
|
+
import { EndpointInputConfig, EndpointResolvedConfig } from "@aws-sdk/middleware-endpoint";
|
|
3
|
+
import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
|
|
4
|
+
import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
|
|
5
|
+
import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
|
|
6
|
+
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
7
|
+
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
8
|
+
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
9
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, 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";
|
|
10
|
+
import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput } from "./commands/CreateParticipantTokenCommand";
|
|
11
|
+
import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
|
|
12
|
+
import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
|
|
13
|
+
import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
|
|
14
|
+
import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
|
|
15
|
+
import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
|
|
16
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
17
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
18
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
19
|
+
import { UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand";
|
|
20
|
+
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export type ServiceInputTypes = CreateParticipantTokenCommandInput | CreateStageCommandInput | DeleteStageCommandInput | DisconnectParticipantCommandInput | GetStageCommandInput | ListStagesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStageCommandInput;
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export type ServiceOutputTypes = CreateParticipantTokenCommandOutput | CreateStageCommandOutput | DeleteStageCommandOutput | DisconnectParticipantCommandOutput | GetStageCommandOutput | ListStagesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStageCommandOutput;
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
33
|
+
/**
|
|
34
|
+
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
35
|
+
*/
|
|
36
|
+
requestHandler?: __HttpHandler;
|
|
37
|
+
/**
|
|
38
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
39
|
+
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
42
|
+
sha256?: __ChecksumConstructor | __HashConstructor;
|
|
43
|
+
/**
|
|
44
|
+
* The function that will be used to convert strings into HTTP endpoints.
|
|
45
|
+
* @internal
|
|
46
|
+
*/
|
|
47
|
+
urlParser?: __UrlParser;
|
|
48
|
+
/**
|
|
49
|
+
* A function that can calculate the length of a request body.
|
|
50
|
+
* @internal
|
|
51
|
+
*/
|
|
52
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
53
|
+
/**
|
|
54
|
+
* A function that converts a stream into an array of bytes.
|
|
55
|
+
* @internal
|
|
56
|
+
*/
|
|
57
|
+
streamCollector?: __StreamCollector;
|
|
58
|
+
/**
|
|
59
|
+
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
60
|
+
* @internal
|
|
61
|
+
*/
|
|
62
|
+
base64Decoder?: __Decoder;
|
|
63
|
+
/**
|
|
64
|
+
* The function that will be used to convert binary data to a base64-encoded string.
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
67
|
+
base64Encoder?: __Encoder;
|
|
68
|
+
/**
|
|
69
|
+
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
utf8Decoder?: __Decoder;
|
|
73
|
+
/**
|
|
74
|
+
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
utf8Encoder?: __Encoder;
|
|
78
|
+
/**
|
|
79
|
+
* The runtime environment.
|
|
80
|
+
* @internal
|
|
81
|
+
*/
|
|
82
|
+
runtime?: string;
|
|
83
|
+
/**
|
|
84
|
+
* Disable dyanamically changing the endpoint of the client based on the hostPrefix
|
|
85
|
+
* trait of an operation.
|
|
86
|
+
*/
|
|
87
|
+
disableHostPrefix?: boolean;
|
|
88
|
+
/**
|
|
89
|
+
* Unique service identifier.
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
serviceId?: string;
|
|
93
|
+
/**
|
|
94
|
+
* Enables IPv6/IPv4 dualstack endpoint.
|
|
95
|
+
*/
|
|
96
|
+
useDualstackEndpoint?: boolean | __Provider<boolean>;
|
|
97
|
+
/**
|
|
98
|
+
* Enables FIPS compatible endpoints.
|
|
99
|
+
*/
|
|
100
|
+
useFipsEndpoint?: boolean | __Provider<boolean>;
|
|
101
|
+
/**
|
|
102
|
+
* The AWS region to which this client will send requests
|
|
103
|
+
*/
|
|
104
|
+
region?: string | __Provider<string>;
|
|
105
|
+
/**
|
|
106
|
+
* Default credentials provider; Not available in browser runtime.
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
110
|
+
/**
|
|
111
|
+
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
115
|
+
/**
|
|
116
|
+
* Value for how many times a request will be made at most in case of retry.
|
|
117
|
+
*/
|
|
118
|
+
maxAttempts?: number | __Provider<number>;
|
|
119
|
+
/**
|
|
120
|
+
* Specifies which retry algorithm to use.
|
|
121
|
+
*/
|
|
122
|
+
retryMode?: string | __Provider<string>;
|
|
123
|
+
/**
|
|
124
|
+
* Optional logger for logging debug/info/warn/error.
|
|
125
|
+
*/
|
|
126
|
+
logger?: __Logger;
|
|
127
|
+
/**
|
|
128
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
129
|
+
*/
|
|
130
|
+
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
type IVSRealTimeClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
*
|
|
139
|
+
* The configuration interface of IVSRealTimeClient class constructor that set the region, credentials and other options.
|
|
140
|
+
*/
|
|
141
|
+
export interface IVSRealTimeClientConfig extends IVSRealTimeClientConfigType {
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
type IVSRealTimeClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
147
|
+
/**
|
|
148
|
+
* @public
|
|
149
|
+
*
|
|
150
|
+
* The resolved configuration interface of IVSRealTimeClient class. This is resolved and normalized from the {@link IVSRealTimeClientConfig | constructor configuration interface}.
|
|
151
|
+
*/
|
|
152
|
+
export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolvedConfigType {
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* @public
|
|
156
|
+
* <p>
|
|
157
|
+
* <b>Introduction</b>
|
|
158
|
+
* </p>
|
|
159
|
+
* <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
|
|
160
|
+
* API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
|
|
161
|
+
* including errors.
|
|
162
|
+
* </p>
|
|
163
|
+
* <p>Terminology: The IVS stage API sometimes is referred to as the IVS RealTime API.</p>
|
|
164
|
+
* <p>
|
|
165
|
+
* <b>Resources</b>
|
|
166
|
+
* </p>
|
|
167
|
+
* <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html">Getting Started with Amazon IVS</a>):</p>
|
|
168
|
+
* <ul>
|
|
169
|
+
* <li>
|
|
170
|
+
* <p>
|
|
171
|
+
* <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
|
|
172
|
+
* </li>
|
|
173
|
+
* </ul>
|
|
174
|
+
* <p>
|
|
175
|
+
* <b>Tagging</b>
|
|
176
|
+
* </p>
|
|
177
|
+
* <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
|
|
178
|
+
* comprises a <i>key</i> and a <i>value</i>, both set by you. For
|
|
179
|
+
* example, you might set a tag as <code>topic:nature</code> to label a particular video
|
|
180
|
+
* category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
|
|
181
|
+
* tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific
|
|
182
|
+
* constraints beyond what is documented there.</p>
|
|
183
|
+
* <p>Tags can help you identify and organize your AWS resources. For example, you can use the
|
|
184
|
+
* same tag for different resources to indicate that they are related. You can also use tags to
|
|
185
|
+
* manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
|
|
186
|
+
* <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
|
|
187
|
+
* <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
|
|
188
|
+
* <p>At most 50 tags can be applied to a resource.</p>
|
|
189
|
+
* <p>
|
|
190
|
+
* <b>Stages Endpoints</b>
|
|
191
|
+
* </p>
|
|
192
|
+
* <ul>
|
|
193
|
+
* <li>
|
|
194
|
+
* <p>
|
|
195
|
+
* <a>CreateParticipantToken</a> — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.</p>
|
|
196
|
+
* </li>
|
|
197
|
+
* <li>
|
|
198
|
+
* <p>
|
|
199
|
+
* <a>CreateStage</a> — Creates a new stage (and optionally participant tokens).</p>
|
|
200
|
+
* </li>
|
|
201
|
+
* <li>
|
|
202
|
+
* <p>
|
|
203
|
+
* <a>DeleteStage</a> — Shuts down and deletes the specified stage (disconnecting all participants).</p>
|
|
204
|
+
* </li>
|
|
205
|
+
* <li>
|
|
206
|
+
* <p>
|
|
207
|
+
* <a>DisconnectParticipant</a> — Disconnects a specified participant and revokes the participant permanently from a specified stage.</p>
|
|
208
|
+
* </li>
|
|
209
|
+
* <li>
|
|
210
|
+
* <p>
|
|
211
|
+
* <a>GetStage</a> — Gets information for the specified stage.</p>
|
|
212
|
+
* </li>
|
|
213
|
+
* <li>
|
|
214
|
+
* <p>
|
|
215
|
+
* <a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
|
|
216
|
+
* </li>
|
|
217
|
+
* <li>
|
|
218
|
+
* <p>
|
|
219
|
+
* <a>UpdateStage</a> — Updates a stage’s configuration.</p>
|
|
220
|
+
* </li>
|
|
221
|
+
* </ul>
|
|
222
|
+
* <p>
|
|
223
|
+
* <b>Tags Endpoints</b>
|
|
224
|
+
* </p>
|
|
225
|
+
* <ul>
|
|
226
|
+
* <li>
|
|
227
|
+
* <p>
|
|
228
|
+
* <a>ListTagsForResource</a> — Gets information about AWS tags for the
|
|
229
|
+
* specified ARN.</p>
|
|
230
|
+
* </li>
|
|
231
|
+
* <li>
|
|
232
|
+
* <p>
|
|
233
|
+
* <a>TagResource</a> — Adds or updates tags for the AWS resource with
|
|
234
|
+
* the specified ARN.</p>
|
|
235
|
+
* </li>
|
|
236
|
+
* <li>
|
|
237
|
+
* <p>
|
|
238
|
+
* <a>UntagResource</a> — Removes tags from the resource with the
|
|
239
|
+
* specified ARN.</p>
|
|
240
|
+
* </li>
|
|
241
|
+
* </ul>
|
|
242
|
+
*/
|
|
243
|
+
export declare class IVSRealTimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IVSRealTimeClientResolvedConfig> {
|
|
244
|
+
/**
|
|
245
|
+
* The resolved configuration of IVSRealTimeClient class. This is resolved and normalized from the {@link IVSRealTimeClientConfig | constructor configuration interface}.
|
|
246
|
+
*/
|
|
247
|
+
readonly config: IVSRealTimeClientResolvedConfig;
|
|
248
|
+
constructor(configuration: IVSRealTimeClientConfig);
|
|
249
|
+
/**
|
|
250
|
+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
251
|
+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
252
|
+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
253
|
+
*/
|
|
254
|
+
destroy(): void;
|
|
255
|
+
}
|
|
256
|
+
export {};
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { CreateParticipantTokenRequest, CreateParticipantTokenResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link CreateParticipantTokenCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface CreateParticipantTokenCommandInput extends CreateParticipantTokenRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link CreateParticipantTokenCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateParticipantTokenCommandOutput extends CreateParticipantTokenResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
|
|
23
|
+
* Tokens always are scoped to the stage for which they are created.</p>
|
|
24
|
+
* <p>Encryption keys are owned by Amazon IVS and never used directly by your application.</p>
|
|
25
|
+
* @example
|
|
26
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
27
|
+
* ```javascript
|
|
28
|
+
* import { IVSRealTimeClient, CreateParticipantTokenCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
29
|
+
* // const { IVSRealTimeClient, CreateParticipantTokenCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
30
|
+
* const client = new IVSRealTimeClient(config);
|
|
31
|
+
* const command = new CreateParticipantTokenCommand(input);
|
|
32
|
+
* const response = await client.send(command);
|
|
33
|
+
* ```
|
|
34
|
+
*
|
|
35
|
+
* @param CreateParticipantTokenCommandInput - {@link CreateParticipantTokenCommandInput}
|
|
36
|
+
* @returns {@link CreateParticipantTokenCommandOutput}
|
|
37
|
+
* @see {@link CreateParticipantTokenCommandInput} for command's `input` shape.
|
|
38
|
+
* @see {@link CreateParticipantTokenCommandOutput} for command's `response` shape.
|
|
39
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
42
|
+
* <p/>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link PendingVerification} (client fault)
|
|
45
|
+
* <p/>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
48
|
+
* <p/>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
51
|
+
* <p/>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ValidationException} (client fault)
|
|
54
|
+
* <p/>
|
|
55
|
+
*
|
|
56
|
+
*
|
|
57
|
+
*/
|
|
58
|
+
export declare class CreateParticipantTokenCommand extends $Command<CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
59
|
+
readonly input: CreateParticipantTokenCommandInput;
|
|
60
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
constructor(input: CreateParticipantTokenCommandInput);
|
|
65
|
+
/**
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput>;
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
private serialize;
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
76
|
+
private deserialize;
|
|
77
|
+
}
|