clients/client-gameliftstreams/src/models/models

// smithy-typescript generated code import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; import { GameLiftStreamsServiceException as __BaseException } from "./GameLiftStreamsServiceException"; /** * You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again. * @public */ export class AccessDeniedException extends __BaseException { readonly name: "AccessDeniedException" = "AccessDeniedException"; readonly $fault: "client" = "client"; /** * Description of the error. * @public */ Message: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) { super({ name: "AccessDeniedException", $fault: "client", ...opts, }); Object.setPrototypeOf(this, AccessDeniedException.prototype); this.Message = opts.Message; } } /** * Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you * must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a>. To add a new location and specify its * capacity, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AddStreamGroupLocations.html">AddStreamGroupLocations</a>. * @public */ export interface LocationConfiguration { /** * * A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ LocationName: string | undefined; /** * * 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. * * @public */ AlwaysOnCapacity?: number | undefined; /** * * 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). * * @public */ OnDemandCapacity?: number | undefined; } /** * @public */ export interface AddStreamGroupLocationsInput { /** * A stream group to add the specified locations to. * This value is a * Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * * A set of one or more locations and the streaming capacity for each location. * * @public */ LocationConfigurations: LocationConfiguration[] | undefined; } /** * @public * @enum */ export const StreamGroupLocationStatus = { ACTIVATING: "ACTIVATING", ACTIVE: "ACTIVE", ERROR: "ERROR", REMOVING: "REMOVING", } as const; /** * @public */ export type StreamGroupLocationStatus = (typeof StreamGroupLocationStatus)[keyof typeof StreamGroupLocationStatus]; /** * Represents a location and its corresponding stream capacity and status. * @public */ export interface LocationState { /** * * A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ LocationName?: string | undefined; /** * This value is * set of locations, including their name, current status, and capacities. * * * A location can be in one of the following states: * * <ul> * <li> * * ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * * </li> * <li> * * ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * * </li> * <li> * * ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * * </li> * <li> * * REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * * </li> * </ul> * @public */ Status?: StreamGroupLocationStatus | undefined; /** * * 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. * * @public */ AlwaysOnCapacity?: number | undefined; /** * * 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). * * @public */ OnDemandCapacity?: number | undefined; /** * This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group. * @public */ RequestedCapacity?: number | undefined; /** * This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. * @public */ AllocatedCapacity?: number | undefined; /** * This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity. * @public */ IdleCapacity?: number | undefined; } /** * @public */ export interface AddStreamGroupLocationsOutput { /** * This value is the * Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * This value is * set of locations, including their name, current status, and capacities. * * * A location can be in one of the following states: * * <ul> * <li> * * ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * * </li> * <li> * * ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * * </li> * <li> * * ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * * </li> * <li> * * REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * * </li> * </ul> * @public */ Locations: LocationState[] | undefined; } /** * The service encountered an internal error and is unable to complete the request. * @public */ export class InternalServerException extends __BaseException { readonly name: "InternalServerException" = "InternalServerException"; readonly $fault: "server" = "server"; $retryable = {}; /** * Description of the error. * @public */ Message: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>) { super({ name: "InternalServerException", $fault: "server", ...opts, }); Object.setPrototypeOf(this, InternalServerException.prototype); this.Message = opts.Message; } } /** * The resource specified in the request was not found. Correct the request before you try again. * @public */ export class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; readonly $fault: "client" = "client"; /** * Description of the error. * @public */ Message: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) { super({ name: "ResourceNotFoundException", $fault: "client", ...opts, }); Object.setPrototypeOf(this, ResourceNotFoundException.prototype); this.Message = opts.Message; } } /** * The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again. * @public */ export class ServiceQuotaExceededException extends __BaseException { readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; readonly $fault: "client" = "client"; /** * Description of the error. * @public */ Message: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) { super({ name: "ServiceQuotaExceededException", $fault: "client", ...opts, }); Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype); this.Message = opts.Message; } } /** * The request was denied due to request throttling. Retry the request after the suggested wait time. * @public */ export class ThrottlingException extends __BaseException { readonly name: "ThrottlingException" = "ThrottlingException"; readonly $fault: "client" = "client"; $retryable = { throttling: true, }; /** * Description of the error. * @public */ Message: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>) { super({ name: "ThrottlingException", $fault: "client", ...opts, }); Object.setPrototypeOf(this, ThrottlingException.prototype); this.Message = opts.Message; } } /** * One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before * retrying the request. * @public */ export class ValidationException extends __BaseException { readonly name: "ValidationException" = "ValidationException"; readonly $fault: "client" = "client"; /** * Description of the error. * @public */ Message: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>) { super({ name: "ValidationException", $fault: "client", ...opts, }); Object.setPrototypeOf(this, ValidationException.prototype); this.Message = opts.Message; } } /** * @public * @enum */ export const ApplicationStatus = { DELETING: "DELETING", ERROR: "ERROR", INITIALIZED: "INITIALIZED", PROCESSING: "PROCESSING", READY: "READY", } as const; /** * @public */ export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus]; /** * @public * @enum */ export const ApplicationStatusReason = { ACCESS_DENIED: "accessDenied", INTERNAL_ERROR: "internalError", } as const; /** * @public */ export type ApplicationStatusReason = (typeof ApplicationStatusReason)[keyof typeof ApplicationStatusReason]; /** * 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. * @public */ export class ConflictException extends __BaseException { readonly name: "ConflictException" = "ConflictException"; readonly $fault: "client" = "client"; /** * Description of the error. * @public */ Message: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>) { super({ name: "ConflictException", $fault: "client", ...opts, }); Object.setPrototypeOf(this, ConflictException.prototype); this.Message = opts.Message; } } /** * @public * @enum */ export const RuntimeEnvironmentType = { PROTON: "PROTON", UBUNTU: "UBUNTU", WINDOWS: "WINDOWS", } as const; /** * @public */ export type RuntimeEnvironmentType = (typeof RuntimeEnvironmentType)[keyof typeof RuntimeEnvironmentType]; /** * Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and * other drivers. * A runtime environment can be one of the following: * <ul> * <li> * * For Linux applications * * <ul> * <li> * * Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>) * * </li> * </ul> * </li> * <li> * * For Windows applications * * <ul> * <li> * Microsoft Windows Server 2022 Base (<code>Type=WINDOWS, Version=2022</code>) * </li> * <li> * Proton 8.0-5 (<code>Type=PROTON, Version=20241007</code>) * </li> * <li> * Proton 8.0-2c (<code>Type=PROTON, Version=20230704</code>) * </li> * </ul> * </li> * </ul> * @public */ export interface RuntimeEnvironment { /** * The operating system and other drivers. For Proton, this also includes the Proton compatibility layer. * @public */ Type: RuntimeEnvironmentType | undefined; /** * Versioned container environment for the application operating system. * @public */ Version: string | undefined; } /** * @public */ export interface CreateApplicationInput { /** * A human-readable label for the application. You can update this value later. * @public */ Description: string | undefined; /** * Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and * other drivers. * A runtime environment can be one of the following: * <ul> * <li> * * For Linux applications * * <ul> * <li> * * Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>) * * </li> * </ul> * </li> * <li> * * For Windows applications * * <ul> * <li> * Microsoft Windows Server 2022 Base (<code>Type=WINDOWS, Version=2022</code>) * </li> * <li> * Proton 8.0-5 (<code>Type=PROTON, Version=20241007</code>) * </li> * <li> * Proton 8.0-2c (<code>Type=PROTON, Version=20230704</code>) * </li> * </ul> * </li> * </ul> * @public */ RuntimeEnvironment: RuntimeEnvironment | undefined; /** * The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the * location set in <code>ApplicationSourceUri</code>. * @public */ ExecutablePath: string | undefined; /** * The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The * location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything * under the specified location. * This value is immutable. To designate a different content location, create a new application. * <note> * The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region. * </note> * @public */ ApplicationSourceUri: string | undefined; /** * Locations of log files that your content generates during a stream session. Enter path * values that are relative to the <code>ApplicationSourceUri</code> location. * You can specify up to 10 log paths. * Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code> * at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> * and get the <code>LogFileLocationUri</code>. * @public */ ApplicationLogPaths?: string[] | undefined; /** * An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more <code>ApplicationLogPaths</code>. * <note> * The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide. * </note> * @public */ ApplicationLogOutputUri?: string | undefined; /** * A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is * useful for resource management, access management and cost allocation. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the Amazon Web Services General Reference. You can * use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TagResource.html">TagResource</a> to add tags, <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html">UntagResource</a> to remove tags, and <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to view tags on existing resources. * @public */ Tags?: Record<string, string> | undefined; /** * * A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. * * @public */ ClientToken?: string | undefined; } /** * @public * @enum */ export const ReplicationStatusType = { COMPLETED: "COMPLETED", REPLICATING: "REPLICATING", } as const; /** * @public */ export type ReplicationStatusType = (typeof ReplicationStatusType)[keyof typeof ReplicationStatusType]; /** * Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has * finished replicating there. * @public */ export interface ReplicationStatus { /** * * A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ Location?: string | undefined; /** * The current status of the replication process. * @public */ Status?: ReplicationStatusType | undefined; } /** * @public */ export interface CreateApplicationOutput { /** * An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is * <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>. * @public */ Arn: string | undefined; /** * A human-readable label for the application. You can edit this value. * @public */ Description?: string | undefined; /** * Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and * other drivers. * A runtime environment can be one of the following: * <ul> * <li> * * For Linux applications * * <ul> * <li> * * Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>) * * </li> * </ul> * </li> * <li> * * For Windows applications * * <ul> * <li> * Microsoft Windows Server 2022 Base (<code>Type=WINDOWS, Version=2022</code>) * </li> * <li> * Proton 8.0-5 (<code>Type=PROTON, Version=20241007</code>) * </li> * <li> * Proton 8.0-2c (<code>Type=PROTON, Version=20230704</code>) * </li> * </ul> * </li> * </ul> * @public */ RuntimeEnvironment?: RuntimeEnvironment | undefined; /** * The path and file name of the executable file that launches the content for streaming. * @public */ ExecutablePath?: string | undefined; /** * Locations of log files that your content generates during a stream session. * Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code> * at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> * and get the <code>LogFileLocationUri</code>. * @public */ ApplicationLogPaths?: string[] | undefined; /** * An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more <code>ApplicationLogPaths</code>. * @public */ ApplicationLogOutputUri?: string | undefined; /** * The original Amazon S3 location of uploaded stream content for the application. * @public */ ApplicationSourceUri?: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ Id?: string | undefined; /** * The current status of the application resource. Possible statuses include the following: * <ul> * <li> * * <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * </li> * <li> * * <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future * deployment in a stream group. * </li> * <li> * * <code>READY</code>: The application is ready to deploy in a stream group. * </li> * <li> * * <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information. * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application. * </li> * </ul> * @public */ Status?: ApplicationStatus | undefined; /** * A short description of the status reason when the application is in <code>ERROR</code> status. * @public */ StatusReason?: ApplicationStatusReason | undefined; /** * A set of replication statuses for each location. * @public */ ReplicationStatuses?: ReplicationStatus[] | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A newly created application is not associated to any stream groups. This value is empty. * @public */ AssociatedStreamGroups?: string[] | undefined; } /** * @public */ export interface DeleteApplicationInput { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ Identifier: string | undefined; } /** * @public */ export interface GetApplicationInput { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ Identifier: string | undefined; } /** * @public */ export interface GetApplicationOutput { /** * An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is * <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>. * @public */ Arn: string | undefined; /** * A human-readable label for the application. You can edit this value. * @public */ Description?: string | undefined; /** * Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and * other drivers. * A runtime environment can be one of the following: * <ul> * <li> * * For Linux applications * * <ul> * <li> * * Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>) * * </li> * </ul> * </li> * <li> * * For Windows applications * * <ul> * <li> * Microsoft Windows Server 2022 Base (<code>Type=WINDOWS, Version=2022</code>) * </li> * <li> * Proton 8.0-5 (<code>Type=PROTON, Version=20241007</code>) * </li> * <li> * Proton 8.0-2c (<code>Type=PROTON, Version=20230704</code>) * </li> * </ul> * </li> * </ul> * @public */ RuntimeEnvironment?: RuntimeEnvironment | undefined; /** * The path and file name of the executable file that launches the content for streaming. * @public */ ExecutablePath?: string | undefined; /** * Locations of log files that your content generates during a stream session. * Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code> * at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> * and get the <code>LogFileLocationUri</code>. * @public */ ApplicationLogPaths?: string[] | undefined; /** * An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more <code>ApplicationLogPaths</code>. * @public */ ApplicationLogOutputUri?: string | undefined; /** * The original Amazon S3 location of uploaded stream content for the application. * @public */ ApplicationSourceUri?: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ Id?: string | undefined; /** * The current status of the application resource. Possible statuses include the following: * <ul> * <li> * * <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * </li> * <li> * * <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future * deployment in a stream group. * </li> * <li> * * <code>READY</code>: The application is ready to deploy in a stream group. * </li> * <li> * * <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information. * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application. * </li> * </ul> * @public */ Status?: ApplicationStatus | undefined; /** * A short description of the status reason when the application is in <code>ERROR</code> status. * @public */ StatusReason?: ApplicationStatusReason | undefined; /** * A set of replication statuses for each location. * @public */ ReplicationStatuses?: ReplicationStatus[] | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application. * This value is a * set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify stream group resources. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code>. * * @public */ AssociatedStreamGroups?: string[] | undefined; } /** * @public */ export interface ListApplicationsInput { /** * The * token that marks the start of the next set of results. Use this token when you * retrieve results as sequential pages. To get the first page of results, omit a token * value. To get the remaining pages, provide the token returned with the previous result * set. * * @public */ NextToken?: string | undefined; /** * The number of results to return. Use this parameter with <code>NextToken</code> to return results in sequential pages. Default value is * <code>25</code>. * @public */ MaxResults?: number | undefined; } /** * Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application * details, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetApplication.html">GetApplication</a>. * @public */ export interface ApplicationSummary { /** * An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is * <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>. * @public */ Arn: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ Id?: string | undefined; /** * A human-readable label for the application. You can edit this value. * @public */ Description?: string | undefined; /** * The current status of the application resource. Possible statuses include the following: * <ul> * <li> * * <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * </li> * <li> * * <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future * deployment in a stream group. * </li> * <li> * * <code>READY</code>: The application is ready to deploy in a stream group. * </li> * <li> * * <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information. * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application. * </li> * </ul> * @public */ Status?: ApplicationStatus | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and * other drivers. * A runtime environment can be one of the following: * <ul> * <li> * * For Linux applications * * <ul> * <li> * * Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>) * * </li> * </ul> * </li> * <li> * * For Windows applications * * <ul> * <li> * Microsoft Windows Server 2022 Base (<code>Type=WINDOWS, Version=2022</code>) * </li> * <li> * Proton 8.0-5 (<code>Type=PROTON, Version=20241007</code>) * </li> * <li> * Proton 8.0-2c (<code>Type=PROTON, Version=20230704</code>) * </li> * </ul> * </li> * </ul> * @public */ RuntimeEnvironment?: RuntimeEnvironment | undefined; } /** * @public */ export interface ListApplicationsOutput { /** * A collection of Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. Each item includes application metadata and * status. * @public */ Items?: ApplicationSummary[] | undefined; /** * A * token that marks the start of the next sequential page of results. If an operation * doesn't return a token, you've reached the end of the list. * * @public */ NextToken?: string | undefined; } /** * @public */ export interface UpdateApplicationInput { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ Identifier: string | undefined; /** * A human-readable label for the application. * @public */ Description?: string | undefined; /** * Locations of log files that your content generates during a stream session. Enter path * values that are relative to the <code>ApplicationSourceUri</code> location. * You can specify up to 10 log paths. * Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code> * at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> * and get the <code>LogFileLocationUri</code>. * @public */ ApplicationLogPaths?: string[] | undefined; /** * An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more <code>ApplicationLogPaths</code>. * <note> * The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide. * </note> * @public */ ApplicationLogOutputUri?: string | undefined; } /** * @public */ export interface UpdateApplicationOutput { /** * An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is * <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>. * @public */ Arn: string | undefined; /** * A human-readable label for the application. You can edit this value. * @public */ Description?: string | undefined; /** * Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and * other drivers. * A runtime environment can be one of the following: * <ul> * <li> * * For Linux applications * * <ul> * <li> * * Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>) * * </li> * </ul> * </li> * <li> * * For Windows applications * * <ul> * <li> * Microsoft Windows Server 2022 Base (<code>Type=WINDOWS, Version=2022</code>) * </li> * <li> * Proton 8.0-5 (<code>Type=PROTON, Version=20241007</code>) * </li> * <li> * Proton 8.0-2c (<code>Type=PROTON, Version=20230704</code>) * </li> * </ul> * </li> * </ul> * @public */ RuntimeEnvironment?: RuntimeEnvironment | undefined; /** * The path and file name of the executable file that launches the content for streaming. * @public */ ExecutablePath?: string | undefined; /** * Locations of log files that your content generates during a stream session. * Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code> * at the end of a stream session. To retrieve stored log files, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a> * and get the <code>LogFileLocationUri</code>. * @public */ ApplicationLogPaths?: string[] | undefined; /** * An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more <code>ApplicationLogPaths</code>. * @public */ ApplicationLogOutputUri?: string | undefined; /** * The original Amazon S3 location of uploaded stream content for the application. * @public */ ApplicationSourceUri?: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ Id?: string | undefined; /** * The current status of the application resource. Possible statuses include the following: * <ul> * <li> * * <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. * </li> * <li> * * <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future * deployment in a stream group. * </li> * <li> * * <code>READY</code>: The application is ready to deploy in a stream group. * </li> * <li> * * <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information. * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application. * </li> * </ul> * @public */ Status?: ApplicationStatus | undefined; /** * A short description of the status reason when the application is in <code>ERROR</code> status. * @public */ StatusReason?: ApplicationStatusReason | undefined; /** * A set of replication statuses for each location. * @public */ ReplicationStatuses?: ReplicationStatus[] | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application. * This value is a * set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify stream group resources. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code>. * * @public */ AssociatedStreamGroups?: string[] | undefined; } /** * @public */ export interface AssociateApplicationsInput { /** * A stream group to associate to the applications. * This value is a * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * A set of applications to associate with the stream group. * This value is a * set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARN)</a> or IDs that uniquely identify application resources. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ ApplicationIdentifiers: string[] | undefined; } /** * @public */ export interface AssociateApplicationsOutput { /** * A stream group that is associated to the applications. * This value is a * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Arn?: string | undefined; /** * A set of applications that are associated to the stream group. * This value is a * set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARN)</a> or IDs that uniquely identify application resources. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ ApplicationArns?: string[] | undefined; } /** * @public * @enum */ export const StreamClass = { gen4n_high: "gen4n_high", gen4n_ultra: "gen4n_ultra", gen4n_win2022: "gen4n_win2022", gen5n_high: "gen5n_high", gen5n_ultra: "gen5n_ultra", gen5n_win2022: "gen5n_win2022", } as const; /** * @public */ export type StreamClass = (typeof StreamClass)[keyof typeof StreamClass]; /** * @public */ export interface CreateStreamGroupInput { /** * A descriptive label for the stream group. * @public */ Description: string | undefined; /** * The target stream quality for sessions that are hosted in this stream group. Set a stream class that is appropriate to the type of * content that you're streaming. Stream class determines the type of computing resources Amazon GameLift Streams uses and impacts the cost of streaming. The * following options are available: * A stream class can be one of the following: * <ul> * <li> * * * <code>gen5n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen5n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen5n_ultra</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. * Uses dedicated NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen4n_ultra</code> (NVIDIA, ultra) Supports applications with high 3D scene complexity. * Uses dedicated NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * </ul> * @public */ StreamClass: StreamClass | undefined; /** * The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The * application must be in <code>READY</code> status. By setting the default application identifier, you will optimize startup performance of * this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that * are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, * before you can start streaming. * @public */ DefaultApplicationIdentifier?: string | undefined; /** * * A set of one or more locations and the streaming capacity for each location. * * @public */ LocationConfigurations?: LocationConfiguration[] | undefined; /** * A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is * useful for resource management, access management and cost allocation. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the Amazon Web Services General Reference. You can * use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TagResource.html">TagResource</a> to add tags, <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html">UntagResource</a> to remove tags, and <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to view tags on existing resources. * @public */ Tags?: Record<string, string> | undefined; /** * * A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. * * @public */ ClientToken?: string | undefined; } /** * Represents the default Amazon GameLift Streams application that a stream group hosts. * @public */ export interface DefaultApplication { /** * An ID that uniquely identifies the application resource. For example: <code>a-9ZY8X7Wv6</code>. * @public */ Id?: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the application resource. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code>. * * @public */ Arn?: string | undefined; } /** * @public * @enum */ export const StreamGroupStatus = { ACTIVATING: "ACTIVATING", ACTIVE: "ACTIVE", ACTIVE_WITH_ERRORS: "ACTIVE_WITH_ERRORS", DELETING: "DELETING", ERROR: "ERROR", UPDATING_LOCATIONS: "UPDATING_LOCATIONS", } as const; /** * @public */ export type StreamGroupStatus = (typeof StreamGroupStatus)[keyof typeof StreamGroupStatus]; /** * @public * @enum */ export const StreamGroupStatusReason = { INTERNAL_ERROR: "internalError", NO_AVAILABLE_INSTANCES: "noAvailableInstances", } as const; /** * @public */ export type StreamGroupStatusReason = (typeof StreamGroupStatusReason)[keyof typeof StreamGroupStatusReason]; /** * @public */ export interface CreateStreamGroupOutput { /** * An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is * <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]</code>. * @public */ Arn: string | undefined; /** * A descriptive label for the stream group. * @public */ Description?: string | undefined; /** * The default Amazon GameLift Streams application that is associated with this stream group. * @public */ DefaultApplication?: DefaultApplication | undefined; /** * This value is the * set of locations, including their name, current status, and capacities. * * * A location can be in one of the following states: * * <ul> * <li> * * ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * * </li> * <li> * * ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * * </li> * <li> * * ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * * </li> * <li> * * REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * * </li> * </ul> * @public */ LocationStates?: LocationState[] | undefined; /** * The target stream quality for the stream group. * A stream class can be one of the following: * <ul> * <li> * * * <code>gen5n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen5n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen5n_ultra</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. * Uses dedicated NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen4n_ultra</code> (NVIDIA, ultra) Supports applications with high 3D scene complexity. * Uses dedicated NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * </ul> * @public */ StreamClass?: StreamClass | undefined; /** * A unique ID value that is assigned to the resource when it's created. Format example: <code>sg-1AB2C3De4</code>. * @public */ Id?: string | undefined; /** * The current status of the stream group resource. Possible statuses include the * following: * <ul> * <li> * * <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host * streams. * * </li> * <li> * * <code>ACTIVE</code>: The stream group is ready to host streams. * * </li> * <li> * * <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * * </li> * <li> * * <code>ERROR</code>: An error occurred when the stream group deployed. See * <code>StatusReason</code> for more information. * * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream * group. * * </li> * <li> * * <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). * * </li> * </ul> * @public */ Status?: StreamGroupStatus | undefined; /** * A short description of the reason that the stream group is in <code>ERROR</code> status. The possible reasons can be one of the * following: * <ul> * <li> * * <code>internalError</code>: The request can't process right now bcause of an issue with the server. Try again later. Reach out to * the Amazon GameLift Streams team for more help. * </li> * <li> * * <code>noAvailableInstances</code>: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. * Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different * stream class or in another region. * </li> * </ul> * @public */ StatusReason?: StreamGroupStatusReason | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group. * This value is a * set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify application resources. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code>. * * @public */ AssociatedApplications?: string[] | undefined; } /** * @public */ export interface CreateStreamSessionConnectionInput { /** * * A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. * * @public */ ClientToken?: string | undefined; /** * * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * The stream group that you want to run this stream session with. The stream group must be in <code>ACTIVE</code> status and have idle * stream capacity. * @public */ Identifier: string | undefined; /** * * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream session resource. Format example: <code>1AB2C3De4</code>. * The stream session must be in <code>PENDING_CLIENT_RECONNECTION</code> or <code>ACTIVE</code> status. * @public */ StreamSessionIdentifier: string | undefined; /** * A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a * text value in quotes. The offer must be newly generated, not the same offer provided to <code>StartStreamSession</code>. * @public */ SignalRequest: string | undefined; } /** * @public */ export interface CreateStreamSessionConnectionOutput { /** * The WebRTC answer string that the stream server generates in response to the <code>SignalRequest</code>. * @public */ SignalResponse?: string | undefined; } /** * @public */ export interface DeleteStreamGroupInput { /** * The unique ID value of the stream group resource to delete. Format example: <code>sg-1AB2C3De4</code>. * @public */ Identifier: string | undefined; } /** * @public */ export interface DisassociateApplicationsInput { /** * A stream group to disassociate these applications from. * This value is an * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * A set of applications that you want to disassociate from the stream group. * This value is a * set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARN)</a> or IDs that uniquely identify application resources. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ ApplicationIdentifiers: string[] | undefined; } /** * @public */ export interface DisassociateApplicationsOutput { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Arn?: string | undefined; /** * A set of applications that are disassociated from this stream group. * This value is a * set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARN)</a> or IDs that uniquely identify application resources. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ ApplicationArns?: string[] | undefined; } /** * @public * @enum */ export const ExportFilesStatus = { FAILED: "FAILED", PENDING: "PENDING", SUCCEEDED: "SUCCEEDED", } as const; /** * @public */ export type ExportFilesStatus = (typeof ExportFilesStatus)[keyof typeof ExportFilesStatus]; /** * Provides * details about the stream session's exported files. * * @public */ export interface ExportFilesMetadata { /** * The result of the <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ExportStreamSessionFiles.html">ExportStreamSessionFiles</a> * operation. * @public */ Status?: ExportFilesStatus | undefined; /** * A short description of the reason the export is in <code>FAILED</code> status. * @public */ StatusReason?: string | undefined; /** * The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name * based on the stream session metadata. Alternatively, you can provide a custom file name with a <code>.zip</code> file extension. * Example 1: If you provide an S3 URI called <code>s3://MyBucket/MyGame_Session1.zip</code>, then Amazon GameLift Streams will save the files at that * location. * Example 2: If you provide an S3 URI called <code>s3://MyBucket/MyGameSessions_ExportedFiles/</code>, then Amazon GameLift Streams will save the files * at <code>s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip</code> or another similar name. * @public */ OutputUri?: string | undefined; } /** * @public */ export interface ExportStreamSessionFilesInput { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Format example: <code>1AB2C3De4</code>. * * @public */ StreamSessionIdentifier: string | undefined; /** * The S3 bucket URI where Amazon GameLift Streams uploads the set of compressed exported files for this stream session. Amazon GameLift Streams generates a ZIP file name * based on the stream session metadata. Alternatively, you can provide a custom file name with a <code>.zip</code> file extension. * Example 1: If you provide an S3 URI called <code>s3://MyBucket/MyGame_Session1.zip</code>, then Amazon GameLift Streams will save the files at that * location. * Example 2: If you provide an S3 URI called <code>s3://MyBucket/MyGameSessions_ExportedFiles/</code>, then Amazon GameLift Streams will save the files * at <code>s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip</code> or another similar name. * @public */ OutputUri: string | undefined; } /** * @public */ export interface ExportStreamSessionFilesOutput {} /** * @public */ export interface GetStreamSessionInput { /** * The stream group that runs this stream session. * This value is an * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream session resource. Format example: <code>1AB2C3De4</code>. * * @public */ StreamSessionIdentifier: string | undefined; } /** * @public * @enum */ export const Protocol = { WEBRTC: "WebRTC", } as const; /** * @public */ export type Protocol = (typeof Protocol)[keyof typeof Protocol]; /** * @public * @enum */ export const StreamSessionStatus = { ACTIVATING: "ACTIVATING", ACTIVE: "ACTIVE", CONNECTED: "CONNECTED", ERROR: "ERROR", PENDING_CLIENT_RECONNECTION: "PENDING_CLIENT_RECONNECTION", RECONNECTING: "RECONNECTING", TERMINATED: "TERMINATED", TERMINATING: "TERMINATING", } as const; /** * @public */ export type StreamSessionStatus = (typeof StreamSessionStatus)[keyof typeof StreamSessionStatus]; /** * @public * @enum */ export const StreamSessionStatusReason = { APP_LOG_S3_DESTINATION_ERROR: "applicationLogS3DestinationError", INTERNAL_ERROR: "internalError", INVALID_SIGNAL_REQUEST: "invalidSignalRequest", PLACEMENT_TIMEOUT: "placementTimeout", } as const; /** * @public */ export type StreamSessionStatusReason = (typeof StreamSessionStatusReason)[keyof typeof StreamSessionStatusReason]; /** * @public */ export interface GetStreamSessionOutput { /** * The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group ARN, this value uniquely identifies it across all * Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource ID]</code>. * @public */ Arn?: string | undefined; /** * A human-readable label for the stream session. You can update this value at any time. * @public */ Description?: string | undefined; /** * The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. * @public */ StreamGroupId?: string | undefined; /** * * An opaque, unique identifier for an end-user, defined by the developer. * * @public */ UserId?: string | undefined; /** * The current status of the stream session. A stream session can host clients when in <code>ACTIVE</code> status. * @public */ Status?: StreamSessionStatus | undefined; /** * A short description of the reason the stream session is in <code>ERROR</code> status. * @public */ StatusReason?: StreamSessionStatusReason | undefined; /** * The data transfer protocol in use with the stream session. * @public */ Protocol?: Protocol | undefined; /** * The location where Amazon GameLift Streams is hosting the stream session. * * A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ Location?: string | undefined; /** * The WebRTC ICE offer string that a client generates to initiate a connection to the stream session. * @public */ SignalRequest?: string | undefined; /** * The WebRTC answer string that the stream server generates in response to the <code>SignalRequest</code>. * @public */ SignalResponse?: string | undefined; /** * The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session * regardless of any existing client connections. * @public */ ConnectionTimeoutSeconds?: number | undefined; /** * The length of time that Amazon GameLift Streams keeps the game session open. * @public */ SessionLengthSeconds?: number | undefined; /** * A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. * * <code>AdditionalEnvironmentVariables</code> and <code>AdditionalLaunchArgs</code> have similar purposes. * <code>AdditionalEnvironmentVariables</code> passes data using environment variables; while * <code>AdditionalLaunchArgs</code> passes data using command-line arguments. * @public */ AdditionalLaunchArgs?: string[] | undefined; /** * A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. * You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. * <note> * If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. * For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. * </note> * * <code>AdditionalEnvironmentVariables</code> and <code>AdditionalLaunchArgs</code> have similar purposes. * <code>AdditionalEnvironmentVariables</code> passes data using environment variables; while * <code>AdditionalLaunchArgs</code> passes data using command-line arguments. * @public */ AdditionalEnvironmentVariables?: Record<string, string> | undefined; /** * Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage * location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload. * @public */ LogFileLocationUri?: string | undefined; /** * The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client. * @public */ WebSdkProtocolUrl?: string | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * The application streaming in this session. * This value is an * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the application resource. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code>. * * @public */ ApplicationArn?: string | undefined; /** * Provides * details about the stream session's exported files. * * @public */ ExportFilesMetadata?: ExportFilesMetadata | undefined; } /** * @public */ export interface ListStreamSessionsInput { /** * Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that * status. * @public */ Status?: StreamSessionStatus | undefined; /** * Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that * exported files status. * * Exported files can be in one of the following states: * * <ul> * <li> * * SUCCEEDED: The exported files are successfully stored in S3 bucket. * * </li> * <li> * * FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3. * * </li> * <li> * * PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress. * * </li> * </ul> * @public */ ExportFilesStatus?: ExportFilesStatus | undefined; /** * The * token that marks the start of the next set of results. Use this token when you * retrieve results as sequential pages. To get the first page of results, omit a token * value. To get the remaining pages, provide the token returned with the previous result * set. * * @public */ NextToken?: string | undefined; /** * The * number of results to return. Use this parameter with <code>NextToken</code> to * return results in sequential pages. Default value is <code>25</code>. * * @public */ MaxResults?: number | undefined; /** * The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the * Amazon Resource Name (ARN). * @public */ Identifier: string | undefined; } /** * Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a>. * @public */ export interface StreamSessionSummary { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream session resource. Format example: <code>1AB2C3De4</code>. * . * @public */ Arn?: string | undefined; /** * * An opaque, unique identifier for an end-user, defined by the developer. * * @public */ UserId?: string | undefined; /** * The current status of the stream session resource. Possible statuses include the following: * <ul> * <li> * * <code>ACTIVATING</code>: The stream session is starting and preparing to stream. * </li> * <li> * * <code>ACTIVE</code>: The stream session is ready to accept client connections. * </li> * <li> * * <code>CONNECTED</code>: The stream session has a connected client. * </li> * <li> * * <code>PENDING_CLIENT_RECONNECTION</code>: A client has recently disconnected, and the stream session is waiting for the client * to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to * <code>TERMINATED</code>. * </li> * <li> * * <code>TERMINATING</code>: The stream session is ending. * </li> * <li> * * <code>TERMINATED</code>: The stream session has ended. * </li> * <li> * * <code>ERROR</code>: The stream session failed to activate. * </li> * </ul> * @public */ Status?: StreamSessionStatus | undefined; /** * The data transfer protocol in use with the stream session. * @public */ Protocol?: Protocol | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ ApplicationArn?: string | undefined; /** * Provides * details about the stream session's exported files. * * @public */ ExportFilesMetadata?: ExportFilesMetadata | undefined; /** * The location where Amazon GameLift Streams is hosting the stream session. * * A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ Location?: string | undefined; } /** * @public */ export interface ListStreamSessionsOutput { /** * A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item * includes stream session metadata and status. * @public */ Items?: StreamSessionSummary[] | undefined; /** * A * token that marks the start of the next sequential page of results. If an operation * doesn't return a token, you've reached the end of the list. * * @public */ NextToken?: string | undefined; } /** * @public */ export interface ListStreamSessionsByAccountInput { /** * Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that * status. * @public */ Status?: StreamSessionStatus | undefined; /** * Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that * exported files status. * @public */ ExportFilesStatus?: ExportFilesStatus | undefined; /** * The * token that marks the start of the next set of results. Use this token when you * retrieve results as sequential pages. To get the first page of results, omit a token * value. To get the remaining pages, provide the token returned with the previous result * set. * * @public */ NextToken?: string | undefined; /** * The * number of results to return. Use this parameter with <code>NextToken</code> to * return results in sequential pages. Default value is <code>25</code>. * * @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListStreamSessionsByAccountOutput { /** * A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item * includes stream session metadata and status. * @public */ Items?: StreamSessionSummary[] | undefined; /** * A * token that marks the start of the next sequential page of results. If an operation * doesn't return a token, you've reached the end of the list. * * @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** * The (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> that you want to retrieve tags for. To get a * Amazon GameLift Streams resource ARN, call a List or Get operation for the resource. * @public */ ResourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** * A collection of tags that have been assigned to the specified resource. * @public */ Tags?: Record<string, string> | undefined; } /** * @public */ export interface RemoveStreamGroupLocationsInput { /** * A stream group to remove the specified locations from. * This value is a * Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * A set of locations to remove this stream group. * A set of location names. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ Locations: string[] | undefined; } /** * @public */ export interface StartStreamSessionInput { /** * * A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field. * * @public */ ClientToken?: string | undefined; /** * A human-readable label for the stream session. You can update this value later. * @public */ Description?: string | undefined; /** * The stream group to run this stream session with. * This value is an * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * The data transport protocol to use for the stream session. * @public */ Protocol: Protocol | undefined; /** * A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a * text value in quotes. * @public */ SignalRequest: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code> or ID-<code>a-9ZY8X7Wv6</code>. * * @public */ ApplicationIdentifier: string | undefined; /** * * An opaque, unique identifier for an end-user, defined by the developer. * * @public */ UserId?: string | undefined; /** * A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. Amazon GameLift Streams selects the location with the next * available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the * primary location. * This value is A set of location names. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ Locations?: string[] | undefined; /** * Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect to the stream session. This time span starts when the * stream session reaches <code>ACTIVE</code> status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status * of <code>TERMINATED</code>. Default value is 120. * @public */ ConnectionTimeoutSeconds?: number | undefined; /** * The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session * regardless of any existing client connections. Default value is 43200. * @public */ SessionLengthSeconds?: number | undefined; /** * A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. * * <code>AdditionalEnvironmentVariables</code> and <code>AdditionalLaunchArgs</code> have similar purposes. * <code>AdditionalEnvironmentVariables</code> passes data using environment variables; while * <code>AdditionalLaunchArgs</code> passes data using command-line arguments. * @public */ AdditionalLaunchArgs?: string[] | undefined; /** * A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. * You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. * <note> * If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. * For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. * </note> * * <code>AdditionalEnvironmentVariables</code> and <code>AdditionalLaunchArgs</code> have similar purposes. * <code>AdditionalEnvironmentVariables</code> passes data using environment variables; while * <code>AdditionalLaunchArgs</code> passes data using command-line arguments. * @public */ AdditionalEnvironmentVariables?: Record<string, string> | undefined; } /** * @public */ export interface StartStreamSessionOutput { /** * The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group ARN, this value uniquely identifies it across all * Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource ID]</code>. * @public */ Arn?: string | undefined; /** * A human-readable label for the stream session. You can update this value at any time. * @public */ Description?: string | undefined; /** * The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. * @public */ StreamGroupId?: string | undefined; /** * * An opaque, unique identifier for an end-user, defined by the developer. * * @public */ UserId?: string | undefined; /** * The current status of the stream session. A stream session can host clients when in <code>ACTIVE</code> status. * @public */ Status?: StreamSessionStatus | undefined; /** * A short description of the reason the stream session is in <code>ERROR</code> status. * @public */ StatusReason?: StreamSessionStatusReason | undefined; /** * The data transfer protocol in use with the stream session. * @public */ Protocol?: Protocol | undefined; /** * The location where Amazon GameLift Streams is streaming your application from. * * A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, refer to <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions and quotas</a> in the Amazon GameLift Streams Developer Guide. * * @public */ Location?: string | undefined; /** * The WebRTC ICE offer string that a client generates to initiate a connection to the stream session. * @public */ SignalRequest?: string | undefined; /** * The WebRTC answer string that the stream server generates in response to the <code>SignalRequest</code>. * @public */ SignalResponse?: string | undefined; /** * The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session * regardless of any existing client connections. * @public */ ConnectionTimeoutSeconds?: number | undefined; /** * The length of time that Amazon GameLift Streams keeps the game session open. * @public */ SessionLengthSeconds?: number | undefined; /** * A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client. * * <code>AdditionalEnvironmentVariables</code> and <code>AdditionalLaunchArgs</code> have similar purposes. * <code>AdditionalEnvironmentVariables</code> passes data using environment variables; while * <code>AdditionalLaunchArgs</code> passes data using command-line arguments. * @public */ AdditionalLaunchArgs?: string[] | undefined; /** * A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. * You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client. * <note> * If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. * For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide. * </note> * * <code>AdditionalEnvironmentVariables</code> and <code>AdditionalLaunchArgs</code> have similar purposes. * <code>AdditionalEnvironmentVariables</code> passes data using environment variables; while * <code>AdditionalLaunchArgs</code> passes data using command-line arguments. * @public */ AdditionalEnvironmentVariables?: Record<string, string> | undefined; /** * Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage * location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload. * @public */ LogFileLocationUri?: string | undefined; /** * The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client. * @public */ WebSdkProtocolUrl?: string | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the application resource. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code>. * * @public */ ApplicationArn?: string | undefined; /** * Provides * details about the stream session's exported files. * * @public */ ExportFilesMetadata?: ExportFilesMetadata | undefined; } /** * @public */ export interface GetStreamGroupInput { /** * The unique ID value of the stream group resource to retrieve. Format example: <code>sg-1AB2C3De4</code>. * @public */ Identifier: string | undefined; } /** * @public */ export interface GetStreamGroupOutput { /** * An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is * <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]</code>. * @public */ Arn: string | undefined; /** * A descriptive label for the stream group. * @public */ Description?: string | undefined; /** * The default Amazon GameLift Streams application that is associated with this stream group. * @public */ DefaultApplication?: DefaultApplication | undefined; /** * This value is the * set of locations, including their name, current status, and capacities. * * * A location can be in one of the following states: * * <ul> * <li> * * ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * * </li> * <li> * * ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * * </li> * <li> * * ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * * </li> * <li> * * REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * * </li> * </ul> * @public */ LocationStates?: LocationState[] | undefined; /** * The target stream quality for the stream group. * A stream class can be one of the following: * <ul> * <li> * * * <code>gen5n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen5n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen5n_ultra</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. * Uses dedicated NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen4n_ultra</code> (NVIDIA, ultra) Supports applications with high 3D scene complexity. * Uses dedicated NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * </ul> * @public */ StreamClass?: StreamClass | undefined; /** * A unique ID value that is assigned to the resource when it's created. Format example: <code>sg-1AB2C3De4</code>. * @public */ Id?: string | undefined; /** * The current status of the stream group resource. Possible statuses include the * following: * <ul> * <li> * * <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host * streams. * * </li> * <li> * * <code>ACTIVE</code>: The stream group is ready to host streams. * * </li> * <li> * * <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * * </li> * <li> * * <code>ERROR</code>: An error occurred when the stream group deployed. See * <code>StatusReason</code> for more information. * * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream * group. * * </li> * <li> * * <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). * * </li> * </ul> * @public */ Status?: StreamGroupStatus | undefined; /** * A short description of the reason that the stream group is in <code>ERROR</code> status. The possible reasons can be one of the * following: * <ul> * <li> * * <code>internalError</code>: The request can't process right now bcause of an issue with the server. Try again later. Reach out to * the Amazon GameLift Streams team for more help. * </li> * <li> * * <code>noAvailableInstances</code>: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. * Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different * stream class or in another region. * </li> * </ul> * @public */ StatusReason?: StreamGroupStatusReason | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group. * This value is a * set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify application resources. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code>. * * @public */ AssociatedApplications?: string[] | undefined; } /** * @public */ export interface ListStreamGroupsInput { /** * A * token that marks the start of the next set of results. Use this token when you * retrieve results as sequential pages. To get the first page of results, omit a token * value. To get the remaining pages, provide the token returned with the previous result * set. * * @public */ NextToken?: string | undefined; /** * The number of results to return. Use this parameter with <code>NextToken</code> to return results in sequential pages. Default value is * <code>25</code>. * @public */ MaxResults?: number | undefined; } /** * Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>. * @public */ export interface StreamGroupSummary { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Arn: string | undefined; /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Id?: string | undefined; /** * A descriptive label for the stream group. * @public */ Description?: string | undefined; /** * Object that identifies the Amazon GameLift Streams application to stream with this stream group. * @public */ DefaultApplication?: DefaultApplication | undefined; /** * The target stream quality for the stream group. * A stream class can be one of the following: * <ul> * <li> * * * <code>gen5n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen5n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen5n_ultra</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. * Uses dedicated NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen4n_ultra</code> (NVIDIA, ultra) Supports applications with high 3D scene complexity. * Uses dedicated NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * </ul> * @public */ StreamClass?: StreamClass | undefined; /** * The current status of the stream group resource. Possible statuses include the * following: * <ul> * <li> * * <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host * streams. * * </li> * <li> * * <code>ACTIVE</code>: The stream group is ready to host streams. * * </li> * <li> * * <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * * </li> * <li> * * <code>ERROR</code>: An error occurred when the stream group deployed. See * <code>StatusReason</code> for more information. * * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream * group. * * </li> * <li> * * <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). * * </li> * </ul> * @public */ Status?: StreamGroupStatus | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; } /** * @public */ export interface ListStreamGroupsOutput { /** * A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. Each item includes stream group metadata and * status, but doesn't include capacity information. * @public */ Items?: StreamGroupSummary[] | undefined; /** * A * token that marks the start of the next sequential page of results. If an operation * doesn't return a token, you've reached the end of the list. * * @public */ NextToken?: string | undefined; } /** * @public */ export interface UpdateStreamGroupInput { /** * An * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * @public */ Identifier: string | undefined; /** * * A set of one or more locations and the streaming capacity for each location. * * @public */ LocationConfigurations?: LocationConfiguration[] | undefined; /** * A descriptive label for the stream group. * @public */ Description?: string | undefined; } /** * @public */ export interface UpdateStreamGroupOutput { /** * An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is * <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]</code>. * @public */ Arn: string | undefined; /** * A descriptive label for the stream group. * @public */ Description?: string | undefined; /** * The default Amazon GameLift Streams application that is associated with this stream group. * @public */ DefaultApplication?: DefaultApplication | undefined; /** * This value is * set of locations, including their name, current status, and capacities. * * * A location can be in one of the following states: * * <ul> * <li> * * ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. * * </li> * <li> * * ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. * * </li> * <li> * * ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again. * * </li> * <li> * * REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group. * * </li> * </ul> * @public */ LocationStates?: LocationState[] | undefined; /** * The target stream quality for the stream group. * A stream class can be one of the following: * <ul> * <li> * * * <code>gen5n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen5n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen5n_ultra</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. * Uses dedicated NVIDIA A10G Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_win2022</code> (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * <li> * * * <code>gen4n_high</code> (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. * Uses NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM * </li> * <li> * Tenancy: Supports up to 2 concurrent stream sessions * </li> * </ul> * </li> * <li> * * * <code>gen4n_ultra</code> (NVIDIA, ultra) Supports applications with high 3D scene complexity. * Uses dedicated NVIDIA T4 Tensor GPU. * <ul> * <li> * Reference resolution: 1080p * </li> * <li> * Reference frame rate: 60 fps * </li> * <li> * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM * </li> * <li> * Tenancy: Supports 1 concurrent stream session * </li> * </ul> * </li> * </ul> * @public */ StreamClass?: StreamClass | undefined; /** * A unique ID value that is assigned to the resource when it's created. Format example: <code>sg-1AB2C3De4</code>. * @public */ Id?: string | undefined; /** * The current status of the stream group resource. Possible statuses include the * following: * <ul> * <li> * * <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host * streams. * * </li> * <li> * * <code>ACTIVE</code>: The stream group is ready to host streams. * * </li> * <li> * * <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. * * </li> * <li> * * <code>ERROR</code>: An error occurred when the stream group deployed. See * <code>StatusReason</code> for more information. * * </li> * <li> * * <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream * group. * * </li> * <li> * * <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). * * </li> * </ul> * @public */ Status?: StreamGroupStatus | undefined; /** * A short description of the reason that the stream group is in <code>ERROR</code> status. The possible reasons can be one of the * following: * <ul> * <li> * * <code>internalError</code>: The request can't process right now bcause of an issue with the server. Try again later. Reach out to * the Amazon GameLift Streams team for more help. * </li> * <li> * * <code>noAvailableInstances</code>: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. * Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different * stream class or in another region. * </li> * </ul> * @public */ StatusReason?: StreamGroupStatusReason | undefined; /** * A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ LastUpdatedAt?: Date | undefined; /** * A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). * @public */ CreatedAt?: Date | undefined; /** * A set of applications that this stream group is associated with. You can stream any of these applications with the stream group. * This value is a * set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify application resources. Format example: <code>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</code>. * * @public */ AssociatedApplications?: string[] | undefined; } /** * @public */ export interface TagResourceRequest { /** * The <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to apply * tags to. * @public */ ResourceArn: string | undefined; /** * A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams resource. * @public */ Tags: Record<string, string> | undefined; } /** * @public */ export interface TagResourceResponse {} /** * @public */ export interface TerminateStreamSessionInput { /** * * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Format example: ARN-<code>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</code> or ID-<code>sg-1AB2C3De4</code>. * * The stream group that runs this stream session. * @public */ Identifier: string | undefined; /** * * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream session resource. Format example: <code>1AB2C3De4</code>. * * @public */ StreamSessionIdentifier: string | undefined; } /** * @public */ export interface UntagResourceRequest { /** * The <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to remove * tags from. * @public */ ResourceArn: string | undefined; /** * A list of tag keys to remove from the specified Amazon GameLift Streams resource. * @public */ TagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse {} /** * @internal */ export const CreateStreamSessionConnectionInputFilterSensitiveLog = (obj: CreateStreamSessionConnectionInput): any => ({ ...obj, ...(obj.SignalRequest && { SignalRequest: SENSITIVE_STRING }), }); /** * @internal */ export const CreateStreamSessionConnectionOutputFilterSensitiveLog = ( obj: CreateStreamSessionConnectionOutput ): any => ({ ...obj, ...(obj.SignalResponse && { SignalResponse: SENSITIVE_STRING }), }); /** * @internal */ export const GetStreamSessionOutputFilterSensitiveLog = (obj: GetStreamSessionOutput): any => ({ ...obj, ...(obj.SignalRequest && { SignalRequest: SENSITIVE_STRING }), ...(obj.SignalResponse && { SignalResponse: SENSITIVE_STRING }), }); /** * @internal */ export const StartStreamSessionInputFilterSensitiveLog = (obj: StartStreamSessionInput): any => ({ ...obj, ...(obj.SignalRequest && { SignalRequest: SENSITIVE_STRING }), }); /** * @internal */ export const StartStreamSessionOutputFilterSensitiveLog = (obj: StartStreamSessionOutput): any => ({ ...obj, ...(obj.SignalRequest && { SignalRequest: SENSITIVE_STRING }), ...(obj.SignalResponse && { SignalResponse: SENSITIVE_STRING }), });

clients/client-gameliftstreams/src/models/models_0.ts (561 lines of code) (raw):