@aws-sdk/client-gameliftstreams 3.762.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 +404 -0
- package/dist-cjs/GameLiftStreams.js +59 -0
- package/dist-cjs/GameLiftStreamsClient.js +51 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/AddStreamGroupLocationsCommand.js +26 -0
- package/dist-cjs/commands/AssociateApplicationsCommand.js +26 -0
- package/dist-cjs/commands/CreateApplicationCommand.js +26 -0
- package/dist-cjs/commands/CreateStreamGroupCommand.js +26 -0
- package/dist-cjs/commands/CreateStreamSessionConnectionCommand.js +27 -0
- package/dist-cjs/commands/DeleteApplicationCommand.js +26 -0
- package/dist-cjs/commands/DeleteStreamGroupCommand.js +26 -0
- package/dist-cjs/commands/DisassociateApplicationsCommand.js +26 -0
- package/dist-cjs/commands/ExportStreamSessionFilesCommand.js +26 -0
- package/dist-cjs/commands/GetApplicationCommand.js +26 -0
- package/dist-cjs/commands/GetStreamGroupCommand.js +26 -0
- package/dist-cjs/commands/GetStreamSessionCommand.js +27 -0
- package/dist-cjs/commands/ListApplicationsCommand.js +26 -0
- package/dist-cjs/commands/ListStreamGroupsCommand.js +26 -0
- package/dist-cjs/commands/ListStreamSessionsByAccountCommand.js +26 -0
- package/dist-cjs/commands/ListStreamSessionsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
- package/dist-cjs/commands/RemoveStreamGroupLocationsCommand.js +26 -0
- package/dist-cjs/commands/StartStreamSessionCommand.js +27 -0
- package/dist-cjs/commands/TagResourceCommand.js +26 -0
- package/dist-cjs/commands/TerminateStreamSessionCommand.js +26 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/UpdateApplicationCommand.js +26 -0
- package/dist-cjs/commands/UpdateStreamGroupCommand.js +26 -0
- package/dist-cjs/commands/index.js +27 -0
- package/dist-cjs/endpoint/EndpointParameters.js +16 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/GameLiftStreamsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +211 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListApplicationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListStreamGroupsPaginator.js +7 -0
- package/dist-cjs/pagination/ListStreamSessionsByAccountPaginator.js +7 -0
- package/dist-cjs/pagination/ListStreamSessionsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1005 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +52 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-cjs/waiters/index.js +8 -0
- package/dist-cjs/waiters/waitForApplicationDeleted.js +30 -0
- package/dist-cjs/waiters/waitForApplicationReady.js +45 -0
- package/dist-cjs/waiters/waitForStreamGroupActive.js +63 -0
- package/dist-cjs/waiters/waitForStreamGroupDeleted.js +30 -0
- package/dist-cjs/waiters/waitForStreamSessionActive.js +45 -0
- package/dist-es/GameLiftStreams.js +55 -0
- package/dist-es/GameLiftStreamsClient.js +47 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/AddStreamGroupLocationsCommand.js +22 -0
- package/dist-es/commands/AssociateApplicationsCommand.js +22 -0
- package/dist-es/commands/CreateApplicationCommand.js +22 -0
- package/dist-es/commands/CreateStreamGroupCommand.js +22 -0
- package/dist-es/commands/CreateStreamSessionConnectionCommand.js +23 -0
- package/dist-es/commands/DeleteApplicationCommand.js +22 -0
- package/dist-es/commands/DeleteStreamGroupCommand.js +22 -0
- package/dist-es/commands/DisassociateApplicationsCommand.js +22 -0
- package/dist-es/commands/ExportStreamSessionFilesCommand.js +22 -0
- package/dist-es/commands/GetApplicationCommand.js +22 -0
- package/dist-es/commands/GetStreamGroupCommand.js +22 -0
- package/dist-es/commands/GetStreamSessionCommand.js +23 -0
- package/dist-es/commands/ListApplicationsCommand.js +22 -0
- package/dist-es/commands/ListStreamGroupsCommand.js +22 -0
- package/dist-es/commands/ListStreamSessionsByAccountCommand.js +22 -0
- package/dist-es/commands/ListStreamSessionsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/RemoveStreamGroupLocationsCommand.js +22 -0
- package/dist-es/commands/StartStreamSessionCommand.js +23 -0
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/TerminateStreamSessionCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateApplicationCommand.js +22 -0
- package/dist-es/commands/UpdateStreamGroupCommand.js +22 -0
- package/dist-es/commands/index.js +24 -0
- package/dist-es/endpoint/EndpointParameters.js +12 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/GameLiftStreamsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +196 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListApplicationsPaginator.js +4 -0
- package/dist-es/pagination/ListStreamGroupsPaginator.js +4 -0
- package/dist-es/pagination/ListStreamSessionsByAccountPaginator.js +4 -0
- package/dist-es/pagination/ListStreamSessionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocols/Aws_restJson1.js +954 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +47 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-es/waiters/index.js +5 -0
- package/dist-es/waiters/waitForApplicationDeleted.js +25 -0
- package/dist-es/waiters/waitForApplicationReady.js +40 -0
- package/dist-es/waiters/waitForStreamGroupActive.js +58 -0
- package/dist-es/waiters/waitForStreamGroupDeleted.js +25 -0
- package/dist-es/waiters/waitForStreamSessionActive.js +40 -0
- package/dist-types/GameLiftStreams.d.ts +187 -0
- package/dist-types/GameLiftStreamsClient.d.ts +217 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/AddStreamGroupLocationsCommand.d.ts +116 -0
- package/dist-types/commands/AssociateApplicationsCommand.d.ts +99 -0
- package/dist-types/commands/CreateApplicationCommand.d.ts +146 -0
- package/dist-types/commands/CreateStreamGroupCommand.d.ts +158 -0
- package/dist-types/commands/CreateStreamSessionConnectionCommand.d.ts +114 -0
- package/dist-types/commands/DeleteApplicationCommand.d.ts +116 -0
- package/dist-types/commands/DeleteStreamGroupCommand.d.ts +93 -0
- package/dist-types/commands/DisassociateApplicationsCommand.d.ts +100 -0
- package/dist-types/commands/ExportStreamSessionFilesCommand.d.ts +116 -0
- package/dist-types/commands/GetApplicationCommand.d.ts +116 -0
- package/dist-types/commands/GetStreamGroupCommand.d.ts +116 -0
- package/dist-types/commands/GetStreamSessionCommand.d.ts +119 -0
- package/dist-types/commands/ListApplicationsCommand.d.ts +103 -0
- package/dist-types/commands/ListStreamGroupsCommand.d.ts +104 -0
- package/dist-types/commands/ListStreamSessionsByAccountCommand.d.ts +109 -0
- package/dist-types/commands/ListStreamSessionsCommand.d.ts +113 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +100 -0
- package/dist-types/commands/RemoveStreamGroupLocationsCommand.d.ts +95 -0
- package/dist-types/commands/StartStreamSessionCommand.d.ts +156 -0
- package/dist-types/commands/TagResourceCommand.d.ts +107 -0
- package/dist-types/commands/TerminateStreamSessionCommand.d.ts +91 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +88 -0
- package/dist-types/commands/UpdateApplicationCommand.d.ts +122 -0
- package/dist-types/commands/UpdateStreamGroupCommand.d.ts +154 -0
- package/dist-types/commands/index.d.ts +24 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +34 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +21 -0
- package/dist-types/models/GameLiftStreamsServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +3555 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListApplicationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStreamGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStreamSessionsByAccountPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStreamSessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +218 -0
- package/dist-types/runtimeConfig.browser.d.ts +49 -0
- package/dist-types/runtimeConfig.d.ts +49 -0
- package/dist-types/runtimeConfig.native.d.ts +48 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/GameLiftStreams.d.ts +418 -0
- package/dist-types/ts3.4/GameLiftStreamsClient.d.ts +264 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/AddStreamGroupLocationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/AssociateApplicationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateApplicationCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateStreamGroupCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateStreamSessionConnectionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteApplicationCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DeleteStreamGroupCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DisassociateApplicationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ExportStreamSessionFilesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetApplicationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetStreamGroupCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetStreamSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListApplicationsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListStreamGroupsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListStreamSessionsByAccountCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListStreamSessionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RemoveStreamGroupLocationsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/StartStreamSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/TerminateStreamSessionCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateApplicationCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateStreamGroupCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +24 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -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/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/GameLiftStreamsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +518 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListApplicationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStreamGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStreamSessionsByAccountPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStreamSessionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +293 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +98 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +99 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +102 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/dist-types/ts3.4/waiters/index.d.ts +5 -0
- package/dist-types/ts3.4/waiters/waitForApplicationDeleted.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForApplicationReady.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForStreamGroupActive.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForStreamGroupDeleted.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForStreamSessionActive.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +5 -0
- package/dist-types/waiters/waitForApplicationDeleted.d.ts +14 -0
- package/dist-types/waiters/waitForApplicationReady.d.ts +14 -0
- package/dist-types/waiters/waitForStreamGroupActive.d.ts +14 -0
- package/dist-types/waiters/waitForStreamGroupDeleted.d.ts +14 -0
- package/dist-types/waiters/waitForStreamSessionActive.d.ts +14 -0
- package/package.json +102 -0
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftStreamsClient";
|
|
4
|
+
import { DisassociateApplicationsInput, DisassociateApplicationsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DisassociateApplicationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DisassociateApplicationsCommandInput extends DisassociateApplicationsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DisassociateApplicationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DisassociateApplicationsCommandOutput extends DisassociateApplicationsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DisassociateApplicationsCommand_base: {
|
|
25
|
+
new (input: DisassociateApplicationsCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateApplicationsCommandInput, DisassociateApplicationsCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DisassociateApplicationsCommandInput): import("@smithy/smithy-client").CommandImpl<DisassociateApplicationsCommandInput, DisassociateApplicationsCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream capacity of a stream group.
|
|
32
|
+
* </p>
|
|
33
|
+
* <p>
|
|
34
|
+
* You can only disassociate an application if it's not a default application of the stream group. Check <code>DefaultApplicationIdentifier</code> by calling <a>GetStreamGroup</a>.
|
|
35
|
+
* </p>
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { GameLiftStreamsClient, DisassociateApplicationsCommand } from "@aws-sdk/client-gameliftstreams"; // ES Modules import
|
|
40
|
+
* // const { GameLiftStreamsClient, DisassociateApplicationsCommand } = require("@aws-sdk/client-gameliftstreams"); // CommonJS import
|
|
41
|
+
* const client = new GameLiftStreamsClient(config);
|
|
42
|
+
* const input = { // DisassociateApplicationsInput
|
|
43
|
+
* Identifier: "STRING_VALUE", // required
|
|
44
|
+
* ApplicationIdentifiers: [ // Identifiers // required
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* };
|
|
48
|
+
* const command = new DisassociateApplicationsCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // DisassociateApplicationsOutput
|
|
51
|
+
* // Arn: "STRING_VALUE",
|
|
52
|
+
* // ApplicationArns: [ // ArnList
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param DisassociateApplicationsCommandInput - {@link DisassociateApplicationsCommandInput}
|
|
60
|
+
* @returns {@link DisassociateApplicationsCommandOutput}
|
|
61
|
+
* @see {@link DisassociateApplicationsCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link DisassociateApplicationsCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link GameLiftStreamsClientResolvedConfig | config} for GameLiftStreamsClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the
|
|
67
|
+
* permissions before you try again.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerException} (server fault)
|
|
70
|
+
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
|
+
* <p>The resource specified in the request was not found. Correct the request before you try again.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
+
* <p>The request was denied due to request throttling. Retry the request after the
|
|
77
|
+
* suggested wait time.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints.
|
|
81
|
+
* Correct the invalid parameter values before retrying the request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link GameLiftStreamsServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class DisassociateApplicationsCommand extends DisassociateApplicationsCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: DisassociateApplicationsInput;
|
|
93
|
+
output: DisassociateApplicationsOutput;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: DisassociateApplicationsCommandInput;
|
|
97
|
+
output: DisassociateApplicationsCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftStreamsClient";
|
|
4
|
+
import { ExportStreamSessionFilesInput, ExportStreamSessionFilesOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ExportStreamSessionFilesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ExportStreamSessionFilesCommandInput extends ExportStreamSessionFilesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ExportStreamSessionFilesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ExportStreamSessionFilesCommandOutput extends ExportStreamSessionFilesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ExportStreamSessionFilesCommand_base: {
|
|
25
|
+
new (input: ExportStreamSessionFilesCommandInput): import("@smithy/smithy-client").CommandImpl<ExportStreamSessionFilesCommandInput, ExportStreamSessionFilesCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ExportStreamSessionFilesCommandInput): import("@smithy/smithy-client").CommandImpl<ExportStreamSessionFilesCommandInput, ExportStreamSessionFilesCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output.
|
|
32
|
+
* </p>
|
|
33
|
+
* <p>
|
|
34
|
+
* You can only call this action on a stream session that is in progress, specifically in one of the following statuses <code>ACTIVE</code>, <code>CONNECTED</code>, <code>PENDING_CLIENT_RECONNECTION</code>, and <code>RECONNECTING</code>. You must provide an Amazon Simple Storage Service (Amazon S3) bucket to store the files in. When the session ends, Amazon GameLift Streams produces a compressed folder that contains all of the files and directories that were modified or created by the application during the stream session. AWS uses your security credentials to authenticate and authorize access to your Amazon S3 bucket.
|
|
35
|
+
* </p>
|
|
36
|
+
* <p>Amazon GameLift Streams collects the following generated and modified files. Find them in the
|
|
37
|
+
* corresponding folders in the <code>.zip</code> archive.</p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <code>application/</code>: The folder where your application or game is stored.
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* </ul>
|
|
45
|
+
* <ul>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <code>profile/</code>: The user profile folder.</p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <code>temp/</code>: The system temp folder.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
55
|
+
* <p/>
|
|
56
|
+
* <p>To verify the status of the exported files, use GetStreamSession. </p>
|
|
57
|
+
* <p>To delete the files, delete the object in the S3 bucket. </p>
|
|
58
|
+
* @example
|
|
59
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
60
|
+
* ```javascript
|
|
61
|
+
* import { GameLiftStreamsClient, ExportStreamSessionFilesCommand } from "@aws-sdk/client-gameliftstreams"; // ES Modules import
|
|
62
|
+
* // const { GameLiftStreamsClient, ExportStreamSessionFilesCommand } = require("@aws-sdk/client-gameliftstreams"); // CommonJS import
|
|
63
|
+
* const client = new GameLiftStreamsClient(config);
|
|
64
|
+
* const input = { // ExportStreamSessionFilesInput
|
|
65
|
+
* Identifier: "STRING_VALUE", // required
|
|
66
|
+
* StreamSessionIdentifier: "STRING_VALUE", // required
|
|
67
|
+
* OutputUri: "STRING_VALUE", // required
|
|
68
|
+
* };
|
|
69
|
+
* const command = new ExportStreamSessionFilesCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* // {};
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param ExportStreamSessionFilesCommandInput - {@link ExportStreamSessionFilesCommandInput}
|
|
76
|
+
* @returns {@link ExportStreamSessionFilesCommandOutput}
|
|
77
|
+
* @see {@link ExportStreamSessionFilesCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link ExportStreamSessionFilesCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link GameLiftStreamsClientResolvedConfig | config} for GameLiftStreamsClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the
|
|
83
|
+
* permissions before you try again.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalServerException} (server fault)
|
|
86
|
+
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
89
|
+
* <p>The resource specified in the request was not found. Correct the request before you try again.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
92
|
+
* <p>The request was denied due to request throttling. Retry the request after the
|
|
93
|
+
* suggested wait time.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ValidationException} (client fault)
|
|
96
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints.
|
|
97
|
+
* Correct the invalid parameter values before retrying the request.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link GameLiftStreamsServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
101
|
+
*
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
export declare class ExportStreamSessionFilesCommand extends ExportStreamSessionFilesCommand_base {
|
|
105
|
+
/** @internal type navigation helper, not in runtime. */
|
|
106
|
+
protected static __types: {
|
|
107
|
+
api: {
|
|
108
|
+
input: ExportStreamSessionFilesInput;
|
|
109
|
+
output: {};
|
|
110
|
+
};
|
|
111
|
+
sdk: {
|
|
112
|
+
input: ExportStreamSessionFilesCommandInput;
|
|
113
|
+
output: ExportStreamSessionFilesCommandOutput;
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftStreamsClient";
|
|
4
|
+
import { GetApplicationInput, GetApplicationOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetApplicationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetApplicationCommandInput extends GetApplicationInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetApplicationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetApplicationCommandOutput extends GetApplicationOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetApplicationCommand_base: {
|
|
25
|
+
new (input: GetApplicationCommandInput): import("@smithy/smithy-client").CommandImpl<GetApplicationCommandInput, GetApplicationCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetApplicationCommandInput): import("@smithy/smithy-client").CommandImpl<GetApplicationCommandInput, GetApplicationCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the
|
|
31
|
+
* application that you want to retrieve. If the operation is successful, it returns
|
|
32
|
+
* properties for the requested application.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { GameLiftStreamsClient, GetApplicationCommand } from "@aws-sdk/client-gameliftstreams"; // ES Modules import
|
|
37
|
+
* // const { GameLiftStreamsClient, GetApplicationCommand } = require("@aws-sdk/client-gameliftstreams"); // CommonJS import
|
|
38
|
+
* const client = new GameLiftStreamsClient(config);
|
|
39
|
+
* const input = { // GetApplicationInput
|
|
40
|
+
* Identifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetApplicationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetApplicationOutput
|
|
45
|
+
* // Arn: "STRING_VALUE", // required
|
|
46
|
+
* // Description: "STRING_VALUE",
|
|
47
|
+
* // RuntimeEnvironment: { // RuntimeEnvironment
|
|
48
|
+
* // Type: "PROTON" || "WINDOWS" || "UBUNTU", // required
|
|
49
|
+
* // Version: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // ExecutablePath: "STRING_VALUE",
|
|
52
|
+
* // ApplicationLogPaths: [ // FilePaths
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // ApplicationLogOutputUri: "STRING_VALUE",
|
|
56
|
+
* // ApplicationSourceUri: "STRING_VALUE",
|
|
57
|
+
* // Id: "STRING_VALUE",
|
|
58
|
+
* // Status: "INITIALIZED" || "PROCESSING" || "READY" || "DELETING" || "ERROR",
|
|
59
|
+
* // StatusReason: "internalError" || "accessDenied",
|
|
60
|
+
* // ReplicationStatuses: [ // ReplicationStatuses
|
|
61
|
+
* // { // ReplicationStatus
|
|
62
|
+
* // Location: "STRING_VALUE",
|
|
63
|
+
* // Status: "REPLICATING" || "COMPLETED",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
67
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
68
|
+
* // AssociatedStreamGroups: [ // ArnList
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param GetApplicationCommandInput - {@link GetApplicationCommandInput}
|
|
76
|
+
* @returns {@link GetApplicationCommandOutput}
|
|
77
|
+
* @see {@link GetApplicationCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link GetApplicationCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link GameLiftStreamsClientResolvedConfig | config} for GameLiftStreamsClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the
|
|
83
|
+
* permissions before you try again.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalServerException} (server fault)
|
|
86
|
+
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
89
|
+
* <p>The resource specified in the request was not found. Correct the request before you try again.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
92
|
+
* <p>The request was denied due to request throttling. Retry the request after the
|
|
93
|
+
* suggested wait time.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ValidationException} (client fault)
|
|
96
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints.
|
|
97
|
+
* Correct the invalid parameter values before retrying the request.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link GameLiftStreamsServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
101
|
+
*
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
export declare class GetApplicationCommand extends GetApplicationCommand_base {
|
|
105
|
+
/** @internal type navigation helper, not in runtime. */
|
|
106
|
+
protected static __types: {
|
|
107
|
+
api: {
|
|
108
|
+
input: GetApplicationInput;
|
|
109
|
+
output: GetApplicationOutput;
|
|
110
|
+
};
|
|
111
|
+
sdk: {
|
|
112
|
+
input: GetApplicationCommandInput;
|
|
113
|
+
output: GetApplicationCommandOutput;
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftStreamsClient";
|
|
4
|
+
import { GetStreamGroupInput, GetStreamGroupOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetStreamGroupCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetStreamGroupCommandInput extends GetStreamGroupInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetStreamGroupCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetStreamGroupCommandOutput extends GetStreamGroupOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetStreamGroupCommand_base: {
|
|
25
|
+
new (input: GetStreamGroupCommandInput): import("@smithy/smithy-client").CommandImpl<GetStreamGroupCommandInput, GetStreamGroupCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetStreamGroupCommandInput): import("@smithy/smithy-client").CommandImpl<GetStreamGroupCommandInput, GetStreamGroupCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream
|
|
31
|
+
* group that you want to retrieve. If the operation is successful, it returns properties
|
|
32
|
+
* for the requested stream group.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { GameLiftStreamsClient, GetStreamGroupCommand } from "@aws-sdk/client-gameliftstreams"; // ES Modules import
|
|
37
|
+
* // const { GameLiftStreamsClient, GetStreamGroupCommand } = require("@aws-sdk/client-gameliftstreams"); // CommonJS import
|
|
38
|
+
* const client = new GameLiftStreamsClient(config);
|
|
39
|
+
* const input = { // GetStreamGroupInput
|
|
40
|
+
* Identifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetStreamGroupCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetStreamGroupOutput
|
|
45
|
+
* // Arn: "STRING_VALUE", // required
|
|
46
|
+
* // Description: "STRING_VALUE",
|
|
47
|
+
* // DefaultApplication: { // DefaultApplication
|
|
48
|
+
* // Id: "STRING_VALUE",
|
|
49
|
+
* // Arn: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // LocationStates: [ // LocationStates
|
|
52
|
+
* // { // LocationState
|
|
53
|
+
* // LocationName: "STRING_VALUE",
|
|
54
|
+
* // Status: "ACTIVATING" || "ACTIVE" || "ERROR" || "REMOVING",
|
|
55
|
+
* // AlwaysOnCapacity: Number("int"),
|
|
56
|
+
* // OnDemandCapacity: Number("int"),
|
|
57
|
+
* // RequestedCapacity: Number("int"),
|
|
58
|
+
* // AllocatedCapacity: Number("int"),
|
|
59
|
+
* // IdleCapacity: Number("int"),
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // StreamClass: "gen4n_high" || "gen4n_ultra" || "gen4n_win2022" || "gen5n_high" || "gen5n_ultra" || "gen5n_win2022",
|
|
63
|
+
* // Id: "STRING_VALUE",
|
|
64
|
+
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING",
|
|
65
|
+
* // StatusReason: "internalError" || "noAvailableInstances",
|
|
66
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
67
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
68
|
+
* // AssociatedApplications: [ // ArnList
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param GetStreamGroupCommandInput - {@link GetStreamGroupCommandInput}
|
|
76
|
+
* @returns {@link GetStreamGroupCommandOutput}
|
|
77
|
+
* @see {@link GetStreamGroupCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link GetStreamGroupCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link GameLiftStreamsClientResolvedConfig | config} for GameLiftStreamsClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the
|
|
83
|
+
* permissions before you try again.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalServerException} (server fault)
|
|
86
|
+
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
89
|
+
* <p>The resource specified in the request was not found. Correct the request before you try again.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
92
|
+
* <p>The request was denied due to request throttling. Retry the request after the
|
|
93
|
+
* suggested wait time.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ValidationException} (client fault)
|
|
96
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints.
|
|
97
|
+
* Correct the invalid parameter values before retrying the request.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link GameLiftStreamsServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
101
|
+
*
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
export declare class GetStreamGroupCommand extends GetStreamGroupCommand_base {
|
|
105
|
+
/** @internal type navigation helper, not in runtime. */
|
|
106
|
+
protected static __types: {
|
|
107
|
+
api: {
|
|
108
|
+
input: GetStreamGroupInput;
|
|
109
|
+
output: GetStreamGroupOutput;
|
|
110
|
+
};
|
|
111
|
+
sdk: {
|
|
112
|
+
input: GetStreamGroupCommandInput;
|
|
113
|
+
output: GetStreamGroupCommandOutput;
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftStreamsClient";
|
|
4
|
+
import { GetStreamSessionInput, GetStreamSessionOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetStreamSessionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetStreamSessionCommandInput extends GetStreamSessionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetStreamSessionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetStreamSessionCommandOutput extends GetStreamSessionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetStreamSessionCommand_base: {
|
|
25
|
+
new (input: GetStreamSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetStreamSessionCommandInput, GetStreamSessionCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetStreamSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetStreamSessionCommandInput, GetStreamSessionCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the
|
|
31
|
+
* stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties
|
|
32
|
+
* for the requested resource.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { GameLiftStreamsClient, GetStreamSessionCommand } from "@aws-sdk/client-gameliftstreams"; // ES Modules import
|
|
37
|
+
* // const { GameLiftStreamsClient, GetStreamSessionCommand } = require("@aws-sdk/client-gameliftstreams"); // CommonJS import
|
|
38
|
+
* const client = new GameLiftStreamsClient(config);
|
|
39
|
+
* const input = { // GetStreamSessionInput
|
|
40
|
+
* Identifier: "STRING_VALUE", // required
|
|
41
|
+
* StreamSessionIdentifier: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetStreamSessionCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetStreamSessionOutput
|
|
46
|
+
* // Arn: "STRING_VALUE",
|
|
47
|
+
* // Description: "STRING_VALUE",
|
|
48
|
+
* // StreamGroupId: "STRING_VALUE",
|
|
49
|
+
* // UserId: "STRING_VALUE",
|
|
50
|
+
* // Status: "ACTIVATING" || "ACTIVE" || "CONNECTED" || "PENDING_CLIENT_RECONNECTION" || "RECONNECTING" || "TERMINATING" || "TERMINATED" || "ERROR",
|
|
51
|
+
* // StatusReason: "internalError" || "invalidSignalRequest" || "placementTimeout" || "applicationLogS3DestinationError",
|
|
52
|
+
* // Protocol: "WebRTC",
|
|
53
|
+
* // Location: "STRING_VALUE",
|
|
54
|
+
* // SignalRequest: "STRING_VALUE",
|
|
55
|
+
* // SignalResponse: "STRING_VALUE",
|
|
56
|
+
* // ConnectionTimeoutSeconds: Number("int"),
|
|
57
|
+
* // SessionLengthSeconds: Number("int"),
|
|
58
|
+
* // AdditionalLaunchArgs: [ // GameLaunchArgList
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // AdditionalEnvironmentVariables: { // EnvironmentVariables
|
|
62
|
+
* // "<keys>": "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // LogFileLocationUri: "STRING_VALUE",
|
|
65
|
+
* // WebSdkProtocolUrl: "STRING_VALUE",
|
|
66
|
+
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
67
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
68
|
+
* // ApplicationArn: "STRING_VALUE",
|
|
69
|
+
* // ExportFilesMetadata: { // ExportFilesMetadata
|
|
70
|
+
* // Status: "SUCCEEDED" || "FAILED" || "PENDING",
|
|
71
|
+
* // StatusReason: "STRING_VALUE",
|
|
72
|
+
* // OutputUri: "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
78
|
+
* @param GetStreamSessionCommandInput - {@link GetStreamSessionCommandInput}
|
|
79
|
+
* @returns {@link GetStreamSessionCommandOutput}
|
|
80
|
+
* @see {@link GetStreamSessionCommandInput} for command's `input` shape.
|
|
81
|
+
* @see {@link GetStreamSessionCommandOutput} for command's `response` shape.
|
|
82
|
+
* @see {@link GameLiftStreamsClientResolvedConfig | config} for GameLiftStreamsClient's `config` shape.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
85
|
+
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the
|
|
86
|
+
* permissions before you try again.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link InternalServerException} (server fault)
|
|
89
|
+
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
92
|
+
* <p>The resource specified in the request was not found. Correct the request before you try again.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
95
|
+
* <p>The request was denied due to request throttling. Retry the request after the
|
|
96
|
+
* suggested wait time.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ValidationException} (client fault)
|
|
99
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints.
|
|
100
|
+
* Correct the invalid parameter values before retrying the request.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link GameLiftStreamsServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
104
|
+
*
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export declare class GetStreamSessionCommand extends GetStreamSessionCommand_base {
|
|
108
|
+
/** @internal type navigation helper, not in runtime. */
|
|
109
|
+
protected static __types: {
|
|
110
|
+
api: {
|
|
111
|
+
input: GetStreamSessionInput;
|
|
112
|
+
output: GetStreamSessionOutput;
|
|
113
|
+
};
|
|
114
|
+
sdk: {
|
|
115
|
+
input: GetStreamSessionCommandInput;
|
|
116
|
+
output: GetStreamSessionCommandOutput;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
}
|