Package software.amazon.awssdk.services.appstream

Interface AppStreamAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface AppStreamAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. Amazon AppStream 2.0

API documentation for Amazon AppStream 2.0.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AssociateFleetResponse>	associateFleet(AssociateFleetRequest associateFleetRequest)	Associate a fleet to a stack.
static AppStreamAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a AppStreamAsyncClient.
static AppStreamAsyncClient	create()	Create a AppStreamAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateFleetResponse>	createFleet(CreateFleetRequest createFleetRequest)	Creates a new fleet.
default CompletableFuture<CreateStackResponse>	createStack(CreateStackRequest createStackRequest)	Create a new stack.
default CompletableFuture<CreateStreamingURLResponse>	createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)	Creates a URL to start an AppStream 2.0 streaming session for a user.
default CompletableFuture<DeleteFleetResponse>	deleteFleet(DeleteFleetRequest deleteFleetRequest)	Deletes a fleet.
default CompletableFuture<DeleteStackResponse>	deleteStack(DeleteStackRequest deleteStackRequest)	Deletes the stack.
default CompletableFuture<DescribeFleetsResponse>	describeFleets(DescribeFleetsRequest describeFleetsRequest)	If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
default CompletableFuture<DescribeImagesResponse>	describeImages(DescribeImagesRequest describeImagesRequest)	Describes the images.
default CompletableFuture<DescribeSessionsResponse>	describeSessions(DescribeSessionsRequest describeSessionsRequest)	Describes the streaming sessions for a stack and a fleet.
default CompletableFuture<DescribeStacksResponse>	describeStacks(DescribeStacksRequest describeStacksRequest)	If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described.
default CompletableFuture<DisassociateFleetResponse>	disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)	Disassociates a fleet from a stack.
default CompletableFuture<ExpireSessionResponse>	expireSession(ExpireSessionRequest expireSessionRequest)	This operation immediately stops a streaming session.
default CompletableFuture<ListAssociatedFleetsResponse>	listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)	Lists all fleets associated with the stack.
default CompletableFuture<ListAssociatedStacksResponse>	listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)	Lists all stacks to which the specified fleet is associated.
default CompletableFuture<StartFleetResponse>	startFleet(StartFleetRequest startFleetRequest)	Starts a fleet.
default CompletableFuture<StopFleetResponse>	stopFleet(StopFleetRequest stopFleetRequest)	Stops a fleet.
default CompletableFuture<UpdateFleetResponse>	updateFleet(UpdateFleetRequest updateFleetRequest)	Updates an existing fleet.
default CompletableFuture<UpdateStackResponse>	updateStack(UpdateStackRequest updateStackRequest)	Updates the specified fields in the stack with the specified name.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static AppStreamAsyncClient create()

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

builder

static AppStreamAsyncClientBuilder builder()

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

associateFleet

default CompletableFuture<AssociateFleetResponse> associateFleet(AssociateFleetRequest associateFleetRequest)

Associate a fleet to a stack.

Parameters:

associateFleetRequest -

Returns:

A Java Future containing the result of the AssociateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException The requested limit exceeds the permitted limit for an account.
• ResourceNotFoundException The specified resource was not found.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• IncompatibleImageException The image does not support storage connectors.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createFleet

default CompletableFuture<CreateFleetResponse> createFleet(CreateFleetRequest createFleetRequest)

Creates a new fleet.

Parameters:

createFleetRequest - Contains the parameters for the new fleet to create.

Returns:

A Java Future containing the result of the CreateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceAlreadyExistsException The specified resource already exists.
• ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
• ResourceNotFoundException The specified resource was not found.
• LimitExceededException The requested limit exceeds the permitted limit for an account.
• InvalidRoleException The specified role is invalid.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createStack

default CompletableFuture<CreateStackResponse> createStack(CreateStackRequest createStackRequest)

Create a new stack.

Parameters:

createStackRequest -

Returns:

A Java Future containing the result of the CreateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• LimitExceededException The requested limit exceeds the permitted limit for an account.
• ResourceAlreadyExistsException The specified resource already exists.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• InvalidRoleException The specified role is invalid.
• ResourceNotFoundException The specified resource was not found.
• InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createStreamingURL

default CompletableFuture<CreateStreamingURLResponse> createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)

Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.

Parameters:

createStreamingURLRequest -

Returns:

A Java Future containing the result of the CreateStreamingURL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource was not found.
• ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
• OperationNotPermittedException The attempted operation is not permitted.
• InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteFleet

default CompletableFuture<DeleteFleetResponse> deleteFleet(DeleteFleetRequest deleteFleetRequest)

Deletes a fleet.

Parameters:

deleteFleetRequest -

Returns:

A Java Future containing the result of the DeleteFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceInUseException The specified resource is in use.
• ResourceNotFoundException The specified resource was not found.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteStack

