@aws-sdk/client-gameliftstreams 3.1097.0 → 3.1098.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -0
- package/dist-cjs/index.js +184 -4
- package/dist-es/GameLiftStreams.js +12 -0
- package/dist-es/commands/CreateStreamUrlCommand.js +4 -0
- package/dist-es/commands/GetStreamUrlCommand.js +4 -0
- package/dist-es/commands/ListApplicationShaderCachesCommand.js +4 -0
- package/dist-es/commands/ListStreamUrlsCommand.js +4 -0
- package/dist-es/commands/RevokeStreamUrlCommand.js +4 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/enums.js +27 -3
- package/dist-es/pagination/ListStreamUrlsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +107 -0
- package/dist-types/GameLiftStreams.d.ts +43 -0
- package/dist-types/GameLiftStreamsClient.d.ts +7 -2
- package/dist-types/commands/CreateStreamUrlCommand.d.ts +144 -0
- package/dist-types/commands/GetStreamUrlCommand.d.ts +135 -0
- package/dist-types/commands/ListApplicationShaderCachesCommand.d.ts +97 -0
- package/dist-types/commands/ListStreamUrlsCommand.d.ts +103 -0
- package/dist-types/commands/RevokeStreamUrlCommand.d.ts +86 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/enums.d.ts +64 -8
- package/dist-types/models/models_0.d.ts +520 -43
- package/dist-types/pagination/ListStreamUrlsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +16 -0
- package/dist-types/ts3.4/GameLiftStreams.d.ts +93 -0
- package/dist-types/ts3.4/GameLiftStreamsClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateStreamUrlCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetStreamUrlCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListApplicationShaderCachesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListStreamUrlsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/RevokeStreamUrlCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/enums.d.ts +33 -4
- package/dist-types/ts3.4/models/models_0.d.ts +122 -12
- package/dist-types/ts3.4/pagination/ListStreamUrlsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +16 -0
- package/package.json +6 -6
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ApplicationStatus, ApplicationStatusReason, ExportFilesStatus, Protocol, ReplicationStatusType, RuntimeEnvironmentType, StreamClass, StreamGroupLocationStatus, StreamGroupStatus, StreamGroupStatusReason, StreamSessionStatus, StreamSessionStatusReason } from "./enums";
|
|
1
|
+
import type { ApplicationStatus, ApplicationStatusReason, ExportFilesStatus, Protocol, ReplicationStatusType, RevocationMode, RuntimeEnvironmentType, ShaderCacheStatus, StreamClass, StreamGroupLocationStatus, StreamGroupStatus, StreamGroupStatusReason, StreamSessionStatus, StreamSessionStatusReason, StreamUrlStatus, StreamUrlStatusReason } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>Configuration for connecting a stream group location to resources in your Amazon VPC using AWS Transit Gateway. When you specify a VPC transit configuration, Amazon GameLift Streams creates a Transit Gateway and shares it with your account using AWS Resource Access Manager. After the stream group is active, you must complete the setup by accepting the resource share, creating a VPC attachment, and configuring routing.</p>
|
|
4
4
|
* @public
|
|
@@ -805,71 +805,241 @@ export interface CreateStreamSessionConnectionOutput {
|
|
|
805
805
|
SignalResponse?: string | undefined;
|
|
806
806
|
}
|
|
807
807
|
/**
|
|
808
|
+
* <p>Contains the width and height dimensions, in pixels, that define the resolution of the stream session's virtual monitor. The total number of pixels (width × height) must not exceed 2,073,600 (equivalent to 1920 × 1080).</p>
|
|
808
809
|
* @public
|
|
809
810
|
*/
|
|
810
|
-
export interface
|
|
811
|
+
export interface Resolution {
|
|
811
812
|
/**
|
|
812
|
-
* <p>
|
|
813
|
+
* <p>The width of the stream session's virtual monitor, in pixels. The value must be an even number.</p>
|
|
813
814
|
* @public
|
|
814
815
|
*/
|
|
815
|
-
|
|
816
|
+
Width: number | undefined;
|
|
817
|
+
/**
|
|
818
|
+
* <p>The height of the stream session's virtual monitor, in pixels. The value must be an even number.</p>
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
821
|
+
Height: number | undefined;
|
|
816
822
|
}
|
|
817
823
|
/**
|
|
824
|
+
* <p>The virtual monitor settings for a stream session, including the resolution. If not specified, the stream session uses the default resolution of 1920 × 1080.</p>
|
|
818
825
|
* @public
|
|
819
826
|
*/
|
|
820
|
-
export interface
|
|
827
|
+
export interface DisplayConfiguration {
|
|
821
828
|
/**
|
|
822
|
-
* <p>
|
|
829
|
+
* <p>The resolution to apply to the stream session's virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080.</p>
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
Resolution?: Resolution | undefined;
|
|
833
|
+
}
|
|
834
|
+
/**
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
export interface CreateStreamUrlInput {
|
|
838
|
+
/**
|
|
839
|
+
* <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p> <p>The stream session runs in this stream group.</p>
|
|
823
840
|
* @public
|
|
824
841
|
*/
|
|
825
842
|
Identifier: string | undefined;
|
|
826
843
|
/**
|
|
827
|
-
* <p>
|
|
844
|
+
* <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. Example ID: <code>a-9ZY8X7Wv6</code>. </p> <p>This application must be associated with the stream group.</p>
|
|
828
845
|
* @public
|
|
829
846
|
*/
|
|
830
|
-
|
|
847
|
+
ApplicationIdentifier: string | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* <p>The data transport protocol for the stream session. Amazon GameLift Streams supports <code>WebRTC</code>.</p>
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
Protocol: Protocol | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* <p>The number of minutes after creation that the stream URL remains valid. After this period, the status of the stream URL changes to <code>EXPIRED</code> and it can no longer start stream sessions. The minimum is 1 minute. For the maximum, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
UrlExpiresAfterMinutes: number | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* <p>The maximum number of times the stream URL can start a stream session. Each successful use reduces the remaining uses by one. The minimum is 1, and the default is 1. For the maximum, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html">Regions, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
UsageLimit?: number | undefined;
|
|
863
|
+
/**
|
|
864
|
+
* <p>A descriptive label for the stream URL.</p>
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
Description?: string | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* <p>A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its Amazon Web Services Region code, 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, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>. </p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
Locations: string[] | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* <p>The maximum length of time, in seconds, that a stream session started from this stream URL can run. Valid values are 1-86400 seconds (1 second to 24 hours). The default is 43200 seconds (12 hours).</p>
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
SessionLengthSeconds?: number | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* <p>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.</p> <p> <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.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
AdditionalLaunchArgs?: string[] | undefined;
|
|
883
|
+
/**
|
|
884
|
+
* <p>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.</p> <note> <p>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.</p> </note> <p> <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.</p>
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
AdditionalEnvironmentVariables?: Record<string, string> | undefined;
|
|
888
|
+
/**
|
|
889
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/session-credentials.html">Provide AWS credentials to your streaming application</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p>
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
RoleArn?: string | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* <p>The display settings, such as resolution, for stream sessions started from this stream URL.</p>
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
DisplayConfiguration?: DisplayConfiguration | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure this request is idempotent. If you retry a request with the same <code>ClientToken</code>, Amazon GameLift Streams returns the original response without performing the operation again.</p>
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
ClientToken?: string | undefined;
|
|
831
903
|
}
|
|
832
904
|
/**
|
|
833
905
|
* @public
|
|
834
906
|
*/
|
|
835
|
-
export interface
|
|
907
|
+
export interface CreateStreamUrlOutput {
|
|
836
908
|
/**
|
|
837
|
-
* <p>
|
|
909
|
+
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID]</code>.</p>
|
|
838
910
|
* @public
|
|
839
911
|
*/
|
|
840
|
-
Arn
|
|
912
|
+
Arn: string | undefined;
|
|
841
913
|
/**
|
|
842
|
-
* <p>
|
|
914
|
+
* <p>The unique identifier for the stream URL resource, for example <code>su-1AB2C3De4</code>.</p>
|
|
843
915
|
* @public
|
|
844
916
|
*/
|
|
845
|
-
|
|
917
|
+
StreamUrlId?: string | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* <p>The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.</p>
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
StreamUrl?: string | undefined;
|
|
923
|
+
/**
|
|
924
|
+
* <p>The current status of the stream URL. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVE</code>: The stream URL is valid and can start stream sessions.</p> </li> <li> <p> <code>EXPIRED</code>: The stream URL has passed its expiration time and can no longer start stream sessions.</p> </li> <li> <p> <code>REVOKED</code>: The stream URL was revoked and can no longer start stream sessions.</p> </li> <li> <p> <code>LIMIT_REACHED</code>: The stream URL has been used the maximum number of times and can no longer start stream sessions.</p> </li> </ul>
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
Status?: StreamUrlStatus | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* <p>Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is <code>REVOKED</code>. Possible values include the following:</p> <ul> <li> <p> <code>userRevoked</code>: You revoked the stream URL.</p> </li> <li> <p> <code>revokedAndTerminatingSessions</code>: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.</p> </li> <li> <p> <code>revokedAndSessionsTerminated</code>: You revoked the stream URL and its running stream sessions have ended.</p> </li> <li> <p> <code>streamGroupDeleted</code>: The stream group was deleted, which revoked the stream URL.</p> </li> <li> <p> <code>applicationDeleted</code>: The application was deleted, which revoked the stream URL.</p> </li> </ul>
|
|
930
|
+
* @public
|
|
931
|
+
*/
|
|
932
|
+
StatusReason?: StreamUrlStatusReason | undefined;
|
|
933
|
+
/**
|
|
934
|
+
* <p>The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).</p>
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
937
|
+
ExpiresAt?: Date | undefined;
|
|
938
|
+
/**
|
|
939
|
+
* <p>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).</p>
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
942
|
+
CreatedAt?: Date | undefined;
|
|
943
|
+
/**
|
|
944
|
+
* <p>The maximum number of times the stream URL can start a stream session.</p>
|
|
945
|
+
* @public
|
|
946
|
+
*/
|
|
947
|
+
UsageLimit?: number | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>The number of times the stream URL can still be used to start a stream session.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
RemainingUses?: number | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>The stream group that runs the stream sessions.</p> <p>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 stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. </p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
StreamGroupArn?: string | undefined;
|
|
958
|
+
/**
|
|
959
|
+
* <p>The application that runs in the stream sessions.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
960
|
+
* @public
|
|
961
|
+
*/
|
|
962
|
+
ApplicationArn?: string | undefined;
|
|
963
|
+
/**
|
|
964
|
+
* <p>The data transport protocol used for stream sessions started from this stream URL.</p>
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
Protocol?: Protocol | undefined;
|
|
968
|
+
/**
|
|
969
|
+
* <p>The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. 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, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>. </p>
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
Locations?: string[] | undefined;
|
|
973
|
+
/**
|
|
974
|
+
* <p>The maximum length of time, in seconds, that a stream session started from this stream URL can run.</p>
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
SessionLengthSeconds?: number | undefined;
|
|
978
|
+
/**
|
|
979
|
+
* <p>The descriptive label for the stream URL.</p>
|
|
980
|
+
* @public
|
|
981
|
+
*/
|
|
982
|
+
Description?: string | undefined;
|
|
983
|
+
/**
|
|
984
|
+
* <p>The command-line arguments passed to the application when a stream session starts.</p>
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
AdditionalLaunchArgs?: string[] | undefined;
|
|
988
|
+
/**
|
|
989
|
+
* <p>The environment variables made available to the application when a stream session starts.</p>
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
AdditionalEnvironmentVariables?: Record<string, string> | undefined;
|
|
993
|
+
/**
|
|
994
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/session-credentials.html">Provide AWS credentials to your streaming application</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p>
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
RoleArn?: string | undefined;
|
|
998
|
+
/**
|
|
999
|
+
* <p>The display settings, such as resolution, for stream sessions started from this stream URL.</p>
|
|
1000
|
+
* @public
|
|
1001
|
+
*/
|
|
1002
|
+
DisplayConfiguration?: DisplayConfiguration | undefined;
|
|
846
1003
|
}
|
|
847
1004
|
/**
|
|
848
|
-
* <p>Contains the width and height dimensions, in pixels, that define the resolution of the stream session's virtual monitor. The total number of pixels (width × height) must not exceed 2,073,600 (equivalent to 1920 × 1080).</p>
|
|
849
1005
|
* @public
|
|
850
1006
|
*/
|
|
851
|
-
export interface
|
|
1007
|
+
export interface DeleteStreamGroupInput {
|
|
852
1008
|
/**
|
|
853
|
-
* <p>
|
|
1009
|
+
* <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p>
|
|
854
1010
|
* @public
|
|
855
1011
|
*/
|
|
856
|
-
|
|
1012
|
+
Identifier: string | undefined;
|
|
1013
|
+
}
|
|
1014
|
+
/**
|
|
1015
|
+
* @public
|
|
1016
|
+
*/
|
|
1017
|
+
export interface DisassociateApplicationsInput {
|
|
857
1018
|
/**
|
|
858
|
-
* <p>
|
|
1019
|
+
* <p>A stream group to disassociate these applications from.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p>
|
|
859
1020
|
* @public
|
|
860
1021
|
*/
|
|
861
|
-
|
|
1022
|
+
Identifier: string | undefined;
|
|
1023
|
+
/**
|
|
1024
|
+
* <p>A set of applications that you want to disassociate from the stream group.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. Example ID: <code>a-9ZY8X7Wv6</code>. </p>
|
|
1025
|
+
* @public
|
|
1026
|
+
*/
|
|
1027
|
+
ApplicationIdentifiers: string[] | undefined;
|
|
862
1028
|
}
|
|
863
1029
|
/**
|
|
864
|
-
* <p>The virtual monitor settings for a stream session, including the resolution. If not specified, the stream session uses the default resolution of 1920 × 1080.</p>
|
|
865
1030
|
* @public
|
|
866
1031
|
*/
|
|
867
|
-
export interface
|
|
1032
|
+
export interface DisassociateApplicationsOutput {
|
|
868
1033
|
/**
|
|
869
|
-
* <p>
|
|
1034
|
+
* <p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. </p>
|
|
870
1035
|
* @public
|
|
871
1036
|
*/
|
|
872
|
-
|
|
1037
|
+
Arn?: string | undefined;
|
|
1038
|
+
/**
|
|
1039
|
+
* <p>A set of applications that are disassociated from this stream group.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
1040
|
+
* @public
|
|
1041
|
+
*/
|
|
1042
|
+
ApplicationArns?: string[] | undefined;
|
|
873
1043
|
}
|
|
874
1044
|
/**
|
|
875
1045
|
* <p>Provides details about the stream session's exported files. </p>
|
|
@@ -1066,32 +1236,17 @@ export interface GetStreamSessionOutput {
|
|
|
1066
1236
|
/**
|
|
1067
1237
|
* @public
|
|
1068
1238
|
*/
|
|
1069
|
-
export interface
|
|
1070
|
-
/**
|
|
1071
|
-
* <p>Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.</p>
|
|
1072
|
-
* @public
|
|
1073
|
-
*/
|
|
1074
|
-
Status?: StreamSessionStatus | undefined;
|
|
1239
|
+
export interface GetStreamUrlInput {
|
|
1075
1240
|
/**
|
|
1076
|
-
* <p>
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
ExportFilesStatus?: ExportFilesStatus | undefined;
|
|
1080
|
-
/**
|
|
1081
|
-
* <p>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. </p>
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
NextToken?: string | undefined;
|
|
1085
|
-
/**
|
|
1086
|
-
* <p>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>. </p>
|
|
1241
|
+
* <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p> <p>This is the stream group that owns the stream URL.</p>
|
|
1087
1242
|
* @public
|
|
1088
1243
|
*/
|
|
1089
|
-
|
|
1244
|
+
Identifier: string | undefined;
|
|
1090
1245
|
/**
|
|
1091
|
-
* <p>The unique identifier of
|
|
1246
|
+
* <p>The unique identifier of the stream URL. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4</code>. Example ID: <code>su-1AB2C3De4</code>.</p>
|
|
1092
1247
|
* @public
|
|
1093
1248
|
*/
|
|
1094
|
-
|
|
1249
|
+
StreamUrlIdentifier: string | undefined;
|
|
1095
1250
|
}
|
|
1096
1251
|
/**
|
|
1097
1252
|
* <p>Describes an 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>.</p>
|
|
@@ -1154,6 +1309,197 @@ export interface StreamSessionSummary {
|
|
|
1154
1309
|
*/
|
|
1155
1310
|
RoleArn?: string | undefined;
|
|
1156
1311
|
}
|
|
1312
|
+
/**
|
|
1313
|
+
* @public
|
|
1314
|
+
*/
|
|
1315
|
+
export interface GetStreamUrlOutput {
|
|
1316
|
+
/**
|
|
1317
|
+
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID]</code>.</p>
|
|
1318
|
+
* @public
|
|
1319
|
+
*/
|
|
1320
|
+
Arn: string | undefined;
|
|
1321
|
+
/**
|
|
1322
|
+
* <p>The unique identifier for the stream URL resource, for example <code>su-1AB2C3De4</code>.</p>
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
StreamUrlId?: string | undefined;
|
|
1326
|
+
/**
|
|
1327
|
+
* <p>The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.</p>
|
|
1328
|
+
* @public
|
|
1329
|
+
*/
|
|
1330
|
+
StreamUrl?: string | undefined;
|
|
1331
|
+
/**
|
|
1332
|
+
* <p>The current status of the stream URL. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVE</code>: The stream URL is valid and can start stream sessions.</p> </li> <li> <p> <code>EXPIRED</code>: The stream URL has passed its expiration time and can no longer start stream sessions.</p> </li> <li> <p> <code>REVOKED</code>: The stream URL was revoked and can no longer start stream sessions.</p> </li> <li> <p> <code>LIMIT_REACHED</code>: The stream URL has been used the maximum number of times and can no longer start stream sessions.</p> </li> </ul>
|
|
1333
|
+
* @public
|
|
1334
|
+
*/
|
|
1335
|
+
Status?: StreamUrlStatus | undefined;
|
|
1336
|
+
/**
|
|
1337
|
+
* <p>Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is <code>REVOKED</code>. Possible values include the following:</p> <ul> <li> <p> <code>userRevoked</code>: You revoked the stream URL.</p> </li> <li> <p> <code>revokedAndTerminatingSessions</code>: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.</p> </li> <li> <p> <code>revokedAndSessionsTerminated</code>: You revoked the stream URL and its running stream sessions have ended.</p> </li> <li> <p> <code>streamGroupDeleted</code>: The stream group was deleted, which revoked the stream URL.</p> </li> <li> <p> <code>applicationDeleted</code>: The application was deleted, which revoked the stream URL.</p> </li> </ul>
|
|
1338
|
+
* @public
|
|
1339
|
+
*/
|
|
1340
|
+
StatusReason?: StreamUrlStatusReason | undefined;
|
|
1341
|
+
/**
|
|
1342
|
+
* <p>The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).</p>
|
|
1343
|
+
* @public
|
|
1344
|
+
*/
|
|
1345
|
+
ExpiresAt?: Date | undefined;
|
|
1346
|
+
/**
|
|
1347
|
+
* <p>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).</p>
|
|
1348
|
+
* @public
|
|
1349
|
+
*/
|
|
1350
|
+
CreatedAt?: Date | undefined;
|
|
1351
|
+
/**
|
|
1352
|
+
* <p>The maximum number of times the stream URL can start a stream session.</p>
|
|
1353
|
+
* @public
|
|
1354
|
+
*/
|
|
1355
|
+
UsageLimit?: number | undefined;
|
|
1356
|
+
/**
|
|
1357
|
+
* <p>The number of times the stream URL can still be used to start a stream session.</p>
|
|
1358
|
+
* @public
|
|
1359
|
+
*/
|
|
1360
|
+
RemainingUses?: number | undefined;
|
|
1361
|
+
/**
|
|
1362
|
+
* <p>The stream group that runs the stream sessions.</p> <p>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 stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. </p>
|
|
1363
|
+
* @public
|
|
1364
|
+
*/
|
|
1365
|
+
StreamGroupArn?: string | undefined;
|
|
1366
|
+
/**
|
|
1367
|
+
* <p>The application that runs in the stream sessions.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
1368
|
+
* @public
|
|
1369
|
+
*/
|
|
1370
|
+
ApplicationArn?: string | undefined;
|
|
1371
|
+
/**
|
|
1372
|
+
* <p>The data transport protocol used for stream sessions started from this stream URL.</p>
|
|
1373
|
+
* @public
|
|
1374
|
+
*/
|
|
1375
|
+
Protocol?: Protocol | undefined;
|
|
1376
|
+
/**
|
|
1377
|
+
* <p>The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. 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, quotas, and limitations</a> in the <i>Amazon GameLift Streams Developer Guide</i>. </p>
|
|
1378
|
+
* @public
|
|
1379
|
+
*/
|
|
1380
|
+
Locations?: string[] | undefined;
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>The maximum length of time, in seconds, that a stream session started from this stream URL can run.</p>
|
|
1383
|
+
* @public
|
|
1384
|
+
*/
|
|
1385
|
+
SessionLengthSeconds?: number | undefined;
|
|
1386
|
+
/**
|
|
1387
|
+
* <p>The descriptive label for the stream URL.</p>
|
|
1388
|
+
* @public
|
|
1389
|
+
*/
|
|
1390
|
+
Description?: string | undefined;
|
|
1391
|
+
/**
|
|
1392
|
+
* <p>The command-line arguments passed to the application when a stream session starts.</p>
|
|
1393
|
+
* @public
|
|
1394
|
+
*/
|
|
1395
|
+
AdditionalLaunchArgs?: string[] | undefined;
|
|
1396
|
+
/**
|
|
1397
|
+
* <p>The environment variables made available to the application when a stream session starts.</p>
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
AdditionalEnvironmentVariables?: Record<string, string> | undefined;
|
|
1401
|
+
/**
|
|
1402
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/session-credentials.html">Provide AWS credentials to your streaming application</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p>
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
RoleArn?: string | undefined;
|
|
1406
|
+
/**
|
|
1407
|
+
* <p>The display settings, such as resolution, for stream sessions started from this stream URL.</p>
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
DisplayConfiguration?: DisplayConfiguration | undefined;
|
|
1411
|
+
/**
|
|
1412
|
+
* <p>A list of the stream sessions that have been started through this stream URL.</p>
|
|
1413
|
+
* @public
|
|
1414
|
+
*/
|
|
1415
|
+
StreamSessions?: StreamSessionSummary[] | undefined;
|
|
1416
|
+
}
|
|
1417
|
+
/**
|
|
1418
|
+
* @public
|
|
1419
|
+
*/
|
|
1420
|
+
export interface ListApplicationShaderCachesInput {
|
|
1421
|
+
/**
|
|
1422
|
+
* <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. Example ID: <code>a-9ZY8X7Wv6</code>. </p>
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
Identifier: string | undefined;
|
|
1426
|
+
}
|
|
1427
|
+
/**
|
|
1428
|
+
* <p>Describes a shader cache associated with an Amazon GameLift Streams application.</p>
|
|
1429
|
+
* @public
|
|
1430
|
+
*/
|
|
1431
|
+
export interface ShaderCacheSummary {
|
|
1432
|
+
/**
|
|
1433
|
+
* <p>A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is <code>1271e693c50b940e228582f1ccdd4e27</code>.</p>
|
|
1434
|
+
* @public
|
|
1435
|
+
*/
|
|
1436
|
+
Identifier: string | undefined;
|
|
1437
|
+
/**
|
|
1438
|
+
* <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
1439
|
+
* @public
|
|
1440
|
+
*/
|
|
1441
|
+
ApplicationArn: string | undefined;
|
|
1442
|
+
/**
|
|
1443
|
+
* <p>The current status of the shader cache. Possible statuses include the following:</p> <ul> <li> <p> <code>INITIALIZED</code>: Amazon GameLift Streams received the request and is preparing the shader cache.</p> </li> <li> <p> <code>PROCESSING</code>: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.</p> </li> <li> <p> <code>READY</code>: The shader cache is replicated and available for use in stream sessions.</p> </li> <li> <p> <code>DELETING</code>: Amazon GameLift Streams is deleting the shader cache.</p> </li> <li> <p> <code>ERROR</code>: An error occurred during shader cache processing. Create a new shader cache to try again.</p> </li> </ul>
|
|
1444
|
+
* @public
|
|
1445
|
+
*/
|
|
1446
|
+
Status?: ShaderCacheStatus | undefined;
|
|
1447
|
+
/**
|
|
1448
|
+
* <p>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).</p>
|
|
1449
|
+
* @public
|
|
1450
|
+
*/
|
|
1451
|
+
LastUpdatedAt?: Date | undefined;
|
|
1452
|
+
/**
|
|
1453
|
+
* <p>The total storage used by all compiled shader files in this shader cache, in bytes.</p>
|
|
1454
|
+
* @public
|
|
1455
|
+
*/
|
|
1456
|
+
StorageBytes?: number | undefined;
|
|
1457
|
+
/**
|
|
1458
|
+
* <p>The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/shader-caches.html">Shader caches</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. </p>
|
|
1459
|
+
* @public
|
|
1460
|
+
*/
|
|
1461
|
+
AssociatedStreamGroups?: string[] | undefined;
|
|
1462
|
+
}
|
|
1463
|
+
/**
|
|
1464
|
+
* @public
|
|
1465
|
+
*/
|
|
1466
|
+
export interface ListApplicationShaderCachesOutput {
|
|
1467
|
+
/**
|
|
1468
|
+
* <p>A collection of shader cache metadata for the specified Amazon GameLift Streams application. Each item includes the shader cache status, associated stream groups, and storage size.</p>
|
|
1469
|
+
* @public
|
|
1470
|
+
*/
|
|
1471
|
+
Items?: ShaderCacheSummary[] | undefined;
|
|
1472
|
+
}
|
|
1473
|
+
/**
|
|
1474
|
+
* @public
|
|
1475
|
+
*/
|
|
1476
|
+
export interface ListStreamSessionsInput {
|
|
1477
|
+
/**
|
|
1478
|
+
* <p>Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.</p>
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1481
|
+
Status?: StreamSessionStatus | undefined;
|
|
1482
|
+
/**
|
|
1483
|
+
* <p>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.</p> <p> Exported files can be in one of the following states: </p> <ul> <li> <p> <code>SUCCEEDED</code>: The exported files are successfully stored in an S3 bucket.</p> </li> <li> <p> <code>FAILED</code>: The session ended but Amazon GameLift Streams couldn't collect and upload the files to S3.</p> </li> <li> <p> <code>PENDING</code>: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.</p> </li> </ul>
|
|
1484
|
+
* @public
|
|
1485
|
+
*/
|
|
1486
|
+
ExportFilesStatus?: ExportFilesStatus | undefined;
|
|
1487
|
+
/**
|
|
1488
|
+
* <p>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. </p>
|
|
1489
|
+
* @public
|
|
1490
|
+
*/
|
|
1491
|
+
NextToken?: string | undefined;
|
|
1492
|
+
/**
|
|
1493
|
+
* <p>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>. </p>
|
|
1494
|
+
* @public
|
|
1495
|
+
*/
|
|
1496
|
+
MaxResults?: number | undefined;
|
|
1497
|
+
/**
|
|
1498
|
+
* <p>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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a>.</p>
|
|
1499
|
+
* @public
|
|
1500
|
+
*/
|
|
1501
|
+
Identifier: string | undefined;
|
|
1502
|
+
}
|
|
1157
1503
|
/**
|
|
1158
1504
|
* @public
|
|
1159
1505
|
*/
|
|
@@ -1209,6 +1555,117 @@ export interface ListStreamSessionsByAccountOutput {
|
|
|
1209
1555
|
*/
|
|
1210
1556
|
NextToken?: string | undefined;
|
|
1211
1557
|
}
|
|
1558
|
+
/**
|
|
1559
|
+
* @public
|
|
1560
|
+
*/
|
|
1561
|
+
export interface ListStreamUrlsInput {
|
|
1562
|
+
/**
|
|
1563
|
+
* <p>Filters the list to stream URLs with the specified status.</p> <ul> <li> <p> <code>ACTIVE</code>: The stream URL is valid and can start stream sessions.</p> </li> <li> <p> <code>EXPIRED</code>: The stream URL has passed its expiration time and can no longer start stream sessions.</p> </li> <li> <p> <code>REVOKED</code>: The stream URL was revoked and can no longer start stream sessions.</p> </li> <li> <p> <code>LIMIT_REACHED</code>: The stream URL has been used the maximum number of times and can no longer start stream sessions.</p> </li> </ul>
|
|
1564
|
+
* @public
|
|
1565
|
+
*/
|
|
1566
|
+
Status?: StreamUrlStatus | undefined;
|
|
1567
|
+
/**
|
|
1568
|
+
* <p>Filters the list to stream URLs that belong to the specified stream group.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p>
|
|
1569
|
+
* @public
|
|
1570
|
+
*/
|
|
1571
|
+
StreamGroupIdentifier?: string | undefined;
|
|
1572
|
+
/**
|
|
1573
|
+
* <p>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. </p>
|
|
1574
|
+
* @public
|
|
1575
|
+
*/
|
|
1576
|
+
NextToken?: string | undefined;
|
|
1577
|
+
/**
|
|
1578
|
+
* <p>The maximum number of results to return per page. Valid values are 1-100. The default is 25.</p>
|
|
1579
|
+
* @public
|
|
1580
|
+
*/
|
|
1581
|
+
MaxResults?: number | undefined;
|
|
1582
|
+
}
|
|
1583
|
+
/**
|
|
1584
|
+
* <p>Describes a stream URL. This is a summary view that omits the full configuration, such as launch arguments and display settings. To retrieve the complete configuration, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamUrl.html">GetStreamUrl</a>.</p>
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
export interface StreamUrlSummary {
|
|
1588
|
+
/**
|
|
1589
|
+
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID]</code>.</p>
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
Arn: string | undefined;
|
|
1593
|
+
/**
|
|
1594
|
+
* <p>The unique identifier for the stream URL resource, for example <code>su-1AB2C3De4</code>.</p>
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
StreamUrlId?: string | undefined;
|
|
1598
|
+
/**
|
|
1599
|
+
* <p>The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.</p>
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
StreamUrl?: string | undefined;
|
|
1603
|
+
/**
|
|
1604
|
+
* <p>The current status of the stream URL. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVE</code>: The stream URL is valid and can start stream sessions.</p> </li> <li> <p> <code>EXPIRED</code>: The stream URL has passed its expiration time and can no longer start stream sessions.</p> </li> <li> <p> <code>REVOKED</code>: The stream URL was revoked and can no longer start stream sessions.</p> </li> <li> <p> <code>LIMIT_REACHED</code>: The stream URL has been used the maximum number of times and can no longer start stream sessions.</p> </li> </ul>
|
|
1605
|
+
* @public
|
|
1606
|
+
*/
|
|
1607
|
+
Status?: StreamUrlStatus | undefined;
|
|
1608
|
+
/**
|
|
1609
|
+
* <p>Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is <code>REVOKED</code>. Possible values include the following:</p> <ul> <li> <p> <code>userRevoked</code>: You revoked the stream URL.</p> </li> <li> <p> <code>revokedAndTerminatingSessions</code>: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.</p> </li> <li> <p> <code>revokedAndSessionsTerminated</code>: You revoked the stream URL and its running stream sessions have ended.</p> </li> <li> <p> <code>streamGroupDeleted</code>: The stream group was deleted, which revoked the stream URL.</p> </li> <li> <p> <code>applicationDeleted</code>: The application was deleted, which revoked the stream URL.</p> </li> </ul>
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
StatusReason?: StreamUrlStatusReason | undefined;
|
|
1613
|
+
/**
|
|
1614
|
+
* <p>The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC).</p>
|
|
1615
|
+
* @public
|
|
1616
|
+
*/
|
|
1617
|
+
ExpiresAt?: Date | undefined;
|
|
1618
|
+
/**
|
|
1619
|
+
* <p>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).</p>
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
CreatedAt?: Date | undefined;
|
|
1623
|
+
/**
|
|
1624
|
+
* <p>The maximum number of times the stream URL can start a stream session.</p>
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
UsageLimit?: number | undefined;
|
|
1628
|
+
/**
|
|
1629
|
+
* <p>The number of times the stream URL can still be used to start a stream session.</p>
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
RemainingUses?: number | undefined;
|
|
1633
|
+
/**
|
|
1634
|
+
* <p>The stream group that runs the stream sessions.</p> <p>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 stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. </p>
|
|
1635
|
+
* @public
|
|
1636
|
+
*/
|
|
1637
|
+
StreamGroupArn?: string | undefined;
|
|
1638
|
+
/**
|
|
1639
|
+
* <p>The application that runs in the stream sessions.</p> <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
1640
|
+
* @public
|
|
1641
|
+
*/
|
|
1642
|
+
ApplicationArn?: string | undefined;
|
|
1643
|
+
/**
|
|
1644
|
+
* <p>The maximum length of time, in seconds, that a stream session started from this stream URL can run.</p>
|
|
1645
|
+
* @public
|
|
1646
|
+
*/
|
|
1647
|
+
SessionLengthSeconds?: number | undefined;
|
|
1648
|
+
/**
|
|
1649
|
+
* <p>The descriptive label for the stream URL.</p>
|
|
1650
|
+
* @public
|
|
1651
|
+
*/
|
|
1652
|
+
Description?: string | undefined;
|
|
1653
|
+
}
|
|
1654
|
+
/**
|
|
1655
|
+
* @public
|
|
1656
|
+
*/
|
|
1657
|
+
export interface ListStreamUrlsOutput {
|
|
1658
|
+
/**
|
|
1659
|
+
* <p>A collection of stream URL summaries. Each summary includes the identity, status, and usage of the stream URL, but not its full configuration.</p>
|
|
1660
|
+
* @public
|
|
1661
|
+
*/
|
|
1662
|
+
Items?: StreamUrlSummary[] | undefined;
|
|
1663
|
+
/**
|
|
1664
|
+
* <p>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. </p>
|
|
1665
|
+
* @public
|
|
1666
|
+
*/
|
|
1667
|
+
NextToken?: string | undefined;
|
|
1668
|
+
}
|
|
1212
1669
|
/**
|
|
1213
1670
|
* @public
|
|
1214
1671
|
*/
|
|
@@ -1244,6 +1701,26 @@ export interface RemoveStreamGroupLocationsInput {
|
|
|
1244
1701
|
*/
|
|
1245
1702
|
Locations: string[] | undefined;
|
|
1246
1703
|
}
|
|
1704
|
+
/**
|
|
1705
|
+
* @public
|
|
1706
|
+
*/
|
|
1707
|
+
export interface RevokeStreamUrlInput {
|
|
1708
|
+
/**
|
|
1709
|
+
* <p>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. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p> <p>This is the stream group that owns the stream URL.</p>
|
|
1710
|
+
* @public
|
|
1711
|
+
*/
|
|
1712
|
+
Identifier: string | undefined;
|
|
1713
|
+
/**
|
|
1714
|
+
* <p>The unique identifier of the stream URL to revoke. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4</code>. Example ID: <code>su-1AB2C3De4</code>.</p>
|
|
1715
|
+
* @public
|
|
1716
|
+
*/
|
|
1717
|
+
StreamUrlIdentifier: string | undefined;
|
|
1718
|
+
/**
|
|
1719
|
+
* <p>Controls what happens to running stream sessions when you revoke the stream URL. If you do not specify a value, the default is <code>REVOKE_URL</code>. Possible values include the following:</p> <ul> <li> <p> <code>REVOKE_URL</code>: Stops the stream URL from starting new stream sessions. Running sessions continue until they end.</p> </li> <li> <p> <code>REVOKE_AND_TERMINATE_SESSIONS</code>: Stops new stream sessions and ends any running stream sessions.</p> </li> </ul>
|
|
1720
|
+
* @public
|
|
1721
|
+
*/
|
|
1722
|
+
RevocationMode?: RevocationMode | undefined;
|
|
1723
|
+
}
|
|
1247
1724
|
/**
|
|
1248
1725
|
* @public
|
|
1249
1726
|
*/
|