Interface GameLiftStreamsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface GameLiftStreamsClient
extends AwsClient

Service client for accessing Amazon GameLift Streams. This can be created using the static builder() method.

Amazon GameLift Streams

Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.

This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (CLI), or by making direct REST calls through HTTPS.

See the Amazon GameLift Streams Developer Guide for more information on how Amazon GameLift Streams works and how to work with it.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddStreamGroupLocationsResponse	addStreamGroupLocations(Consumer<AddStreamGroupLocationsRequest.Builder> addStreamGroupLocationsRequest)	Add locations that can host stream sessions.
default AddStreamGroupLocationsResponse	addStreamGroupLocations(AddStreamGroupLocationsRequest addStreamGroupLocationsRequest)	Add locations that can host stream sessions.
default AssociateApplicationsResponse	associateApplications(Consumer<AssociateApplicationsRequest.Builder> associateApplicationsRequest)	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.
default AssociateApplicationsResponse	associateApplications(AssociateApplicationsRequest associateApplicationsRequest)	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.
static GameLiftStreamsClientBuilder	builder()	Create a builder that can be used to configure and create a GameLiftStreamsClient.
static GameLiftStreamsClient	create()	Create a GameLiftStreamsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateApplicationResponse	createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)	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.
default CreateApplicationResponse	createApplication(CreateApplicationRequest createApplicationRequest)	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.
default CreateStreamGroupResponse	createStreamGroup(Consumer<CreateStreamGroupRequest.Builder> createStreamGroupRequest)	Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs.
default CreateStreamGroupResponse	createStreamGroup(CreateStreamGroupRequest createStreamGroupRequest)	Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs.
default CreateStreamSessionConnectionResponse	createStreamSessionConnection(Consumer<CreateStreamSessionConnectionRequest.Builder> createStreamSessionConnectionRequest)	Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session.
default CreateStreamSessionConnectionResponse	createStreamSessionConnection(CreateStreamSessionConnectionRequest createStreamSessionConnectionRequest)	Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session.
default DeleteApplicationResponse	deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)	Permanently deletes an Amazon GameLift Streams application resource.
default DeleteApplicationResponse	deleteApplication(DeleteApplicationRequest deleteApplicationRequest)	Permanently deletes an Amazon GameLift Streams application resource.
default DeleteStreamGroupResponse	deleteStreamGroup(Consumer<DeleteStreamGroupRequest.Builder> deleteStreamGroupRequest)	Permanently deletes all compute resources and information related to a stream group.
default DeleteStreamGroupResponse	deleteStreamGroup(DeleteStreamGroupRequest deleteStreamGroupRequest)	Permanently deletes all compute resources and information related to a stream group.
default DisassociateApplicationsResponse	disassociateApplications(Consumer<DisassociateApplicationsRequest.Builder> disassociateApplicationsRequest)	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.
default DisassociateApplicationsResponse	disassociateApplications(DisassociateApplicationsRequest disassociateApplicationsRequest)	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.
default ExportStreamSessionFilesResponse	exportStreamSessionFiles(Consumer<ExportStreamSessionFilesRequest.Builder> exportStreamSessionFilesRequest)	Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application.
default ExportStreamSessionFilesResponse	exportStreamSessionFiles(ExportStreamSessionFilesRequest exportStreamSessionFilesRequest)	Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application.
default GetApplicationResponse	getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)	Retrieves properties for an Amazon GameLift Streams application resource.
default GetApplicationResponse	getApplication(GetApplicationRequest getApplicationRequest)	Retrieves properties for an Amazon GameLift Streams application resource.
default GetStreamGroupResponse	getStreamGroup(Consumer<GetStreamGroupRequest.Builder> getStreamGroupRequest)	Retrieves properties for a Amazon GameLift Streams stream group resource.
default GetStreamGroupResponse	getStreamGroup(GetStreamGroupRequest getStreamGroupRequest)	Retrieves properties for a Amazon GameLift Streams stream group resource.
default GetStreamSessionResponse	getStreamSession(Consumer<GetStreamSessionRequest.Builder> getStreamSessionRequest)	Retrieves properties for a Amazon GameLift Streams stream session resource.
default GetStreamSessionResponse	getStreamSession(GetStreamSessionRequest getStreamSessionRequest)	Retrieves properties for a Amazon GameLift Streams stream session resource.
default ListApplicationsResponse	listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)	Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use.
default ListApplicationsResponse	listApplications(ListApplicationsRequest listApplicationsRequest)	Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use.
default ListApplicationsIterable	listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)	This is a variant of listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation.
default ListApplicationsIterable	listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)	This is a variant of listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation.
default ListStreamGroupsResponse	listStreamGroups(Consumer<ListStreamGroupsRequest.Builder> listStreamGroupsRequest)	Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use.
default ListStreamGroupsResponse	listStreamGroups(ListStreamGroupsRequest listStreamGroupsRequest)	Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use.
default ListStreamGroupsIterable	listStreamGroupsPaginator(Consumer<ListStreamGroupsRequest.Builder> listStreamGroupsRequest)	This is a variant of listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation.
default ListStreamGroupsIterable	listStreamGroupsPaginator(ListStreamGroupsRequest listStreamGroupsRequest)	This is a variant of listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation.
default ListStreamSessionsResponse	listStreamSessions(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest)	Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.
default ListStreamSessionsResponse	listStreamSessions(ListStreamSessionsRequest listStreamSessionsRequest)	Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.
default ListStreamSessionsByAccountResponse	listStreamSessionsByAccount(Consumer<ListStreamSessionsByAccountRequest.Builder> listStreamSessionsByAccountRequest)	Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.
default ListStreamSessionsByAccountResponse	listStreamSessionsByAccount(ListStreamSessionsByAccountRequest listStreamSessionsByAccountRequest)	Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.
default ListStreamSessionsByAccountIterable	listStreamSessionsByAccountPaginator(Consumer<ListStreamSessionsByAccountRequest.Builder> listStreamSessionsByAccountRequest)	This is a variant of listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation.
default ListStreamSessionsByAccountIterable	listStreamSessionsByAccountPaginator(ListStreamSessionsByAccountRequest listStreamSessionsByAccountRequest)	This is a variant of listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation.
default ListStreamSessionsIterable	listStreamSessionsPaginator(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest)	This is a variant of listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation.
default ListStreamSessionsIterable	listStreamSessionsPaginator(ListStreamSessionsRequest listStreamSessionsRequest)	This is a variant of listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Retrieves all tags assigned to a Amazon GameLift Streams resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Retrieves all tags assigned to a Amazon GameLift Streams resource.
default RemoveStreamGroupLocationsResponse	removeStreamGroupLocations(Consumer<RemoveStreamGroupLocationsRequest.Builder> removeStreamGroupLocationsRequest)	Removes a set of remote locations from this stream group.
default RemoveStreamGroupLocationsResponse	removeStreamGroupLocations(RemoveStreamGroupLocationsRequest removeStreamGroupLocationsRequest)	Removes a set of remote locations from this stream group.
default GameLiftStreamsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartStreamSessionResponse	startStreamSession(Consumer<StartStreamSessionRequest.Builder> startStreamSessionRequest)	This action initiates a new stream session and outputs connection information that clients can use to access the stream.
default StartStreamSessionResponse	startStreamSession(StartStreamSessionRequest startStreamSessionRequest)	This action initiates a new stream session and outputs connection information that clients can use to access the stream.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags to a Amazon GameLift Streams resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags to a Amazon GameLift Streams resource.
default TerminateStreamSessionResponse	terminateStreamSession(Consumer<TerminateStreamSessionRequest.Builder> terminateStreamSessionRequest)	Permanently terminates an active stream session.
default TerminateStreamSessionResponse	terminateStreamSession(TerminateStreamSessionRequest terminateStreamSessionRequest)	Permanently terminates an active stream session.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from a Amazon GameLift Streams resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from a Amazon GameLift Streams resource.
default UpdateApplicationResponse	updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)	Updates the mutable configuration settings for a Amazon GameLift Streams application resource.
default UpdateApplicationResponse	updateApplication(UpdateApplicationRequest updateApplicationRequest)	Updates the mutable configuration settings for a Amazon GameLift Streams application resource.
default UpdateStreamGroupResponse	updateStreamGroup(Consumer<UpdateStreamGroupRequest.Builder> updateStreamGroupRequest)	Updates the configuration settings for an Amazon GameLift Streams stream group resource.
default UpdateStreamGroupResponse	updateStreamGroup(UpdateStreamGroupRequest updateStreamGroupRequest)	Updates the configuration settings for an Amazon GameLift Streams stream group resource.
default GameLiftStreamsWaiter	waiter()	Create an instance of GameLiftStreamsWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

addStreamGroupLocations

default AddStreamGroupLocationsResponse addStreamGroupLocations(AddStreamGroupLocationsRequest addStreamGroupLocationsRequest)
                                                         throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Add locations that can host stream sessions. To add a location, the stream group must be in ACTIVE status. 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.

Parameters:

addStreamGroupLocationsRequest -

Returns:

Result of the AddStreamGroupLocations operation returned by the service.

See Also:

• AWS API Documentation

addStreamGroupLocations

default AddStreamGroupLocationsResponse addStreamGroupLocations(Consumer<AddStreamGroupLocationsRequest.Builder> addStreamGroupLocationsRequest)
                                                         throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Add locations that can host stream sessions. To add a location, the stream group must be in ACTIVE status. 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.

This is a convenience which creates an instance of the AddStreamGroupLocationsRequest.Builder avoiding the need to create one manually via AddStreamGroupLocationsRequest.builder()

Parameters:

addStreamGroupLocationsRequest - A Consumer that will call methods on AddStreamGroupLocationsRequest.Builder to create a request.

Returns:

Result of the AddStreamGroupLocations operation returned by the service.

See Also:

• AWS API Documentation

associateApplications

default AssociateApplicationsResponse associateApplications(AssociateApplicationsRequest associateApplicationsRequest)
                                                     throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

