Class: Aws::GameLiftStreams::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::GameLiftStreams::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb
Overview
An API client for GameLiftStreams. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::GameLiftStreams::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_stream_group_locations(params = {}) ⇒ Types::AddStreamGroupLocationsOutput
Add locations that can host stream sessions.
-
#associate_applications(params = {}) ⇒ Types::AssociateApplicationsOutput
When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources.
-
#create_application(params = {}) ⇒ Types::CreateApplicationOutput
Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it.
-
#create_stream_group(params = {}) ⇒ Types::CreateStreamGroupOutput
Manage how Amazon GameLift Streams streams your applications by using a stream group.
-
#create_stream_session_connection(params = {}) ⇒ Types::CreateStreamSessionConnectionOutput
Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.
-
#delete_application(params = {}) ⇒ Struct
Permanently deletes an Amazon GameLift Streams application resource.
-
#delete_stream_group(params = {}) ⇒ Struct
Permanently deletes all compute resources and information related to a stream group.
-
#disassociate_applications(params = {}) ⇒ Types::DisassociateApplicationsOutput
When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources.
-
#export_stream_session_files(params = {}) ⇒ Struct
Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application.
-
#get_application(params = {}) ⇒ Types::GetApplicationOutput
Retrieves properties for an Amazon GameLift Streams application resource.
-
#get_stream_group(params = {}) ⇒ Types::GetStreamGroupOutput
Retrieves properties for a Amazon GameLift Streams stream group resource.
-
#get_stream_session(params = {}) ⇒ Types::GetStreamSessionOutput
Retrieves properties for a Amazon GameLift Streams stream session resource.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsOutput
Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use.
-
#list_stream_groups(params = {}) ⇒ Types::ListStreamGroupsOutput
Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use.
-
#list_stream_sessions(params = {}) ⇒ Types::ListStreamSessionsOutput
Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.
-
#list_stream_sessions_by_account(params = {}) ⇒ Types::ListStreamSessionsByAccountOutput
Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves all tags assigned to a Amazon GameLift Streams resource.
-
#remove_stream_group_locations(params = {}) ⇒ Struct
Removes a set of remote locations from this stream group.
-
#start_stream_session(params = {}) ⇒ Types::StartStreamSessionOutput
This action initiates a new stream session and outputs connection information that clients can use to access the stream.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags to a Amazon GameLift Streams resource.
-
#terminate_stream_session(params = {}) ⇒ Struct
Permanently terminates an active stream session.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a Amazon GameLift Streams resource.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationOutput
Updates the mutable configuration settings for a Amazon GameLift Streams application resource.
-
#update_stream_group(params = {}) ⇒ Types::UpdateStreamGroupOutput
Updates the configuration settings for an Amazon GameLift Streams stream group resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
466 467 468 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#add_stream_group_locations(params = {}) ⇒ Types::AddStreamGroupLocationsOutput
Add locations that can host stream sessions. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality.
This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions.
529 530 531 532 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 529 def add_stream_group_locations(params = {}, = {}) req = build_request(:add_stream_group_locations, params) req.send_request() end |
#associate_applications(params = {}) ⇒ Types::AssociateApplicationsOutput
When you associate, or link, an application with a stream group, then
Amazon GameLift Streams can launch the application using the stream
group's allocated compute resources. The stream group must be in
ACTIVE
status. You can reverse this action by using
DisassociateApplications.
590 591 592 593 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 590 def associate_applications(params = {}, = {}) req = build_request(:associate_applications, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationOutput
Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it.
Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide.
Make sure that your files in the Amazon S3 bucket are the correct version you want to use. As soon as you create a Amazon GameLift Streams application, you cannot change the files at a later time.
If the request is successful, Amazon GameLift Streams begins to create
an application and sets the status to INITIALIZED
. When an
application reaches READY
status, you can use the application to set
up stream groups and start streams. To track application status, call
GetApplication.
772 773 774 775 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 772 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_stream_group(params = {}) ⇒ Types::CreateStreamGroupOutput
Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations.
Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity: always-on and on-demand:
- Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.
-
On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).
To adjust the capacity of any
ACTIVE
stream group, call UpdateStreamGroup.
If the request is successful, Amazon GameLift Streams
begins creating the stream group. Amazon GameLift Streams assigns a
unique ID to the stream group resource and sets the status to
ACTIVATING
. When the stream group reaches
ACTIVE
status, you can start stream sessions by using
StartStreamSession.
To check the stream group's status, call GetStreamGroup.
^
1001 1002 1003 1004 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1001 def create_stream_group(params = {}, = {}) req = build_request(:create_stream_group, params) req.send_request() end |
#create_stream_session_connection(params = {}) ⇒ Types::CreateStreamSessionConnectionOutput
Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.
A client can reconnect to a stream session that's in
PENDING_CLIENT_RECONNECTION
or ACTIVE
status. In the stream
session life cycle, when the client disconnects from the stream
session, the stream session transitions from CONNECTED
to
PENDING_CLIENT_RECONNECTION
status. When a client requests to
reconnect by calling CreateStreamSessionConnection
, the stream
session transitions to RECONNECTING
status. When the reconnection is
successful, the stream session transitions to ACTIVE
status. After a
stream session is disconnected for longer than
ConnectionTimeoutSeconds
, the stream session transitions to the
TERMINATED
status.
To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream.
ConnectionTimeoutSeconds
defines the amount of time after the stream
session disconnects that a reconnection is allowed. If a client is
disconnected from the stream for longer than
ConnectionTimeoutSeconds
, the stream session ends.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1088 def create_stream_session_connection(params = {}, = {}) req = build_request(:create_stream_session_connection, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Permanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However, this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket.
You can only delete an application that meets the following conditions:
The application is in
READY
orERROR
status. You cannot delete an application that's inPROCESSING
orINITIALIZED
status.The application is not the default application of any stream groups. You must first delete the stream group by using DeleteStreamGroup.
The application is not linked to any stream groups. You must first unlink the stream group by using DisassociateApplications.
An application is not streaming in any ongoing stream session. You must wait until the client ends the stream session or call TerminateStreamSession to end the stream.
If any active stream groups exist for this application, this request
returns a ValidationException
.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1148 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_stream_group(params = {}) ⇒ Struct
Permanently deletes all compute resources and information related to a
stream group. To delete a stream group, specify the unique stream
group identifier. During the deletion process, the stream group's
status is DELETING
. This operation stops streams in progress and
prevents new streams from starting. As a best practice, before
deleting the stream group, call ListStreamSessions to check for
streams in progress and take action to stop them. When you delete a
stream group, any application associations referring to that stream
group are automatically removed.
1183 1184 1185 1186 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1183 def delete_stream_group(params = {}, = {}) req = build_request(:delete_stream_group, params) req.send_request() end |
#disassociate_applications(params = {}) ⇒ Types::DisassociateApplicationsOutput
When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream capacity of a stream group.
You can only disassociate an application if it's not a default
application of the stream group. Check DefaultApplicationIdentifier
by calling GetStreamGroup.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1251 def disassociate_applications(params = {}, = {}) req = build_request(:disassociate_applications, params) req.send_request() end |
#export_stream_session_files(params = {}) ⇒ Struct
Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output.
You can only call this action on a stream session that is in progress,
specifically in one of the following statuses ACTIVE
, CONNECTED
,
PENDING_CLIENT_RECONNECTION
, and RECONNECTING
. You must provide an
Amazon Simple Storage Service (Amazon S3) bucket to store the files
in. When the session ends, Amazon GameLift Streams produces a
compressed folder that contains all of the files and directories that
were modified or created by the application during the stream session.
AWS uses your security credentials to authenticate and authorize
access to your Amazon S3 bucket.
Amazon GameLift Streams collects the following generated and modified
files. Find them in the corresponding folders in the .zip
archive.
application/
: The folder where your application or game is stored.
^ ^
profile/
: The user profile folder.temp/
: The system temp folder.
To verify the status of the exported files, use GetStreamSession.
To delete the files, delete the object in the S3 bucket.
1341 1342 1343 1344 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1341 def export_stream_session_files(params = {}, = {}) req = build_request(:export_stream_session_files, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationOutput
Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- application_deleted
- application_ready
1416 1417 1418 1419 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1416 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_stream_group(params = {}) ⇒ Types::GetStreamGroupOutput
Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- stream_group_active
- stream_group_deleted
1483 1484 1485 1486 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1483 def get_stream_group(params = {}, = {}) req = build_request(:get_stream_group, params) req.send_request() end |
#get_stream_session(params = {}) ⇒ Types::GetStreamSessionOutput
Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties for the requested resource.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- stream_session_active
1579 1580 1581 1582 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1579 def get_stream_session(params = {}, = {}) req = build_request(:get_stream_session, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsOutput
Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1630 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_stream_groups(params = {}) ⇒ Types::ListStreamGroupsOutput
Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1682 def list_stream_groups(params = {}, = {}) req = build_request(:list_stream_groups, params) req.send_request() end |
#list_stream_sessions(params = {}) ⇒ Types::ListStreamSessionsOutput
Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.
To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as needed.
This operation returns the requested stream sessions in no particular order.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1770 1771 1772 1773 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1770 def list_stream_sessions(params = {}, = {}) req = build_request(:list_stream_sessions, params) req.send_request() end |
#list_stream_sessions_by_account(params = {}) ⇒ Types::ListStreamSessionsByAccountOutput
Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.
In the returned list of stream sessions, the ExportFilesMetadata
property only shows the Status
value. To get the OutpurUri
and
StatusReason
values, use GetStreamSession.
We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates for a specific stream session, use GetStreamSession.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1846 def list_stream_sessions_by_account(params = {}, = {}) req = build_request(:list_stream_sessions_by_account, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
1894 1895 1896 1897 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1894 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#remove_stream_group_locations(params = {}) ⇒ Struct
Removes a set of remote locations from this stream group. Amazon GameLift Streams works to release allocated compute resources in these location. Thus, stream sessions can no longer start from these locations by using this stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal S3 bucket at this location.
You cannot remove the region where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero.
1940 1941 1942 1943 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 1940 def remove_stream_group_locations(params = {}, = {}) req = build_request(:remove_stream_group_locations, params) req.send_request() end |
#start_stream_session(params = {}) ⇒ Types::StartStreamSessionOutput
This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource, or stream capacity, that a stream group has allocated.
To start a new stream session, specify a stream group and application ID, along with the transport protocol and signal request settings to use with the stream. You must have associated at least one application to the stream group before starting a stream session, either when creating the stream group, or by using AssociateApplications.
For stream groups that have multiple locations, provide a set of
locations ordered by priority by setting Locations
. Amazon GameLift
Streams will start a single stream session in the next available
location. An application must be finished replicating in a remote
location before the remote location can host a stream.
If the request is successful, Amazon GameLift Streams begins to
prepare the stream. Amazon GameLift Streams assigns an Amazon Resource
Name (ARN) value to the stream session resource and sets the status to
ACTIVATING
. During the stream preparation process, Amazon GameLift
Streams queues the request and searches for available stream capacity
to run the stream. This can result to one of the following:
Amazon GameLift Streams identifies an available compute resource to run the application content and start the stream. When the stream is ready, the stream session's status changes to
ACTIVE
and includes stream connection information. Provide the connection information to the requesting client to join the stream session.Amazon GameLift Streams doesn't identify an available resource within a certain time, set by
ClientToken
. In this case, Amazon GameLift Streams stops processing the request, and the stream session object status changes toERROR
with status reasonplacementTimeout
.
2166 2167 2168 2169 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 2166 def start_stream_session(params = {}, = {}) req = build_request(:start_stream_session, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags to a Amazon GameLift Streams resource. Use tags to organize Amazon Web Services resources for a range of purposes. You can assign tags to the following Amazon GameLift Streams resource types:
Application
StreamGroup
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
2219 2220 2221 2222 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 2219 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#terminate_stream_session(params = {}) ⇒ Struct
Permanently terminates an active stream session. When called, the
stream session status changes to TERMINATING
. You can terminate a
stream session in any status except ACTIVATING
. If the stream
session is in ACTIVATING
status, an exception is thrown.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 2262 def terminate_stream_session(params = {}, = {}) req = build_request(:terminate_stream_session, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a Amazon GameLift Streams resource. To remove tags, specify the Amazon GameLift Streams resource and a list of one or more tags to remove.
2296 2297 2298 2299 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 2296 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationOutput
Updates the mutable configuration settings for a Amazon GameLift
Streams application resource. You can change the Description
,
ApplicationLogOutputUri
, and ApplicationLogPaths
.
To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 2398 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_stream_group(params = {}) ⇒ Types::UpdateStreamGroupOutput
Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.
Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity: always-on and on-demand:
- Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.
-
On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).
To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group.
^
2500 2501 2502 2503 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 2500 def update_stream_group(params = {}, = {}) req = build_request(:update_stream_group, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
application_deleted | #get_application | 2 | 60 |
application_ready | #get_application | 2 | 60 |
stream_group_active | #get_stream_group | 30 | 120 |
stream_group_deleted | #get_stream_group | 30 | 60 |
stream_session_active | #get_stream_session | 2 | 60 |
2619 2620 2621 2622 2623 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/client.rb', line 2619 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |