aws-sdk-gameliftstreams 1.8.0 → 1.9.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gameliftstreams/client.rb +479 -477
- data/lib/aws-sdk-gameliftstreams/client_api.rb +121 -122
- data/lib/aws-sdk-gameliftstreams/types.rb +1214 -1204
- data/lib/aws-sdk-gameliftstreams.rb +1 -1
- data/sig/client.rbs +114 -114
- data/sig/types.rbs +121 -121
- metadata +1 -1
@@ -516,8 +516,8 @@ module Aws::GameLiftStreams
|
|
516
516
|
# identifier: "Identifier", # required
|
517
517
|
# location_configurations: [ # required
|
518
518
|
# {
|
519
|
-
# always_on_capacity: 1,
|
520
519
|
# location_name: "LocationName", # required
|
520
|
+
# always_on_capacity: 1,
|
521
521
|
# on_demand_capacity: 1,
|
522
522
|
# },
|
523
523
|
# ],
|
@@ -527,13 +527,13 @@ module Aws::GameLiftStreams
|
|
527
527
|
#
|
528
528
|
# resp.identifier #=> String
|
529
529
|
# resp.locations #=> Array
|
530
|
-
# resp.locations[0].allocated_capacity #=> Integer
|
531
|
-
# resp.locations[0].always_on_capacity #=> Integer
|
532
|
-
# resp.locations[0].idle_capacity #=> Integer
|
533
530
|
# resp.locations[0].location_name #=> String
|
531
|
+
# resp.locations[0].status #=> String, one of "ACTIVATING", "ACTIVE", "ERROR", "REMOVING"
|
532
|
+
# resp.locations[0].always_on_capacity #=> Integer
|
534
533
|
# resp.locations[0].on_demand_capacity #=> Integer
|
535
534
|
# resp.locations[0].requested_capacity #=> Integer
|
536
|
-
# resp.locations[0].
|
535
|
+
# resp.locations[0].allocated_capacity #=> Integer
|
536
|
+
# resp.locations[0].idle_capacity #=> Integer
|
537
537
|
#
|
538
538
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AddStreamGroupLocations AWS API Documentation
|
539
539
|
#
|
@@ -554,18 +554,6 @@ module Aws::GameLiftStreams
|
|
554
554
|
#
|
555
555
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html
|
556
556
|
#
|
557
|
-
# @option params [required, Array<String>] :application_identifiers
|
558
|
-
# A set of applications to associate with the stream group.
|
559
|
-
#
|
560
|
-
# This value is a set of either [Amazon Resource Names (ARN)][1] or IDs
|
561
|
-
# that uniquely identify application resources. Example ARN:
|
562
|
-
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
563
|
-
# Example ID: `a-9ZY8X7Wv6`.
|
564
|
-
#
|
565
|
-
#
|
566
|
-
#
|
567
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
568
|
-
#
|
569
557
|
# @option params [required, String] :identifier
|
570
558
|
# A stream group to associate to the applications.
|
571
559
|
#
|
@@ -578,23 +566,35 @@ module Aws::GameLiftStreams
|
|
578
566
|
#
|
579
567
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
580
568
|
#
|
569
|
+
# @option params [required, Array<String>] :application_identifiers
|
570
|
+
# A set of applications to associate with the stream group.
|
571
|
+
#
|
572
|
+
# This value is a set of either [Amazon Resource Names (ARN)][1] or IDs
|
573
|
+
# that uniquely identify application resources. Example ARN:
|
574
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
575
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
576
|
+
#
|
577
|
+
#
|
578
|
+
#
|
579
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
580
|
+
#
|
581
581
|
# @return [Types::AssociateApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
582
582
|
#
|
583
|
-
# * {Types::AssociateApplicationsOutput#application_arns #application_arns} => Array<String>
|
584
583
|
# * {Types::AssociateApplicationsOutput#arn #arn} => String
|
584
|
+
# * {Types::AssociateApplicationsOutput#application_arns #application_arns} => Array<String>
|
585
585
|
#
|
586
586
|
# @example Request syntax with placeholder values
|
587
587
|
#
|
588
588
|
# resp = client.associate_applications({
|
589
|
-
# application_identifiers: ["Identifier"], # required
|
590
589
|
# identifier: "Identifier", # required
|
590
|
+
# application_identifiers: ["Identifier"], # required
|
591
591
|
# })
|
592
592
|
#
|
593
593
|
# @example Response structure
|
594
594
|
#
|
595
|
+
# resp.arn #=> String
|
595
596
|
# resp.application_arns #=> Array
|
596
597
|
# resp.application_arns[0] #=> String
|
597
|
-
# resp.arn #=> String
|
598
598
|
#
|
599
599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AssociateApplications AWS API Documentation
|
600
600
|
#
|
@@ -628,34 +628,36 @@ module Aws::GameLiftStreams
|
|
628
628
|
#
|
629
629
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetApplication.html
|
630
630
|
#
|
631
|
-
# @option params [String] :
|
632
|
-
#
|
633
|
-
#
|
634
|
-
# `ApplicationLogPaths`.
|
631
|
+
# @option params [required, String] :description
|
632
|
+
# A human-readable label for the application. You can update this value
|
633
|
+
# later.
|
635
634
|
#
|
636
|
-
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
635
|
+
# @option params [required, Types::RuntimeEnvironment] :runtime_environment
|
636
|
+
# Configuration settings that identify the operating system for an
|
637
|
+
# application resource. This can also include a compatibility layer and
|
638
|
+
# other drivers.
|
640
639
|
#
|
641
|
-
#
|
640
|
+
# A runtime environment can be one of the following:
|
642
641
|
#
|
642
|
+
# * For Linux applications
|
643
643
|
#
|
644
|
+
# * Ubuntu 22.04 LTS (`Type=UBUNTU, Version=22_04_LTS`)
|
644
645
|
#
|
645
|
-
#
|
646
|
+
# ^
|
647
|
+
# * For Windows applications
|
646
648
|
#
|
647
|
-
#
|
648
|
-
# Locations of log files that your content generates during a stream
|
649
|
-
# session. Enter path values that are relative to the
|
650
|
-
# `ApplicationSourceUri` location. You can specify up to 10 log paths.
|
651
|
-
# Amazon GameLift Streams uploads designated log files to the Amazon S3
|
652
|
-
# bucket that you specify in `ApplicationLogOutputUri` at the end of a
|
653
|
-
# stream session. To retrieve stored log files, call
|
654
|
-
# [GetStreamSession][1] and get the `LogFileLocationUri`.
|
649
|
+
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS, Version=2022`)
|
655
650
|
#
|
651
|
+
# * Proton 9.0-2 (`Type=PROTON, Version=20250516`)
|
656
652
|
#
|
653
|
+
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
657
654
|
#
|
658
|
-
#
|
655
|
+
# * Proton 8.0-2c (`Type=PROTON, Version=20230704`)
|
656
|
+
#
|
657
|
+
# @option params [required, String] :executable_path
|
658
|
+
# The path and file name of the executable file that launches the
|
659
|
+
# content for streaming. Enter a path value that is relative to the
|
660
|
+
# location set in `ApplicationSourceUri`.
|
659
661
|
#
|
660
662
|
# @option params [required, String] :application_source_uri
|
661
663
|
# The location of the content that you want to stream. Enter an Amazon
|
@@ -672,43 +674,34 @@ module Aws::GameLiftStreams
|
|
672
674
|
#
|
673
675
|
# </note>
|
674
676
|
#
|
675
|
-
# @option params [String] :
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
#
|
684
|
-
# @option params [required, String] :description
|
685
|
-
# A human-readable label for the application. You can update this value
|
686
|
-
# later.
|
677
|
+
# @option params [Array<String>] :application_log_paths
|
678
|
+
# Locations of log files that your content generates during a stream
|
679
|
+
# session. Enter path values that are relative to the
|
680
|
+
# `ApplicationSourceUri` location. You can specify up to 10 log paths.
|
681
|
+
# Amazon GameLift Streams uploads designated log files to the Amazon S3
|
682
|
+
# bucket that you specify in `ApplicationLogOutputUri` at the end of a
|
683
|
+
# stream session. To retrieve stored log files, call
|
684
|
+
# [GetStreamSession][1] and get the `LogFileLocationUri`.
|
687
685
|
#
|
688
|
-
# @option params [required, String] :executable_path
|
689
|
-
# The path and file name of the executable file that launches the
|
690
|
-
# content for streaming. Enter a path value that is relative to the
|
691
|
-
# location set in `ApplicationSourceUri`.
|
692
686
|
#
|
693
|
-
# @option params [required, Types::RuntimeEnvironment] :runtime_environment
|
694
|
-
# Configuration settings that identify the operating system for an
|
695
|
-
# application resource. This can also include a compatibility layer and
|
696
|
-
# other drivers.
|
697
687
|
#
|
698
|
-
#
|
688
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
|
699
689
|
#
|
700
|
-
#
|
690
|
+
# @option params [String] :application_log_output_uri
|
691
|
+
# An Amazon S3 URI to a bucket where you would like Amazon GameLift
|
692
|
+
# Streams to save application logs. Required if you specify one or more
|
693
|
+
# `ApplicationLogPaths`.
|
701
694
|
#
|
702
|
-
#
|
695
|
+
# <note markdown="1"> The log bucket must have permissions that give Amazon GameLift Streams
|
696
|
+
# access to write the log files. For more information, see [Application
|
697
|
+
# log bucket permission policy][1] in the *Amazon GameLift Streams
|
698
|
+
# Developer Guide*.
|
703
699
|
#
|
704
|
-
#
|
705
|
-
# * For Windows applications
|
700
|
+
# </note>
|
706
701
|
#
|
707
|
-
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS, Version=2022`)
|
708
702
|
#
|
709
|
-
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
710
703
|
#
|
711
|
-
#
|
704
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
|
712
705
|
#
|
713
706
|
# @option params [Hash<String,String>] :tags
|
714
707
|
# A list of labels to assign to the new application resource. Tags are
|
@@ -726,62 +719,71 @@ module Aws::GameLiftStreams
|
|
726
719
|
# [3]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html
|
727
720
|
# [4]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html
|
728
721
|
#
|
722
|
+
# @option params [String] :client_token
|
723
|
+
# A unique identifier that represents a client request. The request is
|
724
|
+
# idempotent, which ensures that an API request completes only once.
|
725
|
+
# When users send a request, Amazon GameLift Streams automatically
|
726
|
+
# populates this field.
|
727
|
+
#
|
728
|
+
# **A suitable default value is auto-generated.** You should normally
|
729
|
+
# not need to pass this option.**
|
730
|
+
#
|
729
731
|
# @return [Types::CreateApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
730
732
|
#
|
731
|
-
# * {Types::CreateApplicationOutput#application_log_output_uri #application_log_output_uri} => String
|
732
|
-
# * {Types::CreateApplicationOutput#application_log_paths #application_log_paths} => Array<String>
|
733
|
-
# * {Types::CreateApplicationOutput#application_source_uri #application_source_uri} => String
|
734
733
|
# * {Types::CreateApplicationOutput#arn #arn} => String
|
735
|
-
# * {Types::CreateApplicationOutput#associated_stream_groups #associated_stream_groups} => Array<String>
|
736
|
-
# * {Types::CreateApplicationOutput#created_at #created_at} => Time
|
737
734
|
# * {Types::CreateApplicationOutput#description #description} => String
|
735
|
+
# * {Types::CreateApplicationOutput#runtime_environment #runtime_environment} => Types::RuntimeEnvironment
|
738
736
|
# * {Types::CreateApplicationOutput#executable_path #executable_path} => String
|
737
|
+
# * {Types::CreateApplicationOutput#application_log_paths #application_log_paths} => Array<String>
|
738
|
+
# * {Types::CreateApplicationOutput#application_log_output_uri #application_log_output_uri} => String
|
739
|
+
# * {Types::CreateApplicationOutput#application_source_uri #application_source_uri} => String
|
739
740
|
# * {Types::CreateApplicationOutput#id #id} => String
|
740
|
-
# * {Types::CreateApplicationOutput#last_updated_at #last_updated_at} => Time
|
741
|
-
# * {Types::CreateApplicationOutput#replication_statuses #replication_statuses} => Array<Types::ReplicationStatus>
|
742
|
-
# * {Types::CreateApplicationOutput#runtime_environment #runtime_environment} => Types::RuntimeEnvironment
|
743
741
|
# * {Types::CreateApplicationOutput#status #status} => String
|
744
742
|
# * {Types::CreateApplicationOutput#status_reason #status_reason} => String
|
743
|
+
# * {Types::CreateApplicationOutput#replication_statuses #replication_statuses} => Array<Types::ReplicationStatus>
|
744
|
+
# * {Types::CreateApplicationOutput#created_at #created_at} => Time
|
745
|
+
# * {Types::CreateApplicationOutput#last_updated_at #last_updated_at} => Time
|
746
|
+
# * {Types::CreateApplicationOutput#associated_stream_groups #associated_stream_groups} => Array<String>
|
745
747
|
#
|
746
748
|
# @example Request syntax with placeholder values
|
747
749
|
#
|
748
750
|
# resp = client.create_application({
|
749
|
-
# application_log_output_uri: "ApplicationLogOutputUri",
|
750
|
-
# application_log_paths: ["FilePath"],
|
751
|
-
# application_source_uri: "ApplicationSourceUri", # required
|
752
|
-
# client_token: "ClientToken",
|
753
751
|
# description: "Description", # required
|
754
|
-
# executable_path: "ExecutablePath", # required
|
755
752
|
# runtime_environment: { # required
|
756
753
|
# type: "PROTON", # required, accepts PROTON, WINDOWS, UBUNTU
|
757
754
|
# version: "RuntimeEnvironmentVersion", # required
|
758
755
|
# },
|
756
|
+
# executable_path: "ExecutablePath", # required
|
757
|
+
# application_source_uri: "ApplicationSourceUri", # required
|
758
|
+
# application_log_paths: ["FilePath"],
|
759
|
+
# application_log_output_uri: "ApplicationLogOutputUri",
|
759
760
|
# tags: {
|
760
761
|
# "TagKey" => "TagValue",
|
761
762
|
# },
|
763
|
+
# client_token: "ClientToken",
|
762
764
|
# })
|
763
765
|
#
|
764
766
|
# @example Response structure
|
765
767
|
#
|
766
|
-
# resp.application_log_output_uri #=> String
|
767
|
-
# resp.application_log_paths #=> Array
|
768
|
-
# resp.application_log_paths[0] #=> String
|
769
|
-
# resp.application_source_uri #=> String
|
770
768
|
# resp.arn #=> String
|
771
|
-
# resp.associated_stream_groups #=> Array
|
772
|
-
# resp.associated_stream_groups[0] #=> String
|
773
|
-
# resp.created_at #=> Time
|
774
769
|
# resp.description #=> String
|
770
|
+
# resp.runtime_environment.type #=> String, one of "PROTON", "WINDOWS", "UBUNTU"
|
771
|
+
# resp.runtime_environment.version #=> String
|
775
772
|
# resp.executable_path #=> String
|
773
|
+
# resp.application_log_paths #=> Array
|
774
|
+
# resp.application_log_paths[0] #=> String
|
775
|
+
# resp.application_log_output_uri #=> String
|
776
|
+
# resp.application_source_uri #=> String
|
776
777
|
# resp.id #=> String
|
777
|
-
# resp.
|
778
|
+
# resp.status #=> String, one of "INITIALIZED", "PROCESSING", "READY", "DELETING", "ERROR"
|
779
|
+
# resp.status_reason #=> String, one of "internalError", "accessDenied"
|
778
780
|
# resp.replication_statuses #=> Array
|
779
781
|
# resp.replication_statuses[0].location #=> String
|
780
782
|
# resp.replication_statuses[0].status #=> String, one of "REPLICATING", "COMPLETED"
|
781
|
-
# resp.
|
782
|
-
# resp.
|
783
|
-
# resp.
|
784
|
-
# resp.
|
783
|
+
# resp.created_at #=> Time
|
784
|
+
# resp.last_updated_at #=> Time
|
785
|
+
# resp.associated_stream_groups #=> Array
|
786
|
+
# resp.associated_stream_groups[0] #=> String
|
785
787
|
#
|
786
788
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateApplication AWS API Documentation
|
787
789
|
#
|
@@ -834,42 +836,9 @@ module Aws::GameLiftStreams
|
|
834
836
|
# [2]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html
|
835
837
|
# [3]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html
|
836
838
|
#
|
837
|
-
# @option params [String] :client_token
|
838
|
-
# A unique identifier that represents a client request. The request is
|
839
|
-
# idempotent, which ensures that an API request completes only once.
|
840
|
-
# When users send a request, Amazon GameLift Streams automatically
|
841
|
-
# populates this field.
|
842
|
-
#
|
843
|
-
# **A suitable default value is auto-generated.** You should normally
|
844
|
-
# not need to pass this option.**
|
845
|
-
#
|
846
|
-
# @option params [String] :default_application_identifier
|
847
|
-
# The unique identifier of the Amazon GameLift Streams application that
|
848
|
-
# you want to associate to a stream group as the default application.
|
849
|
-
# The application must be in `READY` status. By setting the default
|
850
|
-
# application identifier, you will optimize startup performance of this
|
851
|
-
# application in your stream group. Once set, this application cannot be
|
852
|
-
# disassociated from the stream group, unlike applications that are
|
853
|
-
# associated using AssociateApplications. If not set when creating a
|
854
|
-
# stream group, you will need to call AssociateApplications later,
|
855
|
-
# before you can start streaming.
|
856
|
-
#
|
857
|
-
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
858
|
-
# identifies the application resource. Example ARN:
|
859
|
-
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
860
|
-
# Example ID: `a-9ZY8X7Wv6`.
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
865
|
-
#
|
866
839
|
# @option params [required, String] :description
|
867
840
|
# A descriptive label for the stream group.
|
868
841
|
#
|
869
|
-
# @option params [Array<Types::LocationConfiguration>] :location_configurations
|
870
|
-
# A set of one or more locations and the streaming capacity for each
|
871
|
-
# location.
|
872
|
-
#
|
873
842
|
# @option params [required, String] :stream_class
|
874
843
|
# The target stream quality for sessions that are hosted in this stream
|
875
844
|
# group. Set a stream class that is appropriate to the type of content
|
@@ -952,6 +921,30 @@ module Aws::GameLiftStreams
|
|
952
921
|
#
|
953
922
|
# * Tenancy: Supports 1 concurrent stream session
|
954
923
|
#
|
924
|
+
# @option params [String] :default_application_identifier
|
925
|
+
# The unique identifier of the Amazon GameLift Streams application that
|
926
|
+
# you want to associate to a stream group as the default application.
|
927
|
+
# The application must be in `READY` status. By setting the default
|
928
|
+
# application identifier, you will optimize startup performance of this
|
929
|
+
# application in your stream group. Once set, this application cannot be
|
930
|
+
# disassociated from the stream group, unlike applications that are
|
931
|
+
# associated using AssociateApplications. If not set when creating a
|
932
|
+
# stream group, you will need to call AssociateApplications later,
|
933
|
+
# before you can start streaming.
|
934
|
+
#
|
935
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
936
|
+
# identifies the application resource. Example ARN:
|
937
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
938
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
939
|
+
#
|
940
|
+
#
|
941
|
+
#
|
942
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
943
|
+
#
|
944
|
+
# @option params [Array<Types::LocationConfiguration>] :location_configurations
|
945
|
+
# A set of one or more locations and the streaming capacity for each
|
946
|
+
# location.
|
947
|
+
#
|
955
948
|
# @option params [Hash<String,String>] :tags
|
956
949
|
# A list of labels to assign to the new stream group resource. Tags are
|
957
950
|
# developer-defined key-value pairs. Tagging Amazon Web Services
|
@@ -968,61 +961,70 @@ module Aws::GameLiftStreams
|
|
968
961
|
# [3]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UntagResource.html
|
969
962
|
# [4]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListTagsForResource.html
|
970
963
|
#
|
964
|
+
# @option params [String] :client_token
|
965
|
+
# A unique identifier that represents a client request. The request is
|
966
|
+
# idempotent, which ensures that an API request completes only once.
|
967
|
+
# When users send a request, Amazon GameLift Streams automatically
|
968
|
+
# populates this field.
|
969
|
+
#
|
970
|
+
# **A suitable default value is auto-generated.** You should normally
|
971
|
+
# not need to pass this option.**
|
972
|
+
#
|
971
973
|
# @return [Types::CreateStreamGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
972
974
|
#
|
973
975
|
# * {Types::CreateStreamGroupOutput#arn #arn} => String
|
974
|
-
# * {Types::CreateStreamGroupOutput#associated_applications #associated_applications} => Array<String>
|
975
|
-
# * {Types::CreateStreamGroupOutput#created_at #created_at} => Time
|
976
|
-
# * {Types::CreateStreamGroupOutput#default_application #default_application} => Types::DefaultApplication
|
977
976
|
# * {Types::CreateStreamGroupOutput#description #description} => String
|
978
|
-
# * {Types::CreateStreamGroupOutput#
|
979
|
-
# * {Types::CreateStreamGroupOutput#last_updated_at #last_updated_at} => Time
|
977
|
+
# * {Types::CreateStreamGroupOutput#default_application #default_application} => Types::DefaultApplication
|
980
978
|
# * {Types::CreateStreamGroupOutput#location_states #location_states} => Array<Types::LocationState>
|
979
|
+
# * {Types::CreateStreamGroupOutput#stream_class #stream_class} => String
|
980
|
+
# * {Types::CreateStreamGroupOutput#id #id} => String
|
981
981
|
# * {Types::CreateStreamGroupOutput#status #status} => String
|
982
982
|
# * {Types::CreateStreamGroupOutput#status_reason #status_reason} => String
|
983
|
-
# * {Types::CreateStreamGroupOutput#
|
983
|
+
# * {Types::CreateStreamGroupOutput#last_updated_at #last_updated_at} => Time
|
984
|
+
# * {Types::CreateStreamGroupOutput#created_at #created_at} => Time
|
985
|
+
# * {Types::CreateStreamGroupOutput#associated_applications #associated_applications} => Array<String>
|
984
986
|
#
|
985
987
|
# @example Request syntax with placeholder values
|
986
988
|
#
|
987
989
|
# resp = client.create_stream_group({
|
988
|
-
# client_token: "ClientToken",
|
989
|
-
# default_application_identifier: "Identifier",
|
990
990
|
# description: "Description", # required
|
991
|
+
# stream_class: "gen4n_high", # required, accepts gen4n_high, gen4n_ultra, gen4n_win2022, gen5n_high, gen5n_ultra, gen5n_win2022
|
992
|
+
# default_application_identifier: "Identifier",
|
991
993
|
# location_configurations: [
|
992
994
|
# {
|
993
|
-
# always_on_capacity: 1,
|
994
995
|
# location_name: "LocationName", # required
|
996
|
+
# always_on_capacity: 1,
|
995
997
|
# on_demand_capacity: 1,
|
996
998
|
# },
|
997
999
|
# ],
|
998
|
-
# stream_class: "gen4n_high", # required, accepts gen4n_high, gen4n_ultra, gen4n_win2022, gen5n_high, gen5n_ultra, gen5n_win2022
|
999
1000
|
# tags: {
|
1000
1001
|
# "TagKey" => "TagValue",
|
1001
1002
|
# },
|
1003
|
+
# client_token: "ClientToken",
|
1002
1004
|
# })
|
1003
1005
|
#
|
1004
1006
|
# @example Response structure
|
1005
1007
|
#
|
1006
1008
|
# resp.arn #=> String
|
1007
|
-
# resp.associated_applications #=> Array
|
1008
|
-
# resp.associated_applications[0] #=> String
|
1009
|
-
# resp.created_at #=> Time
|
1010
|
-
# resp.default_application.arn #=> String
|
1011
|
-
# resp.default_application.id #=> String
|
1012
1009
|
# resp.description #=> String
|
1013
|
-
# resp.id #=> String
|
1014
|
-
# resp.
|
1010
|
+
# resp.default_application.id #=> String
|
1011
|
+
# resp.default_application.arn #=> String
|
1015
1012
|
# resp.location_states #=> Array
|
1016
|
-
# resp.location_states[0].allocated_capacity #=> Integer
|
1017
|
-
# resp.location_states[0].always_on_capacity #=> Integer
|
1018
|
-
# resp.location_states[0].idle_capacity #=> Integer
|
1019
1013
|
# resp.location_states[0].location_name #=> String
|
1014
|
+
# resp.location_states[0].status #=> String, one of "ACTIVATING", "ACTIVE", "ERROR", "REMOVING"
|
1015
|
+
# resp.location_states[0].always_on_capacity #=> Integer
|
1020
1016
|
# resp.location_states[0].on_demand_capacity #=> Integer
|
1021
1017
|
# resp.location_states[0].requested_capacity #=> Integer
|
1022
|
-
# resp.location_states[0].
|
1018
|
+
# resp.location_states[0].allocated_capacity #=> Integer
|
1019
|
+
# resp.location_states[0].idle_capacity #=> Integer
|
1020
|
+
# resp.stream_class #=> String, one of "gen4n_high", "gen4n_ultra", "gen4n_win2022", "gen5n_high", "gen5n_ultra", "gen5n_win2022"
|
1021
|
+
# resp.id #=> String
|
1023
1022
|
# resp.status #=> String, one of "ACTIVATING", "UPDATING_LOCATIONS", "ACTIVE", "ACTIVE_WITH_ERRORS", "ERROR", "DELETING"
|
1024
1023
|
# resp.status_reason #=> String, one of "internalError", "noAvailableInstances"
|
1025
|
-
# resp.
|
1024
|
+
# resp.last_updated_at #=> Time
|
1025
|
+
# resp.created_at #=> Time
|
1026
|
+
# resp.associated_applications #=> Array
|
1027
|
+
# resp.associated_applications[0] #=> String
|
1026
1028
|
#
|
1027
1029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateStreamGroup AWS API Documentation
|
1028
1030
|
#
|
@@ -1079,12 +1081,6 @@ module Aws::GameLiftStreams
|
|
1079
1081
|
#
|
1080
1082
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1081
1083
|
#
|
1082
|
-
# @option params [required, String] :signal_request
|
1083
|
-
# A WebRTC ICE offer string to use when initializing a WebRTC
|
1084
|
-
# connection. The offer is a very long JSON string. Provide the string
|
1085
|
-
# as a text value in quotes. The offer must be newly generated, not the
|
1086
|
-
# same offer provided to `StartStreamSession`.
|
1087
|
-
#
|
1088
1084
|
# @option params [required, String] :stream_session_identifier
|
1089
1085
|
# [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1090
1086
|
# stream session resource. Example ARN:
|
@@ -1098,6 +1094,12 @@ module Aws::GameLiftStreams
|
|
1098
1094
|
#
|
1099
1095
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1100
1096
|
#
|
1097
|
+
# @option params [required, String] :signal_request
|
1098
|
+
# A WebRTC ICE offer string to use when initializing a WebRTC
|
1099
|
+
# connection. The offer is a very long JSON string. Provide the string
|
1100
|
+
# as a text value in quotes. The offer must be newly generated, not the
|
1101
|
+
# same offer provided to `StartStreamSession`.
|
1102
|
+
#
|
1101
1103
|
# @return [Types::CreateStreamSessionConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1102
1104
|
#
|
1103
1105
|
# * {Types::CreateStreamSessionConnectionOutput#signal_response #signal_response} => String
|
@@ -1107,8 +1109,8 @@ module Aws::GameLiftStreams
|
|
1107
1109
|
# resp = client.create_stream_session_connection({
|
1108
1110
|
# client_token: "ClientToken",
|
1109
1111
|
# identifier: "Identifier", # required
|
1110
|
-
# signal_request: "SignalRequest", # required
|
1111
1112
|
# stream_session_identifier: "Identifier", # required
|
1113
|
+
# signal_request: "SignalRequest", # required
|
1112
1114
|
# })
|
1113
1115
|
#
|
1114
1116
|
# @example Response structure
|
@@ -1241,6 +1243,18 @@ module Aws::GameLiftStreams
|
|
1241
1243
|
#
|
1242
1244
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html
|
1243
1245
|
#
|
1246
|
+
# @option params [required, String] :identifier
|
1247
|
+
# A stream group to disassociate these applications from.
|
1248
|
+
#
|
1249
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
1250
|
+
# identifies the stream group resource. Example ARN:
|
1251
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1252
|
+
# Example ID: `sg-1AB2C3De4`.
|
1253
|
+
#
|
1254
|
+
#
|
1255
|
+
#
|
1256
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1257
|
+
#
|
1244
1258
|
# @option params [required, Array<String>] :application_identifiers
|
1245
1259
|
# A set of applications that you want to disassociate from the stream
|
1246
1260
|
# group.
|
@@ -1254,35 +1268,23 @@ module Aws::GameLiftStreams
|
|
1254
1268
|
#
|
1255
1269
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1256
1270
|
#
|
1257
|
-
# @option params [required, String] :identifier
|
1258
|
-
# A stream group to disassociate these applications from.
|
1259
|
-
#
|
1260
|
-
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
1261
|
-
# identifies the stream group resource. Example ARN:
|
1262
|
-
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1263
|
-
# Example ID: `sg-1AB2C3De4`.
|
1264
|
-
#
|
1265
|
-
#
|
1266
|
-
#
|
1267
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1268
|
-
#
|
1269
1271
|
# @return [Types::DisassociateApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1270
1272
|
#
|
1271
|
-
# * {Types::DisassociateApplicationsOutput#application_arns #application_arns} => Array<String>
|
1272
1273
|
# * {Types::DisassociateApplicationsOutput#arn #arn} => String
|
1274
|
+
# * {Types::DisassociateApplicationsOutput#application_arns #application_arns} => Array<String>
|
1273
1275
|
#
|
1274
1276
|
# @example Request syntax with placeholder values
|
1275
1277
|
#
|
1276
1278
|
# resp = client.disassociate_applications({
|
1277
|
-
# application_identifiers: ["Identifier"], # required
|
1278
1279
|
# identifier: "Identifier", # required
|
1280
|
+
# application_identifiers: ["Identifier"], # required
|
1279
1281
|
# })
|
1280
1282
|
#
|
1281
1283
|
# @example Response structure
|
1282
1284
|
#
|
1285
|
+
# resp.arn #=> String
|
1283
1286
|
# resp.application_arns #=> Array
|
1284
1287
|
# resp.application_arns[0] #=> String
|
1285
|
-
# resp.arn #=> String
|
1286
1288
|
#
|
1287
1289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/DisassociateApplications AWS API Documentation
|
1288
1290
|
#
|
@@ -1339,6 +1341,16 @@ module Aws::GameLiftStreams
|
|
1339
1341
|
#
|
1340
1342
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1341
1343
|
#
|
1344
|
+
# @option params [required, String] :stream_session_identifier
|
1345
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1346
|
+
# stream session resource. Example ARN:
|
1347
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
|
1348
|
+
# Example ID: `ABC123def4567`.
|
1349
|
+
#
|
1350
|
+
#
|
1351
|
+
#
|
1352
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1353
|
+
#
|
1342
1354
|
# @option params [required, String] :output_uri
|
1343
1355
|
# The S3 bucket URI where Amazon GameLift Streams uploads the set of
|
1344
1356
|
# compressed exported files for this stream session. Amazon GameLift
|
@@ -1356,24 +1368,14 @@ module Aws::GameLiftStreams
|
|
1356
1368
|
# `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip`
|
1357
1369
|
# or another similar name.
|
1358
1370
|
#
|
1359
|
-
# @option params [required, String] :stream_session_identifier
|
1360
|
-
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1361
|
-
# stream session resource. Example ARN:
|
1362
|
-
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
|
1363
|
-
# Example ID: `ABC123def4567`.
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
#
|
1367
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1368
|
-
#
|
1369
1371
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1370
1372
|
#
|
1371
1373
|
# @example Request syntax with placeholder values
|
1372
1374
|
#
|
1373
1375
|
# resp = client.export_stream_session_files({
|
1374
1376
|
# identifier: "Identifier", # required
|
1375
|
-
# output_uri: "OutputUri", # required
|
1376
1377
|
# stream_session_identifier: "Identifier", # required
|
1378
|
+
# output_uri: "OutputUri", # required
|
1377
1379
|
# })
|
1378
1380
|
#
|
1379
1381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ExportStreamSessionFiles AWS API Documentation
|
@@ -1402,20 +1404,20 @@ module Aws::GameLiftStreams
|
|
1402
1404
|
#
|
1403
1405
|
# @return [Types::GetApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1404
1406
|
#
|
1405
|
-
# * {Types::GetApplicationOutput#application_log_output_uri #application_log_output_uri} => String
|
1406
|
-
# * {Types::GetApplicationOutput#application_log_paths #application_log_paths} => Array<String>
|
1407
|
-
# * {Types::GetApplicationOutput#application_source_uri #application_source_uri} => String
|
1408
1407
|
# * {Types::GetApplicationOutput#arn #arn} => String
|
1409
|
-
# * {Types::GetApplicationOutput#associated_stream_groups #associated_stream_groups} => Array<String>
|
1410
|
-
# * {Types::GetApplicationOutput#created_at #created_at} => Time
|
1411
1408
|
# * {Types::GetApplicationOutput#description #description} => String
|
1409
|
+
# * {Types::GetApplicationOutput#runtime_environment #runtime_environment} => Types::RuntimeEnvironment
|
1412
1410
|
# * {Types::GetApplicationOutput#executable_path #executable_path} => String
|
1411
|
+
# * {Types::GetApplicationOutput#application_log_paths #application_log_paths} => Array<String>
|
1412
|
+
# * {Types::GetApplicationOutput#application_log_output_uri #application_log_output_uri} => String
|
1413
|
+
# * {Types::GetApplicationOutput#application_source_uri #application_source_uri} => String
|
1413
1414
|
# * {Types::GetApplicationOutput#id #id} => String
|
1414
|
-
# * {Types::GetApplicationOutput#last_updated_at #last_updated_at} => Time
|
1415
|
-
# * {Types::GetApplicationOutput#replication_statuses #replication_statuses} => Array<Types::ReplicationStatus>
|
1416
|
-
# * {Types::GetApplicationOutput#runtime_environment #runtime_environment} => Types::RuntimeEnvironment
|
1417
1415
|
# * {Types::GetApplicationOutput#status #status} => String
|
1418
1416
|
# * {Types::GetApplicationOutput#status_reason #status_reason} => String
|
1417
|
+
# * {Types::GetApplicationOutput#replication_statuses #replication_statuses} => Array<Types::ReplicationStatus>
|
1418
|
+
# * {Types::GetApplicationOutput#created_at #created_at} => Time
|
1419
|
+
# * {Types::GetApplicationOutput#last_updated_at #last_updated_at} => Time
|
1420
|
+
# * {Types::GetApplicationOutput#associated_stream_groups #associated_stream_groups} => Array<String>
|
1419
1421
|
#
|
1420
1422
|
# @example Request syntax with placeholder values
|
1421
1423
|
#
|
@@ -1425,25 +1427,25 @@ module Aws::GameLiftStreams
|
|
1425
1427
|
#
|
1426
1428
|
# @example Response structure
|
1427
1429
|
#
|
1428
|
-
# resp.application_log_output_uri #=> String
|
1429
|
-
# resp.application_log_paths #=> Array
|
1430
|
-
# resp.application_log_paths[0] #=> String
|
1431
|
-
# resp.application_source_uri #=> String
|
1432
1430
|
# resp.arn #=> String
|
1433
|
-
# resp.associated_stream_groups #=> Array
|
1434
|
-
# resp.associated_stream_groups[0] #=> String
|
1435
|
-
# resp.created_at #=> Time
|
1436
1431
|
# resp.description #=> String
|
1432
|
+
# resp.runtime_environment.type #=> String, one of "PROTON", "WINDOWS", "UBUNTU"
|
1433
|
+
# resp.runtime_environment.version #=> String
|
1437
1434
|
# resp.executable_path #=> String
|
1435
|
+
# resp.application_log_paths #=> Array
|
1436
|
+
# resp.application_log_paths[0] #=> String
|
1437
|
+
# resp.application_log_output_uri #=> String
|
1438
|
+
# resp.application_source_uri #=> String
|
1438
1439
|
# resp.id #=> String
|
1439
|
-
# resp.
|
1440
|
+
# resp.status #=> String, one of "INITIALIZED", "PROCESSING", "READY", "DELETING", "ERROR"
|
1441
|
+
# resp.status_reason #=> String, one of "internalError", "accessDenied"
|
1440
1442
|
# resp.replication_statuses #=> Array
|
1441
1443
|
# resp.replication_statuses[0].location #=> String
|
1442
1444
|
# resp.replication_statuses[0].status #=> String, one of "REPLICATING", "COMPLETED"
|
1443
|
-
# resp.
|
1444
|
-
# resp.
|
1445
|
-
# resp.
|
1446
|
-
# resp.
|
1445
|
+
# resp.created_at #=> Time
|
1446
|
+
# resp.last_updated_at #=> Time
|
1447
|
+
# resp.associated_stream_groups #=> Array
|
1448
|
+
# resp.associated_stream_groups[0] #=> String
|
1447
1449
|
#
|
1448
1450
|
#
|
1449
1451
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1478,16 +1480,16 @@ module Aws::GameLiftStreams
|
|
1478
1480
|
# @return [Types::GetStreamGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1479
1481
|
#
|
1480
1482
|
# * {Types::GetStreamGroupOutput#arn #arn} => String
|
1481
|
-
# * {Types::GetStreamGroupOutput#associated_applications #associated_applications} => Array<String>
|
1482
|
-
# * {Types::GetStreamGroupOutput#created_at #created_at} => Time
|
1483
|
-
# * {Types::GetStreamGroupOutput#default_application #default_application} => Types::DefaultApplication
|
1484
1483
|
# * {Types::GetStreamGroupOutput#description #description} => String
|
1485
|
-
# * {Types::GetStreamGroupOutput#
|
1486
|
-
# * {Types::GetStreamGroupOutput#last_updated_at #last_updated_at} => Time
|
1484
|
+
# * {Types::GetStreamGroupOutput#default_application #default_application} => Types::DefaultApplication
|
1487
1485
|
# * {Types::GetStreamGroupOutput#location_states #location_states} => Array<Types::LocationState>
|
1486
|
+
# * {Types::GetStreamGroupOutput#stream_class #stream_class} => String
|
1487
|
+
# * {Types::GetStreamGroupOutput#id #id} => String
|
1488
1488
|
# * {Types::GetStreamGroupOutput#status #status} => String
|
1489
1489
|
# * {Types::GetStreamGroupOutput#status_reason #status_reason} => String
|
1490
|
-
# * {Types::GetStreamGroupOutput#
|
1490
|
+
# * {Types::GetStreamGroupOutput#last_updated_at #last_updated_at} => Time
|
1491
|
+
# * {Types::GetStreamGroupOutput#created_at #created_at} => Time
|
1492
|
+
# * {Types::GetStreamGroupOutput#associated_applications #associated_applications} => Array<String>
|
1491
1493
|
#
|
1492
1494
|
# @example Request syntax with placeholder values
|
1493
1495
|
#
|
@@ -1498,25 +1500,25 @@ module Aws::GameLiftStreams
|
|
1498
1500
|
# @example Response structure
|
1499
1501
|
#
|
1500
1502
|
# resp.arn #=> String
|
1501
|
-
# resp.associated_applications #=> Array
|
1502
|
-
# resp.associated_applications[0] #=> String
|
1503
|
-
# resp.created_at #=> Time
|
1504
|
-
# resp.default_application.arn #=> String
|
1505
|
-
# resp.default_application.id #=> String
|
1506
1503
|
# resp.description #=> String
|
1507
|
-
# resp.id #=> String
|
1508
|
-
# resp.
|
1504
|
+
# resp.default_application.id #=> String
|
1505
|
+
# resp.default_application.arn #=> String
|
1509
1506
|
# resp.location_states #=> Array
|
1510
|
-
# resp.location_states[0].allocated_capacity #=> Integer
|
1511
|
-
# resp.location_states[0].always_on_capacity #=> Integer
|
1512
|
-
# resp.location_states[0].idle_capacity #=> Integer
|
1513
1507
|
# resp.location_states[0].location_name #=> String
|
1508
|
+
# resp.location_states[0].status #=> String, one of "ACTIVATING", "ACTIVE", "ERROR", "REMOVING"
|
1509
|
+
# resp.location_states[0].always_on_capacity #=> Integer
|
1514
1510
|
# resp.location_states[0].on_demand_capacity #=> Integer
|
1515
1511
|
# resp.location_states[0].requested_capacity #=> Integer
|
1516
|
-
# resp.location_states[0].
|
1512
|
+
# resp.location_states[0].allocated_capacity #=> Integer
|
1513
|
+
# resp.location_states[0].idle_capacity #=> Integer
|
1514
|
+
# resp.stream_class #=> String, one of "gen4n_high", "gen4n_ultra", "gen4n_win2022", "gen5n_high", "gen5n_ultra", "gen5n_win2022"
|
1515
|
+
# resp.id #=> String
|
1517
1516
|
# resp.status #=> String, one of "ACTIVATING", "UPDATING_LOCATIONS", "ACTIVE", "ACTIVE_WITH_ERRORS", "ERROR", "DELETING"
|
1518
1517
|
# resp.status_reason #=> String, one of "internalError", "noAvailableInstances"
|
1519
|
-
# resp.
|
1518
|
+
# resp.last_updated_at #=> Time
|
1519
|
+
# resp.created_at #=> Time
|
1520
|
+
# resp.associated_applications #=> Array
|
1521
|
+
# resp.associated_applications[0] #=> String
|
1520
1522
|
#
|
1521
1523
|
#
|
1522
1524
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1562,26 +1564,26 @@ module Aws::GameLiftStreams
|
|
1562
1564
|
#
|
1563
1565
|
# @return [Types::GetStreamSessionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1564
1566
|
#
|
1565
|
-
# * {Types::GetStreamSessionOutput#additional_environment_variables #additional_environment_variables} => Hash<String,String>
|
1566
|
-
# * {Types::GetStreamSessionOutput#additional_launch_args #additional_launch_args} => Array<String>
|
1567
|
-
# * {Types::GetStreamSessionOutput#application_arn #application_arn} => String
|
1568
1567
|
# * {Types::GetStreamSessionOutput#arn #arn} => String
|
1569
|
-
# * {Types::GetStreamSessionOutput#connection_timeout_seconds #connection_timeout_seconds} => Integer
|
1570
|
-
# * {Types::GetStreamSessionOutput#created_at #created_at} => Time
|
1571
1568
|
# * {Types::GetStreamSessionOutput#description #description} => String
|
1572
|
-
# * {Types::GetStreamSessionOutput#
|
1573
|
-
# * {Types::GetStreamSessionOutput#
|
1574
|
-
# * {Types::GetStreamSessionOutput#
|
1575
|
-
# * {Types::GetStreamSessionOutput#
|
1569
|
+
# * {Types::GetStreamSessionOutput#stream_group_id #stream_group_id} => String
|
1570
|
+
# * {Types::GetStreamSessionOutput#user_id #user_id} => String
|
1571
|
+
# * {Types::GetStreamSessionOutput#status #status} => String
|
1572
|
+
# * {Types::GetStreamSessionOutput#status_reason #status_reason} => String
|
1576
1573
|
# * {Types::GetStreamSessionOutput#protocol #protocol} => String
|
1577
|
-
# * {Types::GetStreamSessionOutput#
|
1574
|
+
# * {Types::GetStreamSessionOutput#location #location} => String
|
1578
1575
|
# * {Types::GetStreamSessionOutput#signal_request #signal_request} => String
|
1579
1576
|
# * {Types::GetStreamSessionOutput#signal_response #signal_response} => String
|
1580
|
-
# * {Types::GetStreamSessionOutput#
|
1581
|
-
# * {Types::GetStreamSessionOutput#
|
1582
|
-
# * {Types::GetStreamSessionOutput#
|
1583
|
-
# * {Types::GetStreamSessionOutput#
|
1577
|
+
# * {Types::GetStreamSessionOutput#connection_timeout_seconds #connection_timeout_seconds} => Integer
|
1578
|
+
# * {Types::GetStreamSessionOutput#session_length_seconds #session_length_seconds} => Integer
|
1579
|
+
# * {Types::GetStreamSessionOutput#additional_launch_args #additional_launch_args} => Array<String>
|
1580
|
+
# * {Types::GetStreamSessionOutput#additional_environment_variables #additional_environment_variables} => Hash<String,String>
|
1581
|
+
# * {Types::GetStreamSessionOutput#log_file_location_uri #log_file_location_uri} => String
|
1584
1582
|
# * {Types::GetStreamSessionOutput#web_sdk_protocol_url #web_sdk_protocol_url} => String
|
1583
|
+
# * {Types::GetStreamSessionOutput#last_updated_at #last_updated_at} => Time
|
1584
|
+
# * {Types::GetStreamSessionOutput#created_at #created_at} => Time
|
1585
|
+
# * {Types::GetStreamSessionOutput#application_arn #application_arn} => String
|
1586
|
+
# * {Types::GetStreamSessionOutput#export_files_metadata #export_files_metadata} => Types::ExportFilesMetadata
|
1585
1587
|
#
|
1586
1588
|
# @example Request syntax with placeholder values
|
1587
1589
|
#
|
@@ -1592,30 +1594,30 @@ module Aws::GameLiftStreams
|
|
1592
1594
|
#
|
1593
1595
|
# @example Response structure
|
1594
1596
|
#
|
1595
|
-
# resp.additional_environment_variables #=> Hash
|
1596
|
-
# resp.additional_environment_variables["EnvironmentVariablesKeyString"] #=> String
|
1597
|
-
# resp.additional_launch_args #=> Array
|
1598
|
-
# resp.additional_launch_args[0] #=> String
|
1599
|
-
# resp.application_arn #=> String
|
1600
1597
|
# resp.arn #=> String
|
1601
|
-
# resp.connection_timeout_seconds #=> Integer
|
1602
|
-
# resp.created_at #=> Time
|
1603
1598
|
# resp.description #=> String
|
1604
|
-
# resp.
|
1605
|
-
# resp.
|
1606
|
-
# resp.
|
1607
|
-
# resp.
|
1608
|
-
# resp.location #=> String
|
1609
|
-
# resp.log_file_location_uri #=> String
|
1599
|
+
# resp.stream_group_id #=> String
|
1600
|
+
# resp.user_id #=> String
|
1601
|
+
# resp.status #=> String, one of "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR"
|
1602
|
+
# resp.status_reason #=> String, one of "internalError", "invalidSignalRequest", "placementTimeout", "applicationLogS3DestinationError"
|
1610
1603
|
# resp.protocol #=> String, one of "WebRTC"
|
1611
|
-
# resp.
|
1604
|
+
# resp.location #=> String
|
1612
1605
|
# resp.signal_request #=> String
|
1613
1606
|
# resp.signal_response #=> String
|
1614
|
-
# resp.
|
1615
|
-
# resp.
|
1616
|
-
# resp.
|
1617
|
-
# resp.
|
1607
|
+
# resp.connection_timeout_seconds #=> Integer
|
1608
|
+
# resp.session_length_seconds #=> Integer
|
1609
|
+
# resp.additional_launch_args #=> Array
|
1610
|
+
# resp.additional_launch_args[0] #=> String
|
1611
|
+
# resp.additional_environment_variables #=> Hash
|
1612
|
+
# resp.additional_environment_variables["EnvironmentVariablesKeyString"] #=> String
|
1613
|
+
# resp.log_file_location_uri #=> String
|
1618
1614
|
# resp.web_sdk_protocol_url #=> String
|
1615
|
+
# resp.last_updated_at #=> Time
|
1616
|
+
# resp.created_at #=> Time
|
1617
|
+
# resp.application_arn #=> String
|
1618
|
+
# resp.export_files_metadata.status #=> String, one of "SUCCEEDED", "FAILED", "PENDING"
|
1619
|
+
# resp.export_files_metadata.status_reason #=> String
|
1620
|
+
# resp.export_files_metadata.output_uri #=> String
|
1619
1621
|
#
|
1620
1622
|
#
|
1621
1623
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1636,16 +1638,16 @@ module Aws::GameLiftStreams
|
|
1636
1638
|
# returns applications in all statuses, in no particular order. You can
|
1637
1639
|
# paginate the results as needed.
|
1638
1640
|
#
|
1639
|
-
# @option params [Integer] :max_results
|
1640
|
-
# The number of results to return. Use this parameter with `NextToken`
|
1641
|
-
# to return results in sequential pages. Default value is `25`.
|
1642
|
-
#
|
1643
1641
|
# @option params [String] :next_token
|
1644
1642
|
# The token that marks the start of the next set of results. Use this
|
1645
1643
|
# token when you retrieve results as sequential pages. To get the first
|
1646
1644
|
# page of results, omit a token value. To get the remaining pages,
|
1647
1645
|
# provide the token returned with the previous result set.
|
1648
1646
|
#
|
1647
|
+
# @option params [Integer] :max_results
|
1648
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1649
|
+
# to return results in sequential pages. Default value is `25`.
|
1650
|
+
#
|
1649
1651
|
# @return [Types::ListApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1650
1652
|
#
|
1651
1653
|
# * {Types::ListApplicationsOutput#items #items} => Array<Types::ApplicationSummary>
|
@@ -1656,21 +1658,21 @@ module Aws::GameLiftStreams
|
|
1656
1658
|
# @example Request syntax with placeholder values
|
1657
1659
|
#
|
1658
1660
|
# resp = client.list_applications({
|
1659
|
-
# max_results: 1,
|
1660
1661
|
# next_token: "NextToken",
|
1662
|
+
# max_results: 1,
|
1661
1663
|
# })
|
1662
1664
|
#
|
1663
1665
|
# @example Response structure
|
1664
1666
|
#
|
1665
1667
|
# resp.items #=> Array
|
1666
1668
|
# resp.items[0].arn #=> String
|
1667
|
-
# resp.items[0].created_at #=> Time
|
1668
|
-
# resp.items[0].description #=> String
|
1669
1669
|
# resp.items[0].id #=> String
|
1670
|
+
# resp.items[0].description #=> String
|
1671
|
+
# resp.items[0].status #=> String, one of "INITIALIZED", "PROCESSING", "READY", "DELETING", "ERROR"
|
1672
|
+
# resp.items[0].created_at #=> Time
|
1670
1673
|
# resp.items[0].last_updated_at #=> Time
|
1671
1674
|
# resp.items[0].runtime_environment.type #=> String, one of "PROTON", "WINDOWS", "UBUNTU"
|
1672
1675
|
# resp.items[0].runtime_environment.version #=> String
|
1673
|
-
# resp.items[0].status #=> String, one of "INITIALIZED", "PROCESSING", "READY", "DELETING", "ERROR"
|
1674
1676
|
# resp.next_token #=> String
|
1675
1677
|
#
|
1676
1678
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListApplications AWS API Documentation
|
@@ -1687,16 +1689,16 @@ module Aws::GameLiftStreams
|
|
1687
1689
|
# returns stream groups in all statuses, in no particular order. You can
|
1688
1690
|
# paginate the results as needed.
|
1689
1691
|
#
|
1690
|
-
# @option params [Integer] :max_results
|
1691
|
-
# The number of results to return. Use this parameter with `NextToken`
|
1692
|
-
# to return results in sequential pages. Default value is `25`.
|
1693
|
-
#
|
1694
1692
|
# @option params [String] :next_token
|
1695
1693
|
# A token that marks the start of the next set of results. Use this
|
1696
1694
|
# token when you retrieve results as sequential pages. To get the first
|
1697
1695
|
# page of results, omit a token value. To get the remaining pages,
|
1698
1696
|
# provide the token returned with the previous result set.
|
1699
1697
|
#
|
1698
|
+
# @option params [Integer] :max_results
|
1699
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1700
|
+
# to return results in sequential pages. Default value is `25`.
|
1701
|
+
#
|
1700
1702
|
# @return [Types::ListStreamGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1701
1703
|
#
|
1702
1704
|
# * {Types::ListStreamGroupsOutput#items #items} => Array<Types::StreamGroupSummary>
|
@@ -1707,22 +1709,22 @@ module Aws::GameLiftStreams
|
|
1707
1709
|
# @example Request syntax with placeholder values
|
1708
1710
|
#
|
1709
1711
|
# resp = client.list_stream_groups({
|
1710
|
-
# max_results: 1,
|
1711
1712
|
# next_token: "NextToken",
|
1713
|
+
# max_results: 1,
|
1712
1714
|
# })
|
1713
1715
|
#
|
1714
1716
|
# @example Response structure
|
1715
1717
|
#
|
1716
1718
|
# resp.items #=> Array
|
1717
1719
|
# resp.items[0].arn #=> String
|
1718
|
-
# resp.items[0].created_at #=> Time
|
1719
|
-
# resp.items[0].default_application.arn #=> String
|
1720
|
-
# resp.items[0].default_application.id #=> String
|
1721
|
-
# resp.items[0].description #=> String
|
1722
1720
|
# resp.items[0].id #=> String
|
1723
|
-
# resp.items[0].
|
1724
|
-
# resp.items[0].
|
1721
|
+
# resp.items[0].description #=> String
|
1722
|
+
# resp.items[0].default_application.id #=> String
|
1723
|
+
# resp.items[0].default_application.arn #=> String
|
1725
1724
|
# resp.items[0].stream_class #=> String, one of "gen4n_high", "gen4n_ultra", "gen4n_win2022", "gen5n_high", "gen5n_ultra", "gen5n_win2022"
|
1725
|
+
# resp.items[0].status #=> String, one of "ACTIVATING", "UPDATING_LOCATIONS", "ACTIVE", "ACTIVE_WITH_ERRORS", "ERROR", "DELETING"
|
1726
|
+
# resp.items[0].created_at #=> Time
|
1727
|
+
# resp.items[0].last_updated_at #=> Time
|
1726
1728
|
# resp.next_token #=> String
|
1727
1729
|
#
|
1728
1730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamGroups AWS API Documentation
|
@@ -1744,6 +1746,11 @@ module Aws::GameLiftStreams
|
|
1744
1746
|
# This operation returns the requested stream sessions in no particular
|
1745
1747
|
# order.
|
1746
1748
|
#
|
1749
|
+
# @option params [String] :status
|
1750
|
+
# Filter by the stream session status. You can specify one status in
|
1751
|
+
# each request to retrieve only sessions that are currently in that
|
1752
|
+
# status.
|
1753
|
+
#
|
1747
1754
|
# @option params [String] :export_files_status
|
1748
1755
|
# Filter by the exported files status. You can specify one status in
|
1749
1756
|
# each request to retrieve only sessions that currently have that
|
@@ -1760,6 +1767,16 @@ module Aws::GameLiftStreams
|
|
1760
1767
|
# * **PENDING**: Either the stream session is still in progress, or
|
1761
1768
|
# uploading the exported files to the S3 bucket is in progress.
|
1762
1769
|
#
|
1770
|
+
# @option params [String] :next_token
|
1771
|
+
# The token that marks the start of the next set of results. Use this
|
1772
|
+
# token when you retrieve results as sequential pages. To get the first
|
1773
|
+
# page of results, omit a token value. To get the remaining pages,
|
1774
|
+
# provide the token returned with the previous result set.
|
1775
|
+
#
|
1776
|
+
# @option params [Integer] :max_results
|
1777
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1778
|
+
# to return results in sequential pages. Default value is `25`.
|
1779
|
+
#
|
1763
1780
|
# @option params [required, String] :identifier
|
1764
1781
|
# The unique identifier of a Amazon GameLift Streams stream group to
|
1765
1782
|
# retrieve the stream session for. You can use either the stream group
|
@@ -1769,21 +1786,6 @@ module Aws::GameLiftStreams
|
|
1769
1786
|
#
|
1770
1787
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1771
1788
|
#
|
1772
|
-
# @option params [Integer] :max_results
|
1773
|
-
# The number of results to return. Use this parameter with `NextToken`
|
1774
|
-
# to return results in sequential pages. Default value is `25`.
|
1775
|
-
#
|
1776
|
-
# @option params [String] :next_token
|
1777
|
-
# The token that marks the start of the next set of results. Use this
|
1778
|
-
# token when you retrieve results as sequential pages. To get the first
|
1779
|
-
# page of results, omit a token value. To get the remaining pages,
|
1780
|
-
# provide the token returned with the previous result set.
|
1781
|
-
#
|
1782
|
-
# @option params [String] :status
|
1783
|
-
# Filter by the stream session status. You can specify one status in
|
1784
|
-
# each request to retrieve only sessions that are currently in that
|
1785
|
-
# status.
|
1786
|
-
#
|
1787
1789
|
# @return [Types::ListStreamSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1788
1790
|
#
|
1789
1791
|
# * {Types::ListStreamSessionsOutput#items #items} => Array<Types::StreamSessionSummary>
|
@@ -1794,27 +1796,27 @@ module Aws::GameLiftStreams
|
|
1794
1796
|
# @example Request syntax with placeholder values
|
1795
1797
|
#
|
1796
1798
|
# resp = client.list_stream_sessions({
|
1799
|
+
# status: "ACTIVATING", # accepts ACTIVATING, ACTIVE, CONNECTED, PENDING_CLIENT_RECONNECTION, RECONNECTING, TERMINATING, TERMINATED, ERROR
|
1797
1800
|
# export_files_status: "SUCCEEDED", # accepts SUCCEEDED, FAILED, PENDING
|
1798
|
-
# identifier: "Identifier", # required
|
1799
|
-
# max_results: 1,
|
1800
1801
|
# next_token: "NextToken",
|
1801
|
-
#
|
1802
|
+
# max_results: 1,
|
1803
|
+
# identifier: "Identifier", # required
|
1802
1804
|
# })
|
1803
1805
|
#
|
1804
1806
|
# @example Response structure
|
1805
1807
|
#
|
1806
1808
|
# resp.items #=> Array
|
1807
|
-
# resp.items[0].application_arn #=> String
|
1808
1809
|
# resp.items[0].arn #=> String
|
1810
|
+
# resp.items[0].user_id #=> String
|
1811
|
+
# resp.items[0].status #=> String, one of "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR"
|
1812
|
+
# resp.items[0].protocol #=> String, one of "WebRTC"
|
1813
|
+
# resp.items[0].last_updated_at #=> Time
|
1809
1814
|
# resp.items[0].created_at #=> Time
|
1810
|
-
# resp.items[0].
|
1815
|
+
# resp.items[0].application_arn #=> String
|
1811
1816
|
# resp.items[0].export_files_metadata.status #=> String, one of "SUCCEEDED", "FAILED", "PENDING"
|
1812
1817
|
# resp.items[0].export_files_metadata.status_reason #=> String
|
1813
|
-
# resp.items[0].
|
1818
|
+
# resp.items[0].export_files_metadata.output_uri #=> String
|
1814
1819
|
# resp.items[0].location #=> String
|
1815
|
-
# resp.items[0].protocol #=> String, one of "WebRTC"
|
1816
|
-
# resp.items[0].status #=> String, one of "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR"
|
1817
|
-
# resp.items[0].user_id #=> String
|
1818
1820
|
# resp.next_token #=> String
|
1819
1821
|
#
|
1820
1822
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamSessions AWS API Documentation
|
@@ -1841,25 +1843,25 @@ module Aws::GameLiftStreams
|
|
1841
1843
|
#
|
1842
1844
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
|
1843
1845
|
#
|
1846
|
+
# @option params [String] :status
|
1847
|
+
# Filter by the stream session status. You can specify one status in
|
1848
|
+
# each request to retrieve only sessions that are currently in that
|
1849
|
+
# status.
|
1850
|
+
#
|
1844
1851
|
# @option params [String] :export_files_status
|
1845
1852
|
# Filter by the exported files status. You can specify one status in
|
1846
1853
|
# each request to retrieve only sessions that currently have that
|
1847
1854
|
# exported files status.
|
1848
1855
|
#
|
1849
|
-
# @option params [Integer] :max_results
|
1850
|
-
# The number of results to return. Use this parameter with `NextToken`
|
1851
|
-
# to return results in sequential pages. Default value is `25`.
|
1852
|
-
#
|
1853
1856
|
# @option params [String] :next_token
|
1854
1857
|
# The token that marks the start of the next set of results. Use this
|
1855
1858
|
# token when you retrieve results as sequential pages. To get the first
|
1856
1859
|
# page of results, omit a token value. To get the remaining pages,
|
1857
1860
|
# provide the token returned with the previous result set.
|
1858
1861
|
#
|
1859
|
-
# @option params [
|
1860
|
-
#
|
1861
|
-
#
|
1862
|
-
# status.
|
1862
|
+
# @option params [Integer] :max_results
|
1863
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1864
|
+
# to return results in sequential pages. Default value is `25`.
|
1863
1865
|
#
|
1864
1866
|
# @return [Types::ListStreamSessionsByAccountOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1865
1867
|
#
|
@@ -1871,26 +1873,26 @@ module Aws::GameLiftStreams
|
|
1871
1873
|
# @example Request syntax with placeholder values
|
1872
1874
|
#
|
1873
1875
|
# resp = client.list_stream_sessions_by_account({
|
1876
|
+
# status: "ACTIVATING", # accepts ACTIVATING, ACTIVE, CONNECTED, PENDING_CLIENT_RECONNECTION, RECONNECTING, TERMINATING, TERMINATED, ERROR
|
1874
1877
|
# export_files_status: "SUCCEEDED", # accepts SUCCEEDED, FAILED, PENDING
|
1875
|
-
# max_results: 1,
|
1876
1878
|
# next_token: "NextToken",
|
1877
|
-
#
|
1879
|
+
# max_results: 1,
|
1878
1880
|
# })
|
1879
1881
|
#
|
1880
1882
|
# @example Response structure
|
1881
1883
|
#
|
1882
1884
|
# resp.items #=> Array
|
1883
|
-
# resp.items[0].application_arn #=> String
|
1884
1885
|
# resp.items[0].arn #=> String
|
1886
|
+
# resp.items[0].user_id #=> String
|
1887
|
+
# resp.items[0].status #=> String, one of "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR"
|
1888
|
+
# resp.items[0].protocol #=> String, one of "WebRTC"
|
1889
|
+
# resp.items[0].last_updated_at #=> Time
|
1885
1890
|
# resp.items[0].created_at #=> Time
|
1886
|
-
# resp.items[0].
|
1891
|
+
# resp.items[0].application_arn #=> String
|
1887
1892
|
# resp.items[0].export_files_metadata.status #=> String, one of "SUCCEEDED", "FAILED", "PENDING"
|
1888
1893
|
# resp.items[0].export_files_metadata.status_reason #=> String
|
1889
|
-
# resp.items[0].
|
1894
|
+
# resp.items[0].export_files_metadata.output_uri #=> String
|
1890
1895
|
# resp.items[0].location #=> String
|
1891
|
-
# resp.items[0].protocol #=> String, one of "WebRTC"
|
1892
|
-
# resp.items[0].status #=> String, one of "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR"
|
1893
|
-
# resp.items[0].user_id #=> String
|
1894
1896
|
# resp.next_token #=> String
|
1895
1897
|
#
|
1896
1898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamSessionsByAccount AWS API Documentation
|
@@ -2044,46 +2046,6 @@ module Aws::GameLiftStreams
|
|
2044
2046
|
#
|
2045
2047
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
|
2046
2048
|
#
|
2047
|
-
# @option params [Hash<String,String>] :additional_environment_variables
|
2048
|
-
# A set of options that you can use to control the stream session
|
2049
|
-
# runtime environment, expressed as a set of key-value pairs. You can
|
2050
|
-
# use this to configure the application or stream session details. You
|
2051
|
-
# can also provide custom environment variables that Amazon GameLift
|
2052
|
-
# Streams passes to your game client.
|
2053
|
-
#
|
2054
|
-
# <note markdown="1"> If you want to debug your application with environment variables, we
|
2055
|
-
# recommend that you do so in a local environment outside of Amazon
|
2056
|
-
# GameLift Streams. For more information, refer to the Compatibility
|
2057
|
-
# Guidance in the troubleshooting section of the Developer Guide.
|
2058
|
-
#
|
2059
|
-
# </note>
|
2060
|
-
#
|
2061
|
-
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2062
|
-
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2063
|
-
# environment variables; while `AdditionalLaunchArgs` passes data using
|
2064
|
-
# command-line arguments.
|
2065
|
-
#
|
2066
|
-
# @option params [Array<String>] :additional_launch_args
|
2067
|
-
# A list of CLI arguments that are sent to the streaming server when a
|
2068
|
-
# stream session launches. You can use this to configure the application
|
2069
|
-
# or stream session details. You can also provide custom arguments that
|
2070
|
-
# Amazon GameLift Streams passes to your game client.
|
2071
|
-
#
|
2072
|
-
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2073
|
-
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2074
|
-
# environment variables; while `AdditionalLaunchArgs` passes data using
|
2075
|
-
# command-line arguments.
|
2076
|
-
#
|
2077
|
-
# @option params [required, String] :application_identifier
|
2078
|
-
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2079
|
-
# application resource. Example ARN:
|
2080
|
-
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
2081
|
-
# Example ID: `a-9ZY8X7Wv6`.
|
2082
|
-
#
|
2083
|
-
#
|
2084
|
-
#
|
2085
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2086
|
-
#
|
2087
2049
|
# @option params [String] :client_token
|
2088
2050
|
# A unique identifier that represents a client request. The request is
|
2089
2051
|
# idempotent, which ensures that an API request completes only once.
|
@@ -2093,13 +2055,6 @@ module Aws::GameLiftStreams
|
|
2093
2055
|
# **A suitable default value is auto-generated.** You should normally
|
2094
2056
|
# not need to pass this option.**
|
2095
2057
|
#
|
2096
|
-
# @option params [Integer] :connection_timeout_seconds
|
2097
|
-
# Length of time (in seconds) that Amazon GameLift Streams should wait
|
2098
|
-
# for a client to connect to the stream session. This time span starts
|
2099
|
-
# when the stream session reaches `ACTIVE` status. If no client connects
|
2100
|
-
# before the timeout, Amazon GameLift Streams stops the stream session
|
2101
|
-
# with status of `TERMINATED`. Default value is 120.
|
2102
|
-
#
|
2103
2058
|
# @option params [String] :description
|
2104
2059
|
# A human-readable label for the stream session. You can update this
|
2105
2060
|
# value later.
|
@@ -2116,6 +2071,38 @@ module Aws::GameLiftStreams
|
|
2116
2071
|
#
|
2117
2072
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2118
2073
|
#
|
2074
|
+
# @option params [required, String] :protocol
|
2075
|
+
# The data transport protocol to use for the stream session.
|
2076
|
+
#
|
2077
|
+
# @option params [required, String] :signal_request
|
2078
|
+
# A WebRTC ICE offer string to use when initializing a WebRTC
|
2079
|
+
# connection. Typically, the offer is a very long JSON string. Provide
|
2080
|
+
# the string as a text value in quotes.
|
2081
|
+
#
|
2082
|
+
# Amazon GameLift Streams also supports setting the field to
|
2083
|
+
# "NO\_CLIENT\_CONNECTION". This will create a session without needing
|
2084
|
+
# any browser request or Web SDK integration. The session starts up as
|
2085
|
+
# usual and waits for a reconnection from a browser, which is
|
2086
|
+
# accomplished using [CreateStreamSessionConnection][1].
|
2087
|
+
#
|
2088
|
+
#
|
2089
|
+
#
|
2090
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html
|
2091
|
+
#
|
2092
|
+
# @option params [required, String] :application_identifier
|
2093
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2094
|
+
# application resource. Example ARN:
|
2095
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
2096
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
2097
|
+
#
|
2098
|
+
#
|
2099
|
+
#
|
2100
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2101
|
+
#
|
2102
|
+
# @option params [String] :user_id
|
2103
|
+
# An opaque, unique identifier for an end-user, defined by the
|
2104
|
+
# developer.
|
2105
|
+
#
|
2119
2106
|
# @option params [Array<String>] :locations
|
2120
2107
|
# A list of locations, in order of priority, where you want Amazon
|
2121
2108
|
# GameLift Streams to start a stream from. Amazon GameLift Streams
|
@@ -2132,8 +2119,12 @@ module Aws::GameLiftStreams
|
|
2132
2119
|
#
|
2133
2120
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
|
2134
2121
|
#
|
2135
|
-
# @option params [
|
2136
|
-
#
|
2122
|
+
# @option params [Integer] :connection_timeout_seconds
|
2123
|
+
# Length of time (in seconds) that Amazon GameLift Streams should wait
|
2124
|
+
# for a client to connect or reconnect to the stream session. This time
|
2125
|
+
# span starts when the stream session reaches `ACTIVE` status. If no
|
2126
|
+
# client connects before the timeout, Amazon GameLift Streams stops the
|
2127
|
+
# stream session with status of `TERMINATED`. Default value is 120.
|
2137
2128
|
#
|
2138
2129
|
# @option params [Integer] :session_length_seconds
|
2139
2130
|
# The maximum length of time (in seconds) that Amazon GameLift Streams
|
@@ -2141,93 +2132,104 @@ module Aws::GameLiftStreams
|
|
2141
2132
|
# ends the stream session regardless of any existing client connections.
|
2142
2133
|
# Default value is 43200.
|
2143
2134
|
#
|
2144
|
-
# @option params [
|
2145
|
-
# A
|
2146
|
-
#
|
2147
|
-
#
|
2135
|
+
# @option params [Array<String>] :additional_launch_args
|
2136
|
+
# A list of CLI arguments that are sent to the streaming server when a
|
2137
|
+
# stream session launches. You can use this to configure the application
|
2138
|
+
# or stream session details. You can also provide custom arguments that
|
2139
|
+
# Amazon GameLift Streams passes to your game client.
|
2148
2140
|
#
|
2149
|
-
#
|
2150
|
-
#
|
2151
|
-
#
|
2152
|
-
#
|
2153
|
-
# accomplished using [CreateStreamSessionConnection][1].
|
2141
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2142
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2143
|
+
# environment variables; while `AdditionalLaunchArgs` passes data using
|
2144
|
+
# command-line arguments.
|
2154
2145
|
#
|
2146
|
+
# @option params [Hash<String,String>] :additional_environment_variables
|
2147
|
+
# A set of options that you can use to control the stream session
|
2148
|
+
# runtime environment, expressed as a set of key-value pairs. You can
|
2149
|
+
# use this to configure the application or stream session details. You
|
2150
|
+
# can also provide custom environment variables that Amazon GameLift
|
2151
|
+
# Streams passes to your game client.
|
2155
2152
|
#
|
2153
|
+
# <note markdown="1"> If you want to debug your application with environment variables, we
|
2154
|
+
# recommend that you do so in a local environment outside of Amazon
|
2155
|
+
# GameLift Streams. For more information, refer to the Compatibility
|
2156
|
+
# Guidance in the troubleshooting section of the Developer Guide.
|
2156
2157
|
#
|
2157
|
-
#
|
2158
|
+
# </note>
|
2158
2159
|
#
|
2159
|
-
#
|
2160
|
-
#
|
2161
|
-
#
|
2160
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2161
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2162
|
+
# environment variables; while `AdditionalLaunchArgs` passes data using
|
2163
|
+
# command-line arguments.
|
2162
2164
|
#
|
2163
2165
|
# @return [Types::StartStreamSessionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2164
2166
|
#
|
2165
|
-
# * {Types::StartStreamSessionOutput#additional_environment_variables #additional_environment_variables} => Hash<String,String>
|
2166
|
-
# * {Types::StartStreamSessionOutput#additional_launch_args #additional_launch_args} => Array<String>
|
2167
|
-
# * {Types::StartStreamSessionOutput#application_arn #application_arn} => String
|
2168
2167
|
# * {Types::StartStreamSessionOutput#arn #arn} => String
|
2169
|
-
# * {Types::StartStreamSessionOutput#connection_timeout_seconds #connection_timeout_seconds} => Integer
|
2170
|
-
# * {Types::StartStreamSessionOutput#created_at #created_at} => Time
|
2171
2168
|
# * {Types::StartStreamSessionOutput#description #description} => String
|
2172
|
-
# * {Types::StartStreamSessionOutput#
|
2173
|
-
# * {Types::StartStreamSessionOutput#
|
2174
|
-
# * {Types::StartStreamSessionOutput#
|
2175
|
-
# * {Types::StartStreamSessionOutput#
|
2169
|
+
# * {Types::StartStreamSessionOutput#stream_group_id #stream_group_id} => String
|
2170
|
+
# * {Types::StartStreamSessionOutput#user_id #user_id} => String
|
2171
|
+
# * {Types::StartStreamSessionOutput#status #status} => String
|
2172
|
+
# * {Types::StartStreamSessionOutput#status_reason #status_reason} => String
|
2176
2173
|
# * {Types::StartStreamSessionOutput#protocol #protocol} => String
|
2177
|
-
# * {Types::StartStreamSessionOutput#
|
2174
|
+
# * {Types::StartStreamSessionOutput#location #location} => String
|
2178
2175
|
# * {Types::StartStreamSessionOutput#signal_request #signal_request} => String
|
2179
2176
|
# * {Types::StartStreamSessionOutput#signal_response #signal_response} => String
|
2180
|
-
# * {Types::StartStreamSessionOutput#
|
2181
|
-
# * {Types::StartStreamSessionOutput#
|
2182
|
-
# * {Types::StartStreamSessionOutput#
|
2183
|
-
# * {Types::StartStreamSessionOutput#
|
2177
|
+
# * {Types::StartStreamSessionOutput#connection_timeout_seconds #connection_timeout_seconds} => Integer
|
2178
|
+
# * {Types::StartStreamSessionOutput#session_length_seconds #session_length_seconds} => Integer
|
2179
|
+
# * {Types::StartStreamSessionOutput#additional_launch_args #additional_launch_args} => Array<String>
|
2180
|
+
# * {Types::StartStreamSessionOutput#additional_environment_variables #additional_environment_variables} => Hash<String,String>
|
2181
|
+
# * {Types::StartStreamSessionOutput#log_file_location_uri #log_file_location_uri} => String
|
2184
2182
|
# * {Types::StartStreamSessionOutput#web_sdk_protocol_url #web_sdk_protocol_url} => String
|
2183
|
+
# * {Types::StartStreamSessionOutput#last_updated_at #last_updated_at} => Time
|
2184
|
+
# * {Types::StartStreamSessionOutput#created_at #created_at} => Time
|
2185
|
+
# * {Types::StartStreamSessionOutput#application_arn #application_arn} => String
|
2186
|
+
# * {Types::StartStreamSessionOutput#export_files_metadata #export_files_metadata} => Types::ExportFilesMetadata
|
2185
2187
|
#
|
2186
2188
|
# @example Request syntax with placeholder values
|
2187
2189
|
#
|
2188
2190
|
# resp = client.start_stream_session({
|
2189
|
-
# additional_environment_variables: {
|
2190
|
-
# "EnvironmentVariablesKeyString" => "EnvironmentVariablesValueString",
|
2191
|
-
# },
|
2192
|
-
# additional_launch_args: ["String"],
|
2193
|
-
# application_identifier: "Identifier", # required
|
2194
2191
|
# client_token: "ClientToken",
|
2195
|
-
# connection_timeout_seconds: 1,
|
2196
2192
|
# description: "Description",
|
2197
2193
|
# identifier: "Identifier", # required
|
2198
|
-
# locations: ["LocationName"],
|
2199
2194
|
# protocol: "WebRTC", # required, accepts WebRTC
|
2200
|
-
# session_length_seconds: 1,
|
2201
2195
|
# signal_request: "SignalRequest", # required
|
2196
|
+
# application_identifier: "Identifier", # required
|
2202
2197
|
# user_id: "UserId",
|
2198
|
+
# locations: ["LocationName"],
|
2199
|
+
# connection_timeout_seconds: 1,
|
2200
|
+
# session_length_seconds: 1,
|
2201
|
+
# additional_launch_args: ["String"],
|
2202
|
+
# additional_environment_variables: {
|
2203
|
+
# "EnvironmentVariablesKeyString" => "EnvironmentVariablesValueString",
|
2204
|
+
# },
|
2203
2205
|
# })
|
2204
2206
|
#
|
2205
2207
|
# @example Response structure
|
2206
2208
|
#
|
2207
|
-
# resp.additional_environment_variables #=> Hash
|
2208
|
-
# resp.additional_environment_variables["EnvironmentVariablesKeyString"] #=> String
|
2209
|
-
# resp.additional_launch_args #=> Array
|
2210
|
-
# resp.additional_launch_args[0] #=> String
|
2211
|
-
# resp.application_arn #=> String
|
2212
2209
|
# resp.arn #=> String
|
2213
|
-
# resp.connection_timeout_seconds #=> Integer
|
2214
|
-
# resp.created_at #=> Time
|
2215
2210
|
# resp.description #=> String
|
2216
|
-
# resp.
|
2217
|
-
# resp.
|
2218
|
-
# resp.
|
2219
|
-
# resp.
|
2220
|
-
# resp.location #=> String
|
2221
|
-
# resp.log_file_location_uri #=> String
|
2211
|
+
# resp.stream_group_id #=> String
|
2212
|
+
# resp.user_id #=> String
|
2213
|
+
# resp.status #=> String, one of "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR"
|
2214
|
+
# resp.status_reason #=> String, one of "internalError", "invalidSignalRequest", "placementTimeout", "applicationLogS3DestinationError"
|
2222
2215
|
# resp.protocol #=> String, one of "WebRTC"
|
2223
|
-
# resp.
|
2216
|
+
# resp.location #=> String
|
2224
2217
|
# resp.signal_request #=> String
|
2225
2218
|
# resp.signal_response #=> String
|
2226
|
-
# resp.
|
2227
|
-
# resp.
|
2228
|
-
# resp.
|
2229
|
-
# resp.
|
2219
|
+
# resp.connection_timeout_seconds #=> Integer
|
2220
|
+
# resp.session_length_seconds #=> Integer
|
2221
|
+
# resp.additional_launch_args #=> Array
|
2222
|
+
# resp.additional_launch_args[0] #=> String
|
2223
|
+
# resp.additional_environment_variables #=> Hash
|
2224
|
+
# resp.additional_environment_variables["EnvironmentVariablesKeyString"] #=> String
|
2225
|
+
# resp.log_file_location_uri #=> String
|
2230
2226
|
# resp.web_sdk_protocol_url #=> String
|
2227
|
+
# resp.last_updated_at #=> Time
|
2228
|
+
# resp.created_at #=> Time
|
2229
|
+
# resp.application_arn #=> String
|
2230
|
+
# resp.export_files_metadata.status #=> String, one of "SUCCEEDED", "FAILED", "PENDING"
|
2231
|
+
# resp.export_files_metadata.status_reason #=> String
|
2232
|
+
# resp.export_files_metadata.output_uri #=> String
|
2231
2233
|
#
|
2232
2234
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/StartStreamSession AWS API Documentation
|
2233
2235
|
#
|
@@ -2378,21 +2380,18 @@ module Aws::GameLiftStreams
|
|
2378
2380
|
# the new values. If the operation is successful, it returns the
|
2379
2381
|
# complete updated set of settings for the application.
|
2380
2382
|
#
|
2381
|
-
# @option params [String] :
|
2382
|
-
# An Amazon
|
2383
|
-
#
|
2384
|
-
# `
|
2385
|
-
#
|
2386
|
-
# <note markdown="1"> The log bucket must have permissions that give Amazon GameLift Streams
|
2387
|
-
# access to write the log files. For more information, see [Application
|
2388
|
-
# log bucket permission policy][1] in the *Amazon GameLift Streams
|
2389
|
-
# Developer Guide*.
|
2383
|
+
# @option params [required, String] :identifier
|
2384
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2385
|
+
# application resource. Example ARN:
|
2386
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
2387
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
2390
2388
|
#
|
2391
|
-
# </note>
|
2392
2389
|
#
|
2393
2390
|
#
|
2391
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2394
2392
|
#
|
2395
|
-
#
|
2393
|
+
# @option params [String] :description
|
2394
|
+
# A human-readable label for the application.
|
2396
2395
|
#
|
2397
2396
|
# @option params [Array<String>] :application_log_paths
|
2398
2397
|
# Locations of log files that your content generates during a stream
|
@@ -2407,66 +2406,69 @@ module Aws::GameLiftStreams
|
|
2407
2406
|
#
|
2408
2407
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html
|
2409
2408
|
#
|
2410
|
-
# @option params [String] :
|
2411
|
-
#
|
2409
|
+
# @option params [String] :application_log_output_uri
|
2410
|
+
# An Amazon S3 URI to a bucket where you would like Amazon GameLift
|
2411
|
+
# Streams to save application logs. Required if you specify one or more
|
2412
|
+
# `ApplicationLogPaths`.
|
2412
2413
|
#
|
2413
|
-
#
|
2414
|
-
#
|
2415
|
-
#
|
2416
|
-
#
|
2417
|
-
# Example ID: `a-9ZY8X7Wv6`.
|
2414
|
+
# <note markdown="1"> The log bucket must have permissions that give Amazon GameLift Streams
|
2415
|
+
# access to write the log files. For more information, see [Application
|
2416
|
+
# log bucket permission policy][1] in the *Amazon GameLift Streams
|
2417
|
+
# Developer Guide*.
|
2418
2418
|
#
|
2419
|
+
# </note>
|
2419
2420
|
#
|
2420
2421
|
#
|
2421
|
-
#
|
2422
|
+
#
|
2423
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
|
2422
2424
|
#
|
2423
2425
|
# @return [Types::UpdateApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2424
2426
|
#
|
2425
|
-
# * {Types::UpdateApplicationOutput#application_log_output_uri #application_log_output_uri} => String
|
2426
|
-
# * {Types::UpdateApplicationOutput#application_log_paths #application_log_paths} => Array<String>
|
2427
|
-
# * {Types::UpdateApplicationOutput#application_source_uri #application_source_uri} => String
|
2428
2427
|
# * {Types::UpdateApplicationOutput#arn #arn} => String
|
2429
|
-
# * {Types::UpdateApplicationOutput#associated_stream_groups #associated_stream_groups} => Array<String>
|
2430
|
-
# * {Types::UpdateApplicationOutput#created_at #created_at} => Time
|
2431
2428
|
# * {Types::UpdateApplicationOutput#description #description} => String
|
2429
|
+
# * {Types::UpdateApplicationOutput#runtime_environment #runtime_environment} => Types::RuntimeEnvironment
|
2432
2430
|
# * {Types::UpdateApplicationOutput#executable_path #executable_path} => String
|
2431
|
+
# * {Types::UpdateApplicationOutput#application_log_paths #application_log_paths} => Array<String>
|
2432
|
+
# * {Types::UpdateApplicationOutput#application_log_output_uri #application_log_output_uri} => String
|
2433
|
+
# * {Types::UpdateApplicationOutput#application_source_uri #application_source_uri} => String
|
2433
2434
|
# * {Types::UpdateApplicationOutput#id #id} => String
|
2434
|
-
# * {Types::UpdateApplicationOutput#last_updated_at #last_updated_at} => Time
|
2435
|
-
# * {Types::UpdateApplicationOutput#replication_statuses #replication_statuses} => Array<Types::ReplicationStatus>
|
2436
|
-
# * {Types::UpdateApplicationOutput#runtime_environment #runtime_environment} => Types::RuntimeEnvironment
|
2437
2435
|
# * {Types::UpdateApplicationOutput#status #status} => String
|
2438
2436
|
# * {Types::UpdateApplicationOutput#status_reason #status_reason} => String
|
2437
|
+
# * {Types::UpdateApplicationOutput#replication_statuses #replication_statuses} => Array<Types::ReplicationStatus>
|
2438
|
+
# * {Types::UpdateApplicationOutput#created_at #created_at} => Time
|
2439
|
+
# * {Types::UpdateApplicationOutput#last_updated_at #last_updated_at} => Time
|
2440
|
+
# * {Types::UpdateApplicationOutput#associated_stream_groups #associated_stream_groups} => Array<String>
|
2439
2441
|
#
|
2440
2442
|
# @example Request syntax with placeholder values
|
2441
2443
|
#
|
2442
2444
|
# resp = client.update_application({
|
2443
|
-
# application_log_output_uri: "ApplicationLogOutputUri",
|
2444
|
-
# application_log_paths: ["FilePath"],
|
2445
|
-
# description: "Description",
|
2446
2445
|
# identifier: "Identifier", # required
|
2446
|
+
# description: "Description",
|
2447
|
+
# application_log_paths: ["FilePath"],
|
2448
|
+
# application_log_output_uri: "ApplicationLogOutputUri",
|
2447
2449
|
# })
|
2448
2450
|
#
|
2449
2451
|
# @example Response structure
|
2450
2452
|
#
|
2451
|
-
# resp.application_log_output_uri #=> String
|
2452
|
-
# resp.application_log_paths #=> Array
|
2453
|
-
# resp.application_log_paths[0] #=> String
|
2454
|
-
# resp.application_source_uri #=> String
|
2455
2453
|
# resp.arn #=> String
|
2456
|
-
# resp.associated_stream_groups #=> Array
|
2457
|
-
# resp.associated_stream_groups[0] #=> String
|
2458
|
-
# resp.created_at #=> Time
|
2459
2454
|
# resp.description #=> String
|
2455
|
+
# resp.runtime_environment.type #=> String, one of "PROTON", "WINDOWS", "UBUNTU"
|
2456
|
+
# resp.runtime_environment.version #=> String
|
2460
2457
|
# resp.executable_path #=> String
|
2458
|
+
# resp.application_log_paths #=> Array
|
2459
|
+
# resp.application_log_paths[0] #=> String
|
2460
|
+
# resp.application_log_output_uri #=> String
|
2461
|
+
# resp.application_source_uri #=> String
|
2461
2462
|
# resp.id #=> String
|
2462
|
-
# resp.
|
2463
|
+
# resp.status #=> String, one of "INITIALIZED", "PROCESSING", "READY", "DELETING", "ERROR"
|
2464
|
+
# resp.status_reason #=> String, one of "internalError", "accessDenied"
|
2463
2465
|
# resp.replication_statuses #=> Array
|
2464
2466
|
# resp.replication_statuses[0].location #=> String
|
2465
2467
|
# resp.replication_statuses[0].status #=> String, one of "REPLICATING", "COMPLETED"
|
2466
|
-
# resp.
|
2467
|
-
# resp.
|
2468
|
-
# resp.
|
2469
|
-
# resp.
|
2468
|
+
# resp.created_at #=> Time
|
2469
|
+
# resp.last_updated_at #=> Time
|
2470
|
+
# resp.associated_stream_groups #=> Array
|
2471
|
+
# resp.associated_stream_groups[0] #=> String
|
2470
2472
|
#
|
2471
2473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UpdateApplication AWS API Documentation
|
2472
2474
|
#
|
@@ -2502,9 +2504,6 @@ module Aws::GameLiftStreams
|
|
2502
2504
|
# Amazon GameLift Streams returns the complete updated metadata for the
|
2503
2505
|
# stream group.
|
2504
2506
|
#
|
2505
|
-
# @option params [String] :description
|
2506
|
-
# A descriptive label for the stream group.
|
2507
|
-
#
|
2508
2507
|
# @option params [required, String] :identifier
|
2509
2508
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2510
2509
|
# stream group resource. Example ARN:
|
@@ -2519,56 +2518,59 @@ module Aws::GameLiftStreams
|
|
2519
2518
|
# A set of one or more locations and the streaming capacity for each
|
2520
2519
|
# location.
|
2521
2520
|
#
|
2521
|
+
# @option params [String] :description
|
2522
|
+
# A descriptive label for the stream group.
|
2523
|
+
#
|
2522
2524
|
# @return [Types::UpdateStreamGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2523
2525
|
#
|
2524
2526
|
# * {Types::UpdateStreamGroupOutput#arn #arn} => String
|
2525
|
-
# * {Types::UpdateStreamGroupOutput#associated_applications #associated_applications} => Array<String>
|
2526
|
-
# * {Types::UpdateStreamGroupOutput#created_at #created_at} => Time
|
2527
|
-
# * {Types::UpdateStreamGroupOutput#default_application #default_application} => Types::DefaultApplication
|
2528
2527
|
# * {Types::UpdateStreamGroupOutput#description #description} => String
|
2529
|
-
# * {Types::UpdateStreamGroupOutput#
|
2530
|
-
# * {Types::UpdateStreamGroupOutput#last_updated_at #last_updated_at} => Time
|
2528
|
+
# * {Types::UpdateStreamGroupOutput#default_application #default_application} => Types::DefaultApplication
|
2531
2529
|
# * {Types::UpdateStreamGroupOutput#location_states #location_states} => Array<Types::LocationState>
|
2530
|
+
# * {Types::UpdateStreamGroupOutput#stream_class #stream_class} => String
|
2531
|
+
# * {Types::UpdateStreamGroupOutput#id #id} => String
|
2532
2532
|
# * {Types::UpdateStreamGroupOutput#status #status} => String
|
2533
2533
|
# * {Types::UpdateStreamGroupOutput#status_reason #status_reason} => String
|
2534
|
-
# * {Types::UpdateStreamGroupOutput#
|
2534
|
+
# * {Types::UpdateStreamGroupOutput#last_updated_at #last_updated_at} => Time
|
2535
|
+
# * {Types::UpdateStreamGroupOutput#created_at #created_at} => Time
|
2536
|
+
# * {Types::UpdateStreamGroupOutput#associated_applications #associated_applications} => Array<String>
|
2535
2537
|
#
|
2536
2538
|
# @example Request syntax with placeholder values
|
2537
2539
|
#
|
2538
2540
|
# resp = client.update_stream_group({
|
2539
|
-
# description: "Description",
|
2540
2541
|
# identifier: "Identifier", # required
|
2541
2542
|
# location_configurations: [
|
2542
2543
|
# {
|
2543
|
-
# always_on_capacity: 1,
|
2544
2544
|
# location_name: "LocationName", # required
|
2545
|
+
# always_on_capacity: 1,
|
2545
2546
|
# on_demand_capacity: 1,
|
2546
2547
|
# },
|
2547
2548
|
# ],
|
2549
|
+
# description: "Description",
|
2548
2550
|
# })
|
2549
2551
|
#
|
2550
2552
|
# @example Response structure
|
2551
2553
|
#
|
2552
2554
|
# resp.arn #=> String
|
2553
|
-
# resp.associated_applications #=> Array
|
2554
|
-
# resp.associated_applications[0] #=> String
|
2555
|
-
# resp.created_at #=> Time
|
2556
|
-
# resp.default_application.arn #=> String
|
2557
|
-
# resp.default_application.id #=> String
|
2558
2555
|
# resp.description #=> String
|
2559
|
-
# resp.id #=> String
|
2560
|
-
# resp.
|
2556
|
+
# resp.default_application.id #=> String
|
2557
|
+
# resp.default_application.arn #=> String
|
2561
2558
|
# resp.location_states #=> Array
|
2562
|
-
# resp.location_states[0].allocated_capacity #=> Integer
|
2563
|
-
# resp.location_states[0].always_on_capacity #=> Integer
|
2564
|
-
# resp.location_states[0].idle_capacity #=> Integer
|
2565
2559
|
# resp.location_states[0].location_name #=> String
|
2560
|
+
# resp.location_states[0].status #=> String, one of "ACTIVATING", "ACTIVE", "ERROR", "REMOVING"
|
2561
|
+
# resp.location_states[0].always_on_capacity #=> Integer
|
2566
2562
|
# resp.location_states[0].on_demand_capacity #=> Integer
|
2567
2563
|
# resp.location_states[0].requested_capacity #=> Integer
|
2568
|
-
# resp.location_states[0].
|
2564
|
+
# resp.location_states[0].allocated_capacity #=> Integer
|
2565
|
+
# resp.location_states[0].idle_capacity #=> Integer
|
2566
|
+
# resp.stream_class #=> String, one of "gen4n_high", "gen4n_ultra", "gen4n_win2022", "gen5n_high", "gen5n_ultra", "gen5n_win2022"
|
2567
|
+
# resp.id #=> String
|
2569
2568
|
# resp.status #=> String, one of "ACTIVATING", "UPDATING_LOCATIONS", "ACTIVE", "ACTIVE_WITH_ERRORS", "ERROR", "DELETING"
|
2570
2569
|
# resp.status_reason #=> String, one of "internalError", "noAvailableInstances"
|
2571
|
-
# resp.
|
2570
|
+
# resp.last_updated_at #=> Time
|
2571
|
+
# resp.created_at #=> Time
|
2572
|
+
# resp.associated_applications #=> Array
|
2573
|
+
# resp.associated_applications[0] #=> String
|
2572
2574
|
#
|
2573
2575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UpdateStreamGroup AWS API Documentation
|
2574
2576
|
#
|
@@ -2597,7 +2599,7 @@ module Aws::GameLiftStreams
|
|
2597
2599
|
tracer: tracer
|
2598
2600
|
)
|
2599
2601
|
context[:gem_name] = 'aws-sdk-gameliftstreams'
|
2600
|
-
context[:gem_version] = '1.
|
2602
|
+
context[:gem_version] = '1.9.0'
|
2601
2603
|
Seahorse::Client::Request.new(handlers, context)
|
2602
2604
|
end
|
2603
2605
|
|