If a stream group does not already have a linked application, Amazon GameLift Streams will automatically assign the first application provided in ApplicationIdentifiers as the default.

Parameters:

associateApplicationsRequest -

Returns:

Result of the AssociateApplications operation returned by the service.

See Also:

• AWS API Documentation

associateApplications

default AssociateApplicationsResponse associateApplications(Consumer<AssociateApplicationsRequest.Builder> associateApplicationsRequest)
                                                     throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

If a stream group does not already have a linked application, Amazon GameLift Streams will automatically assign the first application provided in ApplicationIdentifiers as the default.

This is a convenience which creates an instance of the AssociateApplicationsRequest.Builder avoiding the need to create one manually via AssociateApplicationsRequest.builder()

Parameters:

associateApplicationsRequest - A Consumer that will call methods on AssociateApplicationsRequest.Builder to create a request.

Returns:

Result of the AssociateApplications operation returned by the service.

See Also:

• AWS API Documentation

createApplication

default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest)
                                             throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application.

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.

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

• AWS API Documentation

createApplication

default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
                                             throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application.

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.

This is a convenience which creates an instance of the CreateApplicationRequest.Builder avoiding the need to create one manually via CreateApplicationRequest.builder()

Parameters:

createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

• AWS API Documentation

createStreamGroup

default CreateStreamGroupResponse createStreamGroup(CreateStreamGroupRequest createStreamGroupRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory.

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. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.

• 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). Default is 0 when creating a stream group or adding a location.

Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.

To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.

If the CreateStreamGroup request is successful, Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. It can take a few minutes for Amazon GameLift Streams to finish creating the stream group while it searches for unallocated compute resources and provisions them. When complete, the stream group status will be ACTIVE and you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.

Stream groups should be recreated every 3-4 weeks to pick up important service updates and fixes. Stream groups that are older than 180 days can no longer be updated with new application associations. Stream groups expire when they are 365 days old, at which point they can no longer stream sessions. The exact expiration date is indicated by the date value in the ExpiresAt field.

Parameters:

createStreamGroupRequest -

Returns:

Result of the CreateStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

createStreamGroup

default CreateStreamGroupResponse createStreamGroup(Consumer<CreateStreamGroupRequest.Builder> createStreamGroupRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory.

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. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.

• 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). Default is 0 when creating a stream group or adding a location.

Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.

To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.

If the CreateStreamGroup request is successful, Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. It can take a few minutes for Amazon GameLift Streams to finish creating the stream group while it searches for unallocated compute resources and provisions them. When complete, the stream group status will be ACTIVE and you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.

Stream groups should be recreated every 3-4 weeks to pick up important service updates and fixes. Stream groups that are older than 180 days can no longer be updated with new application associations. Stream groups expire when they are 365 days old, at which point they can no longer stream sessions. The exact expiration date is indicated by the date value in the ExpiresAt field.

This is a convenience which creates an instance of the CreateStreamGroupRequest.Builder avoiding the need to create one manually via CreateStreamGroupRequest.builder()

Parameters:

createStreamGroupRequest - A Consumer that will call methods on CreateStreamGroupRequest.Builder to create a request.

Returns:

Result of the CreateStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

createStreamSessionConnection

default CreateStreamSessionConnectionResponse createStreamSessionConnection(CreateStreamSessionConnectionRequest createStreamSessionConnectionRequest)
                                                                     throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session. This reconnection process can be initiated when a stream session is in either PENDING_CLIENT_RECONNECTION or ACTIVE status. The process works as follows:

1. Initial disconnect:

   • When a client disconnects or loses connection, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION

2. Reconnection time window:

   • Clients have ConnectionTimeoutSeconds (defined in StartStreamSession) to reconnect before session termination

   • Your backend server must call CreateStreamSessionConnection to initiate reconnection

   • Session transitions to RECONNECTING status

3. Reconnection completion:

   • On successful CreateStreamSessionConnection, session status changes to ACTIVE

   • Provide the new connection information to the requesting client

   • Client must establish connection within ConnectionTimeoutSeconds

   • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

To begin re-connecting to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, and the signal request to use with the stream.

Parameters:

createStreamSessionConnectionRequest -

Returns:

Result of the CreateStreamSessionConnection operation returned by the service.

See Also:

• AWS API Documentation

createStreamSessionConnection

default CreateStreamSessionConnectionResponse createStreamSessionConnection(Consumer<CreateStreamSessionConnectionRequest.Builder> createStreamSessionConnectionRequest)
                                                                     throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session. This reconnection process can be initiated when a stream session is in either PENDING_CLIENT_RECONNECTION or ACTIVE status. The process works as follows:

1. Initial disconnect:

   • When a client disconnects or loses connection, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION

2. Reconnection time window:

   • Clients have ConnectionTimeoutSeconds (defined in StartStreamSession) to reconnect before session termination

   • Your backend server must call CreateStreamSessionConnection to initiate reconnection

   • Session transitions to RECONNECTING status

3. Reconnection completion:

   • On successful CreateStreamSessionConnection, session status changes to ACTIVE

   • Provide the new connection information to the requesting client

   • Client must establish connection within ConnectionTimeoutSeconds

   • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

To begin re-connecting to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, and the signal request to use with the stream.

This is a convenience which creates an instance of the CreateStreamSessionConnectionRequest.Builder avoiding the need to create one manually via CreateStreamSessionConnectionRequest.builder()

Parameters:

createStreamSessionConnectionRequest - A Consumer that will call methods on CreateStreamSessionConnectionRequest.Builder to create a request.

Returns:

Result of the CreateStreamSessionConnection operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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 or ERROR status. You cannot delete an application that's in PROCESSING or INITIALIZED 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.

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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 or ERROR status. You cannot delete an application that's in PROCESSING or INITIALIZED 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.

This is a convenience which creates an instance of the DeleteApplicationRequest.Builder avoiding the need to create one manually via DeleteApplicationRequest.builder()

Parameters:

deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteStreamGroup

default DeleteStreamGroupResponse deleteStreamGroup(DeleteStreamGroupRequest deleteStreamGroupRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

deleteStreamGroupRequest -

Returns:

Result of the DeleteStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteStreamGroup

default DeleteStreamGroupResponse deleteStreamGroup(Consumer<DeleteStreamGroupRequest.Builder> deleteStreamGroupRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the DeleteStreamGroupRequest.Builder avoiding the need to create one manually via DeleteStreamGroupRequest.builder()

Parameters:

deleteStreamGroupRequest - A Consumer that will call methods on DeleteStreamGroupRequest.Builder to create a request.

Returns:

Result of the DeleteStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

disassociateApplications

default DisassociateApplicationsResponse disassociateApplications(DisassociateApplicationsRequest disassociateApplicationsRequest)
                                                           throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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 in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group. To disassociate an application, the stream group must be in ACTIVE status.

If you disassociate the default application, Amazon GameLift Streams will automatically choose a new default application from the remaining associated applications. To change which application is the default application, call UpdateStreamGroup and specify a new DefaultApplicationIdentifier.

Parameters:

disassociateApplicationsRequest -

Returns:

Result of the DisassociateApplications operation returned by the service.

See Also:

• AWS API Documentation

disassociateApplications

default DisassociateApplicationsResponse disassociateApplications(Consumer<DisassociateApplicationsRequest.Builder> disassociateApplicationsRequest)
                                                           throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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 in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group. To disassociate an application, the stream group must be in ACTIVE status.

If you disassociate the default application, Amazon GameLift Streams will automatically choose a new default application from the remaining associated applications. To change which application is the default application, call UpdateStreamGroup and specify a new DefaultApplicationIdentifier.

This is a convenience which creates an instance of the DisassociateApplicationsRequest.Builder avoiding the need to create one manually via DisassociateApplicationsRequest.builder()

Parameters:

disassociateApplicationsRequest - A Consumer that will call methods on DisassociateApplicationsRequest.Builder to create a request.

Returns:

Result of the DisassociateApplications operation returned by the service.

See Also:

• AWS API Documentation

exportStreamSessionFiles

default ExportStreamSessionFilesResponse exportStreamSessionFiles(ExportStreamSessionFilesRequest exportStreamSessionFilesRequest)
                                                           throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

exportStreamSessionFilesRequest -

Returns:

Result of the ExportStreamSessionFiles operation returned by the service.

See Also:

• AWS API Documentation

exportStreamSessionFiles

default ExportStreamSessionFilesResponse exportStreamSessionFiles(Consumer<ExportStreamSessionFilesRequest.Builder> exportStreamSessionFilesRequest)
                                                           throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the ExportStreamSessionFilesRequest.Builder avoiding the need to create one manually via ExportStreamSessionFilesRequest.builder()

Parameters:

exportStreamSessionFilesRequest - A Consumer that will call methods on ExportStreamSessionFilesRequest.Builder to create a request.

Returns:

Result of the ExportStreamSessionFiles operation returned by the service.

See Also:

• AWS API Documentation

getApplication

default GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest)
                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

getApplicationRequest -

Returns:

Result of the GetApplication operation returned by the service.

See Also:

• AWS API Documentation

getApplication

default GetApplicationResponse getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)
                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the GetApplicationRequest.Builder avoiding the need to create one manually via GetApplicationRequest.builder()

