@aws-sdk/client-gameliftstreams 3.762.0

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

@@ -0,0 +1,154 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftStreamsClient";
+import { UpdateStreamGroupInput, UpdateStreamGroupOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateStreamGroupCommand}.
+ */
+export interface UpdateStreamGroupCommandInput extends UpdateStreamGroupInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateStreamGroupCommand}.
+ */
+export interface UpdateStreamGroupCommandOutput extends UpdateStreamGroupOutput, __MetadataBearer {
+}
+declare const UpdateStreamGroupCommand_base: {
+    new (input: UpdateStreamGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStreamGroupCommandInput, UpdateStreamGroupCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateStreamGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStreamGroupCommandInput, UpdateStreamGroupCommandOutput, GameLiftStreamsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>
+ *             Updates the configuration settings for an Amazon GameLift Streams stream group resource. You
+ *             can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.
+ *         </p>
+ *          <p>
+ *     Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity: always-on and on-demand:
+ * </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>Always-on</b>:
+ *     The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.
+ *
+ *         </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>On-demand</b>:
+ *     The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).
+ *
+ *         </p>
+ *             </li>
+ *          </ul>
+ *          <p>To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If
+ *             the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream
+ *             group.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GameLiftStreamsClient, UpdateStreamGroupCommand } from "@aws-sdk/client-gameliftstreams"; // ES Modules import
+ * // const { GameLiftStreamsClient, UpdateStreamGroupCommand } = require("@aws-sdk/client-gameliftstreams"); // CommonJS import
+ * const client = new GameLiftStreamsClient(config);
+ * const input = { // UpdateStreamGroupInput
+ *   Identifier: "STRING_VALUE", // required
+ *   LocationConfigurations: [ // LocationConfigurations
+ *     { // LocationConfiguration
+ *       LocationName: "STRING_VALUE", // required
+ *       AlwaysOnCapacity: Number("int"),
+ *       OnDemandCapacity: Number("int"),
+ *     },
+ *   ],
+ *   Description: "STRING_VALUE",
+ * };
+ * const command = new UpdateStreamGroupCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateStreamGroupOutput
+ * //   Arn: "STRING_VALUE", // required
+ * //   Description: "STRING_VALUE",
+ * //   DefaultApplication: { // DefaultApplication
+ * //     Id: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //   },
+ * //   LocationStates: [ // LocationStates
+ * //     { // LocationState
+ * //       LocationName: "STRING_VALUE",
+ * //       Status: "ACTIVATING" || "ACTIVE" || "ERROR" || "REMOVING",
+ * //       AlwaysOnCapacity: Number("int"),
+ * //       OnDemandCapacity: Number("int"),
+ * //       RequestedCapacity: Number("int"),
+ * //       AllocatedCapacity: Number("int"),
+ * //       IdleCapacity: Number("int"),
+ * //     },
+ * //   ],
+ * //   StreamClass: "gen4n_high" || "gen4n_ultra" || "gen4n_win2022" || "gen5n_high" || "gen5n_ultra" || "gen5n_win2022",
+ * //   Id: "STRING_VALUE",
+ * //   Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING",
+ * //   StatusReason: "internalError" || "noAvailableInstances",
+ * //   LastUpdatedAt: new Date("TIMESTAMP"),
+ * //   CreatedAt: new Date("TIMESTAMP"),
+ * //   AssociatedApplications: [ // ArnList
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateStreamGroupCommandInput - {@link UpdateStreamGroupCommandInput}
+ * @returns {@link UpdateStreamGroupCommandOutput}
+ * @see {@link UpdateStreamGroupCommandInput} for command's `input` shape.
+ * @see {@link UpdateStreamGroupCommandOutput} for command's `response` shape.
+ * @see {@link GameLiftStreamsClientResolvedConfig | config} for GameLiftStreamsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the
+ *          permissions before you try again.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The service encountered an internal error and is unable to complete the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request was not found. Correct the request before you try again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request would cause the resource to exceed an allowed service quota. Resolve the
+ *          issue before you try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. Retry the request after the
+ *          suggested wait time.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>One or more parameter values in the request fail to satisfy the specified constraints.
+ *          Correct the invalid parameter values before retrying the request.</p>
+ *
+ * @throws {@link GameLiftStreamsServiceException}
+ * <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
+ *
+ * @public
+ */
+export declare class UpdateStreamGroupCommand extends UpdateStreamGroupCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateStreamGroupInput;
+            output: UpdateStreamGroupOutput;
+        };
+        sdk: {
+            input: UpdateStreamGroupCommandInput;
+            output: UpdateStreamGroupCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,24 @@
+export * from "./AddStreamGroupLocationsCommand";
+export * from "./AssociateApplicationsCommand";
+export * from "./CreateApplicationCommand";
+export * from "./CreateStreamGroupCommand";
+export * from "./CreateStreamSessionConnectionCommand";
+export * from "./DeleteApplicationCommand";
+export * from "./DeleteStreamGroupCommand";
+export * from "./DisassociateApplicationsCommand";
+export * from "./ExportStreamSessionFilesCommand";
+export * from "./GetApplicationCommand";
+export * from "./GetStreamGroupCommand";
+export * from "./GetStreamSessionCommand";
+export * from "./ListApplicationsCommand";
+export * from "./ListStreamGroupsCommand";
+export * from "./ListStreamSessionsByAccountCommand";
+export * from "./ListStreamSessionsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./RemoveStreamGroupLocationsCommand";
+export * from "./StartStreamSessionCommand";
+export * from "./TagResourceCommand";
+export * from "./TerminateStreamSessionCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateApplicationCommand";
+export * from "./UpdateStreamGroupCommand";

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

@@ -0,0 +1,34 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+    region?: string | Provider<string>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    UseFIPS?: boolean;
+    Endpoint?: string;
+    Region?: string;
+}

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

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/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 "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface GameLiftStreamsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * <fullname>Amazon GameLift Streams</fullname>
+ *          <p>Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams
+ *          tools to upload and configure content for streaming, deploy and scale computing resources
+ *          to host streams, and manage stream session placement to meet customer demand.</p>
+ *          <p>This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the
+ *          Amazon Web Services SDK, the Command Line Interface (AWS CLI), or by making direct REST calls through HTTPS.</p>
+ *          <p>See the <i>Amazon GameLift Streams Developer Guide</i> for more information on how Amazon GameLift Streams works and how to work with it.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./GameLiftStreamsClient";
+export * from "./GameLiftStreams";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { GameLiftStreamsExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./waiters";
+export * from "./models";
+export { GameLiftStreamsServiceException } from "./models/GameLiftStreamsServiceException";

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

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

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

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