default CompletableFuture<DeleteStackResponse> deleteStack(DeleteStackRequest deleteStackRequest)

Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.

Parameters:

deleteStackRequest -

Returns:

A Java Future containing the result of the DeleteStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceInUseException The specified resource is in use.
• ResourceNotFoundException The specified resource was not found.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeFleets

default CompletableFuture<DescribeFleetsResponse> describeFleets(DescribeFleetsRequest describeFleetsRequest)

If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.

Parameters:

describeFleetsRequest -

Returns:

A Java Future containing the result of the DescribeFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource was not found.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeImages

default CompletableFuture<DescribeImagesResponse> describeImages(DescribeImagesRequest describeImagesRequest)

Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.

Parameters:

describeImagesRequest -

Returns:

A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource was not found.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeSessions

default CompletableFuture<DescribeSessionsResponse> describeSessions(DescribeSessionsRequest describeSessionsRequest)

Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the nextToken parameter in a subsequent call to this operation to retrieve the next set of items. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Parameters:

describeSessionsRequest -

Returns:

A Java Future containing the result of the DescribeSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeStacks

default CompletableFuture<DescribeStacksResponse> describeStacks(DescribeStacksRequest describeStacksRequest)

If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the nextToken value in a subsequent call to this operation to retrieve the next set of items.

Parameters:

describeStacksRequest -

Returns:

A Java Future containing the result of the DescribeStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource was not found.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

disassociateFleet

default CompletableFuture<DisassociateFleetResponse> disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)

Disassociates a fleet from a stack.

Parameters:

disassociateFleetRequest -

Returns:

A Java Future containing the result of the DisassociateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceInUseException The specified resource is in use.
• ResourceNotFoundException The specified resource was not found.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

expireSession

default CompletableFuture<ExpireSessionResponse> expireSession(ExpireSessionRequest expireSessionRequest)

This operation immediately stops a streaming session.

Parameters:

expireSessionRequest -

Returns:

A Java Future containing the result of the ExpireSession operation returned by the service.

See Also:

AWS API Documentation

listAssociatedFleets

default CompletableFuture<ListAssociatedFleetsResponse> listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)

Lists all fleets associated with the stack.

Parameters:

listAssociatedFleetsRequest -

Returns:

A Java Future containing the result of the ListAssociatedFleets operation returned by the service.

See Also:

AWS API Documentation

listAssociatedStacks

default CompletableFuture<ListAssociatedStacksResponse> listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)

Lists all stacks to which the specified fleet is associated.

Parameters:

listAssociatedStacksRequest -

Returns:

A Java Future containing the result of the ListAssociatedStacks operation returned by the service.

See Also:

AWS API Documentation

startFleet

default CompletableFuture<StartFleetResponse> startFleet(StartFleetRequest startFleetRequest)

Starts a fleet.

Parameters:

startFleetRequest -

Returns:

A Java Future containing the result of the StartFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource was not found.
• OperationNotPermittedException The attempted operation is not permitted.
• LimitExceededException The requested limit exceeds the permitted limit for an account.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopFleet

default CompletableFuture<StopFleetResponse> stopFleet(StopFleetRequest stopFleetRequest)

Stops a fleet.

Parameters:

stopFleetRequest -

Returns:

A Java Future containing the result of the StopFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource was not found.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateFleet

default CompletableFuture<UpdateFleetResponse> updateFleet(UpdateFleetRequest updateFleetRequest)

Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. When a fleet is in the RUNNING state, only DisplayName and ComputeCapacity can be updated. A fleet cannot be updated in a status of STARTING or STOPPING.

Parameters:

updateFleetRequest -

Returns:

A Java Future containing the result of the UpdateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceInUseException The specified resource is in use.
• LimitExceededException The requested limit exceeds the permitted limit for an account.
• InvalidRoleException The specified role is invalid.
• ResourceNotFoundException The specified resource was not found.
• ResourceNotAvailableException The specified resource exists and is not in use, but isn't available.
• InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
• ConcurrentModificationException An API error occurred. Wait a few minutes and try again.
• IncompatibleImageException The image does not support storage connectors.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateStack

default CompletableFuture<UpdateStackResponse> updateStack(UpdateStackRequest updateStackRequest)

Updates the specified fields in the stack with the specified name.

Parameters:

updateStackRequest -

Returns:

A Java Future containing the result of the UpdateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The specified resource was not found.
• ResourceInUseException The specified resource is in use.
• InvalidRoleException The specified role is invalid.
• InvalidParameterCombinationException Indicates an incorrect combination of parameters, or a missing parameter.
• LimitExceededException The requested limit exceeds the permitted limit for an account.
• IncompatibleImageException The image does not support storage connectors.
• SdkBaseException 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
• AppStreamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation