Interface GameLiftStreamsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface GameLiftStreamsAsyncClient extends AwsClient
Service client for accessing Amazon GameLift Streams asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • addStreamGroupLocations

      default CompletableFuture<AddStreamGroupLocationsResponse> addStreamGroupLocations(AddStreamGroupLocationsRequest addStreamGroupLocationsRequest)

      Add locations that can host stream sessions. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality.

      This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions.

      Parameters:
      addStreamGroupLocationsRequest -
      Returns:
      A Java Future containing the result of the AddStreamGroupLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addStreamGroupLocations

      default CompletableFuture<AddStreamGroupLocationsResponse> addStreamGroupLocations(Consumer<AddStreamGroupLocationsRequest.Builder> addStreamGroupLocationsRequest)

      Add locations that can host stream sessions. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality.

      This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions.


      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:
      A Java Future containing the result of the AddStreamGroupLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateApplications

      default CompletableFuture<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. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications.

      Parameters:
      associateApplicationsRequest -
      Returns:
      A Java Future containing the result of the AssociateApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateApplications

      default CompletableFuture<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. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications.


      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:
      A Java Future containing the result of the AssociateApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApplication

      default CompletableFuture<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.

      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:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApplication

      default CompletableFuture<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.

      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:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStreamGroup

      default CompletableFuture<CreateStreamGroupResponse> createStreamGroup(CreateStreamGroupRequest createStreamGroupRequest)

      Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations.

      Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

      • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

      • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

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

      If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. When the stream group reaches ACTIVE status, you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.

      Parameters:
      createStreamGroupRequest -
      Returns:
      A Java Future containing the result of the CreateStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStreamGroup

      default CompletableFuture<CreateStreamGroupResponse> createStreamGroup(Consumer<CreateStreamGroupRequest.Builder> createStreamGroupRequest)

      Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations.

      Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

      • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

      • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

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

      If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. When the stream group reaches ACTIVE status, you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.


      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:
      A Java Future containing the result of the CreateStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStreamSessionConnection

      default CompletableFuture<CreateStreamSessionConnectionResponse> createStreamSessionConnection(CreateStreamSessionConnectionRequest createStreamSessionConnectionRequest)

      Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.

      A client can reconnect to a stream session that's in PENDING_CLIENT_RECONNECTION or ACTIVE status. In the stream session life cycle, when the client disconnects from the stream session, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION status. When a client requests to reconnect by calling CreateStreamSessionConnection, the stream session transitions to RECONNECTING status. When the reconnection is successful, the stream session transitions to ACTIVE status. After a stream session is disconnected for longer than ConnectionTimeoutSeconds, the stream session transitions to the TERMINATED status.

      To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream.

      ConnectionTimeoutSeconds defines the amount of time after the stream session disconnects that a reconnection is allowed. If a client is disconnected from the stream for longer than ConnectionTimeoutSeconds, the stream session ends.

      Parameters:
      createStreamSessionConnectionRequest -
      Returns:
      A Java Future containing the result of the CreateStreamSessionConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStreamSessionConnection

      default CompletableFuture<CreateStreamSessionConnectionResponse> createStreamSessionConnection(Consumer<CreateStreamSessionConnectionRequest.Builder> createStreamSessionConnectionRequest)

      Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.

      A client can reconnect to a stream session that's in PENDING_CLIENT_RECONNECTION or ACTIVE status. In the stream session life cycle, when the client disconnects from the stream session, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION status. When a client requests to reconnect by calling CreateStreamSessionConnection, the stream session transitions to RECONNECTING status. When the reconnection is successful, the stream session transitions to ACTIVE status. After a stream session is disconnected for longer than ConnectionTimeoutSeconds, the stream session transitions to the TERMINATED status.

      To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream.

      ConnectionTimeoutSeconds defines the amount of time after the stream session disconnects that a reconnection is allowed. If a client is disconnected from the stream for longer than ConnectionTimeoutSeconds, the stream session ends.


      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:
      A Java Future containing the result of the CreateStreamSessionConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

      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:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)

      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:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStreamGroup

      default CompletableFuture<DeleteStreamGroupResponse> deleteStreamGroup(DeleteStreamGroupRequest deleteStreamGroupRequest)

      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:
      A Java Future containing the result of the DeleteStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStreamGroup

      default CompletableFuture<DeleteStreamGroupResponse> deleteStreamGroup(Consumer<DeleteStreamGroupRequest.Builder> deleteStreamGroupRequest)

      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:
      A Java Future containing the result of the DeleteStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateApplications

      default CompletableFuture<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. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream capacity of a stream group.

      You can only disassociate an application if it's not a default application of the stream group. Check DefaultApplicationIdentifier by calling GetStreamGroup.

      Parameters:
      disassociateApplicationsRequest -
      Returns:
      A Java Future containing the result of the DisassociateApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateApplications

      default CompletableFuture<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. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream capacity of a stream group.

      You can only disassociate an application if it's not a default application of the stream group. Check DefaultApplicationIdentifier by calling GetStreamGroup.


      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:
      A Java Future containing the result of the DisassociateApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportStreamSessionFiles

      default CompletableFuture<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. 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:
      A Java Future containing the result of the ExportStreamSessionFiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportStreamSessionFiles

      default CompletableFuture<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. 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:
      A Java Future containing the result of the ExportStreamSessionFiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest)

      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:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)

      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:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStreamGroup

      default CompletableFuture<GetStreamGroupResponse> getStreamGroup(GetStreamGroupRequest getStreamGroupRequest)

      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:
      A Java Future containing the result of the GetStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStreamGroup

      default CompletableFuture<GetStreamGroupResponse> getStreamGroup(Consumer<GetStreamGroupRequest.Builder> getStreamGroupRequest)

      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:
      A Java Future containing the result of the GetStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStreamSession

      default CompletableFuture<GetStreamSessionResponse> getStreamSession(GetStreamSessionRequest getStreamSessionRequest)

      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:
      A Java Future containing the result of the GetStreamSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStreamSession

      default CompletableFuture<GetStreamSessionResponse> getStreamSession(Consumer<GetStreamSessionRequest.Builder> getStreamSessionRequest)

      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:
      A Java Future containing the result of the GetStreamSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)

      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:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplications

      default CompletableFuture<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. 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:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)

      This is a variant of listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      This is a variant of listApplications(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamGroups

      default CompletableFuture<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. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.

      Parameters:
      listStreamGroupsRequest -
      Returns:
      A Java Future containing the result of the ListStreamGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamGroups

      default CompletableFuture<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. 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:
      A Java Future containing the result of the ListStreamGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamGroupsPaginator

      default ListStreamGroupsPublisher listStreamGroupsPaginator(ListStreamGroupsRequest listStreamGroupsRequest)

      This is a variant of listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsPublisher publisher = client.listStreamGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsPublisher publisher = client.listStreamGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamGroupsPaginator

      default ListStreamGroupsPublisher listStreamGroupsPaginator(Consumer<ListStreamGroupsRequest.Builder> listStreamGroupsRequest)

      This is a variant of listStreamGroups(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsPublisher publisher = client.listStreamGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamGroupsPublisher publisher = client.listStreamGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListStreamGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessions

      default CompletableFuture<ListStreamSessionsResponse> listStreamSessions(ListStreamSessionsRequest listStreamSessionsRequest)

      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:
      A Java Future containing the result of the ListStreamSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessions

      default CompletableFuture<ListStreamSessionsResponse> listStreamSessions(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest)

      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:
      A Java Future containing the result of the ListStreamSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessionsByAccount

      default CompletableFuture<ListStreamSessionsByAccountResponse> listStreamSessionsByAccount(ListStreamSessionsByAccountRequest listStreamSessionsByAccountRequest)

      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:
      A Java Future containing the result of the ListStreamSessionsByAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessionsByAccount

      default CompletableFuture<ListStreamSessionsByAccountResponse> listStreamSessionsByAccount(Consumer<ListStreamSessionsByAccountRequest.Builder> listStreamSessionsByAccountRequest)

      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:
      A Java Future containing the result of the ListStreamSessionsByAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessionsByAccountPaginator

      default ListStreamSessionsByAccountPublisher listStreamSessionsByAccountPaginator(ListStreamSessionsByAccountRequest listStreamSessionsByAccountRequest)

      This is a variant of listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountPublisher publisher = client.listStreamSessionsByAccountPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountPublisher publisher = client.listStreamSessionsByAccountPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessionsByAccountPaginator

      default ListStreamSessionsByAccountPublisher listStreamSessionsByAccountPaginator(Consumer<ListStreamSessionsByAccountRequest.Builder> listStreamSessionsByAccountRequest)

      This is a variant of listStreamSessionsByAccount(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountPublisher publisher = client.listStreamSessionsByAccountPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsByAccountPublisher publisher = client.listStreamSessionsByAccountPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsByAccountResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessionsPaginator

      default ListStreamSessionsPublisher listStreamSessionsPaginator(ListStreamSessionsRequest listStreamSessionsRequest)

      This is a variant of listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStreamSessionsPaginator

      default ListStreamSessionsPublisher listStreamSessionsPaginator(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest)

      This is a variant of listStreamSessions(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.gameliftstreams.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.gameliftstreams.model.ListStreamSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeStreamGroupLocations

      default CompletableFuture<RemoveStreamGroupLocationsResponse> removeStreamGroupLocations(RemoveStreamGroupLocationsRequest removeStreamGroupLocationsRequest)

      Removes a set of remote locations from this stream group. Amazon GameLift Streams works to release allocated compute resources in these location. Thus, stream sessions can no longer start from these locations by using this stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal S3 bucket at this location.

      You cannot remove the region where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero.

      Parameters:
      removeStreamGroupLocationsRequest -
      Returns:
      A Java Future containing the result of the RemoveStreamGroupLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeStreamGroupLocations

      default CompletableFuture<RemoveStreamGroupLocationsResponse> removeStreamGroupLocations(Consumer<RemoveStreamGroupLocationsRequest.Builder> removeStreamGroupLocationsRequest)

      Removes a set of remote locations from this stream group. Amazon GameLift Streams works to release allocated compute resources in these location. Thus, stream sessions can no longer start from these locations by using this stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal S3 bucket at this location.

      You cannot remove the region where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero.


      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:
      A Java Future containing the result of the RemoveStreamGroupLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startStreamSession

      default CompletableFuture<StartStreamSessionResponse> startStreamSession(StartStreamSessionRequest startStreamSessionRequest)

      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.

      To start a new stream session, specify a stream group and application ID, along with the transport protocol and signal request settings to use with the stream. You must have associated at least one application to the stream group before starting a stream session, either when creating the stream group, or by using AssociateApplications.

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

      If the request is successful, Amazon GameLift Streams begins to prepare the stream. Amazon GameLift Streams assigns an Amazon Resource Name (ARN) value to the stream session resource and sets the status to ACTIVATING. During the stream preparation process, Amazon GameLift Streams queues the request and searches for available stream capacity to run the stream. This results in one of the following:

      • Amazon GameLift Streams identifies an available compute resource to run the application content and start the stream. When the stream is ready, the stream session's status changes to ACTIVE and includes stream connection information. Provide the connection information to the requesting client to join the stream session.

      • Amazon GameLift Streams doesn't identify an available resource within a certain time, set by ClientToken. In this case, Amazon GameLift Streams stops processing the request, and the stream session object status changes to ERROR with status reason placementTimeout.

      Parameters:
      startStreamSessionRequest -
      Returns:
      A Java Future containing the result of the StartStreamSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startStreamSession

      default CompletableFuture<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. 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.

      To start a new stream session, specify a stream group and application ID, along with the transport protocol and signal request settings to use with the stream. You must have associated at least one application to the stream group before starting a stream session, either when creating the stream group, or by using AssociateApplications.

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

      If the request is successful, Amazon GameLift Streams begins to prepare the stream. Amazon GameLift Streams assigns an Amazon Resource Name (ARN) value to the stream session resource and sets the status to ACTIVATING. During the stream preparation process, Amazon GameLift Streams queues the request and searches for available stream capacity to run the stream. This results in one of the following:

      • Amazon GameLift Streams identifies an available compute resource to run the application content and start the stream. When the stream is ready, the stream session's status changes to ACTIVE and includes stream connection information. Provide the connection information to the requesting client to join the stream session.

      • Amazon GameLift Streams doesn't identify an available resource within a certain time, set by ClientToken. In this case, Amazon GameLift Streams stops processing the request, and the stream session object status changes to ERROR with status reason placementTimeout.


      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:
      A Java Future containing the result of the StartStreamSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateStreamSession

      default CompletableFuture<TerminateStreamSessionResponse> terminateStreamSession(TerminateStreamSessionRequest terminateStreamSessionRequest)

      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:
      A Java Future containing the result of the TerminateStreamSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateStreamSession

      default CompletableFuture<TerminateStreamSessionResponse> terminateStreamSession(Consumer<TerminateStreamSessionRequest.Builder> terminateStreamSessionRequest)

      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:
      A Java Future containing the result of the TerminateStreamSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplication

      default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)

      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:
      A Java Future containing the result of the UpdateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplication

      default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)

      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:
      A Java Future containing the result of the UpdateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStreamGroup

      default CompletableFuture<UpdateStreamGroupResponse> updateStreamGroup(UpdateStreamGroupRequest updateStreamGroupRequest)

      Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.

      Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

      • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

      • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

      To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group.

      Parameters:
      updateStreamGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStreamGroup

      default CompletableFuture<UpdateStreamGroupResponse> updateStreamGroup(Consumer<UpdateStreamGroupRequest.Builder> updateStreamGroupRequest)

      Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.

      Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

      • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

      • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

      To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group.


      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:
      A Java Future containing the result of the UpdateStreamGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
      • ResourceNotFoundException The resource specified in the request was not found. Correct the request before you try again.
      • ThrottlingException The request was denied due to request throttling. Retry the request after the suggested wait time.
      • InternalServerException The service encountered an internal error and is unable to complete the request.
      • ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
      • ValidationException One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
      • ServiceQuotaExceededException The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • GameLiftStreamsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default GameLiftStreamsAsyncWaiter waiter()
      Create an instance of GameLiftStreamsAsyncWaiter 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 GameLiftStreamsAsyncWaiter

    • 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

    • create

      static GameLiftStreamsAsyncClient create()
      Create a GameLiftStreamsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static GameLiftStreamsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a GameLiftStreamsAsyncClient.