Parameters:

getApplicationRequest - A Consumer that will call methods on GetApplicationRequest.Builder to create a request.

Returns:

Result of the GetApplication operation returned by the service.

See Also:

• AWS API Documentation

getStreamGroup

default GetStreamGroupResponse getStreamGroup(GetStreamGroupRequest getStreamGroupRequest)
                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

getStreamGroupRequest -

Returns:

Result of the GetStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

getStreamGroup

default GetStreamGroupResponse getStreamGroup(Consumer<GetStreamGroupRequest.Builder> getStreamGroupRequest)
                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the GetStreamGroupRequest.Builder avoiding the need to create one manually via GetStreamGroupRequest.builder()

Parameters:

getStreamGroupRequest - A Consumer that will call methods on GetStreamGroupRequest.Builder to create a request.

Returns:

Result of the GetStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

getStreamSession

default GetStreamSessionResponse getStreamSession(GetStreamSessionRequest getStreamSessionRequest)
                                           throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

getStreamSessionRequest -

Returns:

Result of the GetStreamSession operation returned by the service.

See Also:

• AWS API Documentation

getStreamSession

default GetStreamSessionResponse getStreamSession(Consumer<GetStreamSessionRequest.Builder> getStreamSessionRequest)
                                           throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the GetStreamSessionRequest.Builder avoiding the need to create one manually via GetStreamSessionRequest.builder()

Parameters:

getStreamSessionRequest - A Consumer that will call methods on GetStreamSessionRequest.Builder to create a request.

Returns:

Result of the GetStreamSession operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest)
                                           throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
                                           throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

Parameters:

listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.

Returns:

Result of the ListApplications operation returned by the service.

See Also:

• AWS API Documentation

listApplicationsPaginator

default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)
                                                    throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsIterable responses = client
             .listApplicationsPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation.

Parameters:

listApplicationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listApplicationsPaginator

default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
                                                    throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsIterable responses = client
             .listApplicationsPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation.

This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

Parameters:

listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreamGroups

default ListStreamGroupsResponse listStreamGroups(ListStreamGroupsRequest listStreamGroupsRequest)
                                           throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

listStreamGroupsRequest -

Returns:

Result of the ListStreamGroups operation returned by the service.

See Also:

• AWS API Documentation

listStreamGroups

default ListStreamGroupsResponse listStreamGroups(Consumer<ListStreamGroupsRequest.Builder> listStreamGroupsRequest)
                                           throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the ListStreamGroupsRequest.Builder avoiding the need to create one manually via ListStreamGroupsRequest.builder()

Parameters:

listStreamGroupsRequest - A Consumer that will call methods on ListStreamGroupsRequest.Builder to create a request.

Returns:

Result of the ListStreamGroups operation returned by the service.

See Also:

• AWS API Documentation

listStreamGroupsPaginator

default ListStreamGroupsIterable listStreamGroupsPaginator(ListStreamGroupsRequest listStreamGroupsRequest)
                                                    throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsIterable responses = client.listStreamGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsIterable responses = client
             .listStreamGroupsPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsIterable responses = client.listStreamGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation.

Parameters:

listStreamGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreamGroupsPaginator

default ListStreamGroupsIterable listStreamGroupsPaginator(Consumer<ListStreamGroupsRequest.Builder> listStreamGroupsRequest)
                                                    throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsIterable responses = client.listStreamGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsIterable responses = client
             .listStreamGroupsPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsIterable responses = client.listStreamGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation.

This is a convenience which creates an instance of the ListStreamGroupsRequest.Builder avoiding the need to create one manually via ListStreamGroupsRequest.builder()

Parameters:

listStreamGroupsRequest - A Consumer that will call methods on ListStreamGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreamSessions

default ListStreamSessionsResponse listStreamSessions(ListStreamSessionsRequest listStreamSessionsRequest)
                                               throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

listStreamSessionsRequest -

Returns:

Result of the ListStreamSessions operation returned by the service.

See Also:

• AWS API Documentation

listStreamSessions

default ListStreamSessionsResponse listStreamSessions(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest)
                                               throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the ListStreamSessionsRequest.Builder avoiding the need to create one manually via ListStreamSessionsRequest.builder()

Parameters:

listStreamSessionsRequest - A Consumer that will call methods on ListStreamSessionsRequest.Builder to create a request.

Returns:

Result of the ListStreamSessions operation returned by the service.

See Also:

• AWS API Documentation

listStreamSessionsPaginator

default ListStreamSessionsIterable listStreamSessionsPaginator(ListStreamSessionsRequest listStreamSessionsRequest)
                                                        throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsIterable responses = client
             .listStreamSessionsPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation.

Parameters:

listStreamSessionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreamSessionsPaginator

default ListStreamSessionsIterable listStreamSessionsPaginator(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest)
                                                        throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsIterable responses = client
             .listStreamSessionsPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation.

This is a convenience which creates an instance of the ListStreamSessionsRequest.Builder avoiding the need to create one manually via ListStreamSessionsRequest.builder()

Parameters:

listStreamSessionsRequest - A Consumer that will call methods on ListStreamSessionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreamSessionsByAccount

default ListStreamSessionsByAccountResponse listStreamSessionsByAccount(ListStreamSessionsByAccountRequest listStreamSessionsByAccountRequest)
                                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

listStreamSessionsByAccountRequest -

Returns:

Result of the ListStreamSessionsByAccount operation returned by the service.

See Also:

• AWS API Documentation

listStreamSessionsByAccount

default ListStreamSessionsByAccountResponse listStreamSessionsByAccount(Consumer<ListStreamSessionsByAccountRequest.Builder> listStreamSessionsByAccountRequest)
                                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the ListStreamSessionsByAccountRequest.Builder avoiding the need to create one manually via ListStreamSessionsByAccountRequest.builder()

Parameters:

listStreamSessionsByAccountRequest - A Consumer that will call methods on ListStreamSessionsByAccountRequest.Builder to create a request.

Returns:

Result of the ListStreamSessionsByAccount operation returned by the service.

See Also:

• AWS API Documentation

listStreamSessionsByAccountPaginator

default ListStreamSessionsByAccountIterable listStreamSessionsByAccountPaginator(ListStreamSessionsByAccountRequest listStreamSessionsByAccountRequest)
                                                                          throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountIterable responses = client.listStreamSessionsByAccountPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountIterable responses = client
             .listStreamSessionsByAccountPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountIterable responses = client.listStreamSessionsByAccountPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation.

Parameters:

listStreamSessionsByAccountRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStreamSessionsByAccountPaginator

default ListStreamSessionsByAccountIterable listStreamSessionsByAccountPaginator(Consumer<ListStreamSessionsByAccountRequest.Builder> listStreamSessionsByAccountRequest)
                                                                          throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

This is a variant of listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountIterable responses = client.listStreamSessionsByAccountPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountIterable responses = client
             .listStreamSessionsByAccountPaginator(request);
     for (software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountIterable responses = client.listStreamSessionsByAccountPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation.

This is a convenience which creates an instance of the ListStreamSessionsByAccountRequest.Builder avoiding the need to create one manually via ListStreamSessionsByAccountRequest.builder()

Parameters:

listStreamSessionsByAccountRequest - A Consumer that will call methods on ListStreamSessionsByAccountRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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

Amazon Web Services Tagging Strategies

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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

Amazon Web Services Tagging Strategies

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

removeStreamGroupLocations

default RemoveStreamGroupLocationsResponse removeStreamGroupLocations(RemoveStreamGroupLocationsRequest removeStreamGroupLocationsRequest)
                                                               throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Removes a set of remote locations from this stream group. To remove a location, the stream group must be in ACTIVE status. When you remove a location, Amazon GameLift Streams releases allocated compute resources in that location. Stream sessions can no longer start from removed locations in a stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal Amazon S3 bucket at this location.

You cannot remove the Amazon Web Services Region location where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero to avoid incurring costs for allocated compute resources in that location.

Parameters:

removeStreamGroupLocationsRequest -

Returns:

Result of the RemoveStreamGroupLocations operation returned by the service.

See Also:

• AWS API Documentation

removeStreamGroupLocations

default RemoveStreamGroupLocationsResponse removeStreamGroupLocations(Consumer<RemoveStreamGroupLocationsRequest.Builder> removeStreamGroupLocationsRequest)
                                                               throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Removes a set of remote locations from this stream group. To remove a location, the stream group must be in ACTIVE status. When you remove a location, Amazon GameLift Streams releases allocated compute resources in that location. Stream sessions can no longer start from removed locations in a stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal Amazon S3 bucket at this location.

You cannot remove the Amazon Web Services Region location where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero to avoid incurring costs for allocated compute resources in that location.

This is a convenience which creates an instance of the RemoveStreamGroupLocationsRequest.Builder avoiding the need to create one manually via RemoveStreamGroupLocationsRequest.builder()

Parameters:

removeStreamGroupLocationsRequest - A Consumer that will call methods on RemoveStreamGroupLocationsRequest.Builder to create a request.

Returns:

Result of the RemoveStreamGroupLocations operation returned by the service.

See Also:

• AWS API Documentation

startStreamSession

default StartStreamSessionResponse startStreamSession(StartStreamSessionRequest startStreamSessionRequest)
                                               throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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 that a stream group has allocated. The start stream session process works as follows:

1. Prerequisites:

   • You must have a stream group in ACTIVE status

   • You must have idle or on-demand capacity in a stream group in the location you want to stream from

   • You must have at least one application associated to the stream group (use AssociateApplications if needed)

2. Start stream request:

   • Your backend server calls StartStreamSession to initiate connection

   • Amazon GameLift Streams creates the stream session resource, assigns an Amazon Resource Name (ARN) value, and begins searching for available stream capacity to run the stream

   • Session transitions to ACTIVATING status

3. Placement completion:

   • If Amazon GameLift Streams is successful in finding capacity for the stream, the stream session status changes to ACTIVE status and StartStreamSession returns stream connection information

   • If Amazon GameLift Streams was not successful in finding capacity within the placement timeout period (defined according to the capacity type and platform type), the stream session status changes to ERROR status and StartStreamSession returns a StatusReason of placementTimeout

4. Connection completion:

   • Provide the new connection information to the requesting client

   • Client must establish connection within ConnectionTimeoutSeconds (specified in StartStreamSession parameters)

   • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

Timeouts to be aware of that affect a stream session:

• Placement timeout: The amount of time that Amazon GameLift Streams has to find capacity for a stream request. Placement timeout varies based on the capacity type used to fulfill your stream request:

  • Always-on capacity: 75 seconds

  • On-demand capacity:

    • Linux/Proton runtimes: 90 seconds

    • Windows runtime: 10 minutes

• Connection timeout: The amount of time that Amazon GameLift Streams waits for a client to connect to a stream session in ACTIVE status, or reconnect to a stream session in PENDING_CLIENT_RECONNECTION status, the latter of which occurs when a client disconnects or loses connection from a stream session. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. This value is specified by ConnectionTimeoutSeconds in the StartStreamSession parameters.

• Idle timeout: A stream session will be terminated if no user input has been received for 60 minutes.

• Maximum session length: A stream session will be terminated after this amount of time has elapsed since it started, regardless of any existing client connections. This value is specified by SessionLengthSeconds in the StartStreamSession parameters.

To start a new stream session, specify a stream group ID and application ID, along with the transport protocol and signal request to use with the stream session.

For stream groups that have multiple locations, provide a set of locations ordered by priority using a Locations parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating to a remote location before the remote location can host a stream.

To reconnect to a stream session after a client disconnects or loses connection, use CreateStreamSessionConnection.

Parameters:

startStreamSessionRequest -

Returns:

Result of the StartStreamSession operation returned by the service.

See Also:

• AWS API Documentation

startStreamSession

default StartStreamSessionResponse startStreamSession(Consumer<StartStreamSessionRequest.Builder> startStreamSessionRequest)
                                               throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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 that a stream group has allocated. The start stream session process works as follows:

1. Prerequisites:

   • You must have a stream group in ACTIVE status

   • You must have idle or on-demand capacity in a stream group in the location you want to stream from

   • You must have at least one application associated to the stream group (use AssociateApplications if needed)

2. Start stream request:

   • Your backend server calls StartStreamSession to initiate connection

   • Amazon GameLift Streams creates the stream session resource, assigns an Amazon Resource Name (ARN) value, and begins searching for available stream capacity to run the stream

   • Session transitions to ACTIVATING status

3. Placement completion:

   • If Amazon GameLift Streams is successful in finding capacity for the stream, the stream session status changes to ACTIVE status and StartStreamSession returns stream connection information

   • If Amazon GameLift Streams was not successful in finding capacity within the placement timeout period (defined according to the capacity type and platform type), the stream session status changes to ERROR status and StartStreamSession returns a StatusReason of placementTimeout

4. Connection completion:

   • Provide the new connection information to the requesting client

   • Client must establish connection within ConnectionTimeoutSeconds (specified in StartStreamSession parameters)

   • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

Timeouts to be aware of that affect a stream session:

• Placement timeout: The amount of time that Amazon GameLift Streams has to find capacity for a stream request. Placement timeout varies based on the capacity type used to fulfill your stream request:

  • Always-on capacity: 75 seconds

  • On-demand capacity:

    • Linux/Proton runtimes: 90 seconds

    • Windows runtime: 10 minutes

• Connection timeout: The amount of time that Amazon GameLift Streams waits for a client to connect to a stream session in ACTIVE status, or reconnect to a stream session in PENDING_CLIENT_RECONNECTION status, the latter of which occurs when a client disconnects or loses connection from a stream session. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. This value is specified by ConnectionTimeoutSeconds in the StartStreamSession parameters.

• Idle timeout: A stream session will be terminated if no user input has been received for 60 minutes.

• Maximum session length: A stream session will be terminated after this amount of time has elapsed since it started, regardless of any existing client connections. This value is specified by SessionLengthSeconds in the StartStreamSession parameters.

To start a new stream session, specify a stream group ID and application ID, along with the transport protocol and signal request to use with the stream session.

For stream groups that have multiple locations, provide a set of locations ordered by priority using a Locations parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating to a remote location before the remote location can host a stream.

To reconnect to a stream session after a client disconnects or loses connection, use CreateStreamSessionConnection.

This is a convenience which creates an instance of the StartStreamSessionRequest.Builder avoiding the need to create one manually via StartStreamSessionRequest.builder()

Parameters:

startStreamSessionRequest - A Consumer that will call methods on StartStreamSessionRequest.Builder to create a request.

Returns:

Result of the StartStreamSession operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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

Amazon Web Services Tagging Strategies

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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

Amazon Web Services Tagging Strategies

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

terminateStreamSession

default TerminateStreamSessionResponse terminateStreamSession(TerminateStreamSessionRequest terminateStreamSessionRequest)
                                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

terminateStreamSessionRequest -

Returns:

Result of the TerminateStreamSession operation returned by the service.

See Also:

• AWS API Documentation

terminateStreamSession

default TerminateStreamSessionResponse terminateStreamSession(Consumer<TerminateStreamSessionRequest.Builder> terminateStreamSessionRequest)
                                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the TerminateStreamSessionRequest.Builder avoiding the need to create one manually via TerminateStreamSessionRequest.builder()

Parameters:

terminateStreamSessionRequest - A Consumer that will call methods on TerminateStreamSessionRequest.Builder to create a request.

Returns:

Result of the TerminateStreamSession operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

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.

This is a convenience which creates an instance of the UpdateApplicationRequest.Builder avoiding the need to create one manually via UpdateApplicationRequest.builder()

Parameters:

updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.

Returns:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

updateStreamGroup

default UpdateStreamGroupResponse updateStreamGroup(UpdateStreamGroupRequest updateStreamGroupRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Updates the configuration settings for an Amazon GameLift Streams stream group resource. To update a stream group, it must be in ACTIVE status. 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. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.

• 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). Default is 0 when creating a stream group or adding a location.

Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.

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. Expired stream groups cannot be updated.

Parameters:

updateStreamGroupRequest -

Returns:

Result of the UpdateStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

updateStreamGroup

default UpdateStreamGroupResponse updateStreamGroup(Consumer<UpdateStreamGroupRequest.Builder> updateStreamGroupRequest)
                                             throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
GameLiftStreamsException

Updates the configuration settings for an Amazon GameLift Streams stream group resource. To update a stream group, it must be in ACTIVE status. 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. Default is 1 (2 for high stream classes) when creating a stream group or adding a location.

• 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). Default is 0 when creating a stream group or adding a location.

Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.

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. Expired stream groups cannot be updated.

This is a convenience which creates an instance of the UpdateStreamGroupRequest.Builder avoiding the need to create one manually via UpdateStreamGroupRequest.builder()

Parameters:

updateStreamGroupRequest - A Consumer that will call methods on UpdateStreamGroupRequest.Builder to create a request.

Returns:

Result of the UpdateStreamGroup operation returned by the service.

See Also:

• AWS API Documentation

waiter

default GameLiftStreamsWaiter waiter()

Create an instance of GameLiftStreamsWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of GameLiftStreamsWaiter

create

static GameLiftStreamsClient create()

Create a GameLiftStreamsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static GameLiftStreamsClientBuilder builder()

Create a builder that can be used to configure and create a GameLiftStreamsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default GameLiftStreamsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration