Package software.amazon.awssdk.services.appstream

Interface AppStreamClient

All Superinterfaces:

AutoCloseable

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

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

API documentation for Amazon AppStream 2.0.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateFleetResponse	associateFleet(AssociateFleetRequest associateFleetRequest)	Associate a fleet to a stack.
static AppStreamClientBuilder	builder()	Create a builder that can be used to configure and create a AppStreamClient.
static AppStreamClient	create()	Create a AppStreamClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateFleetResponse	createFleet(CreateFleetRequest createFleetRequest)	Creates a new fleet.
default CreateStackResponse	createStack(CreateStackRequest createStackRequest)	Create a new stack.
default CreateStreamingURLResponse	createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)	Creates a URL to start an AppStream 2.0 streaming session for a user.
default DeleteFleetResponse	deleteFleet(DeleteFleetRequest deleteFleetRequest)	Deletes a fleet.
default DeleteStackResponse	deleteStack(DeleteStackRequest deleteStackRequest)	Deletes the stack.
default 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 DescribeImagesResponse	describeImages(DescribeImagesRequest describeImagesRequest)	Describes the images.
default DescribeSessionsResponse	describeSessions(DescribeSessionsRequest describeSessionsRequest)	Describes the streaming sessions for a stack and a fleet.
default 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 DisassociateFleetResponse	disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)	Disassociates a fleet from a stack.
default ExpireSessionResponse	expireSession(ExpireSessionRequest expireSessionRequest)	This operation immediately stops a streaming session.
default ListAssociatedFleetsResponse	listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)	Lists all fleets associated with the stack.
default ListAssociatedStacksResponse	listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)	Lists all stacks to which the specified fleet is associated.
static ServiceMetadata	serviceMetadata()
default StartFleetResponse	startFleet(StartFleetRequest startFleetRequest)	Starts a fleet.
default StopFleetResponse	stopFleet(StopFleetRequest stopFleetRequest)	Stops a fleet.
default UpdateFleetResponse	updateFleet(UpdateFleetRequest updateFleetRequest)	Updates an existing fleet.
default UpdateStackResponse	updateStack(UpdateStackRequest updateStackRequest)	Updates the specified fields in the stack with the specified name.
AppStreamClientWaiters	waiters()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static AppStreamClient create()

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

builder

static AppStreamClientBuilder builder()

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

associateFleet

default AssociateFleetResponse associateFleet(AssociateFleetRequest associateFleetRequest)
                                       throws LimitExceededException,
                                              ResourceNotFoundException,
                                              ConcurrentModificationException,
                                              IncompatibleImageException,
                                              SdkBaseException,
                                              SdkClientException,
                                              AppStreamException

Associate a fleet to a stack.

Parameters:

associateFleetRequest -

Returns:

Result of the AssociateFleet operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createFleet

default CreateFleetResponse createFleet(CreateFleetRequest createFleetRequest)
                                 throws ResourceAlreadyExistsException,
                                        ResourceNotAvailableException,
                                        ResourceNotFoundException,
                                        LimitExceededException,
                                        InvalidRoleException,
                                        ConcurrentModificationException,
                                        SdkBaseException,
                                        SdkClientException,
                                        AppStreamException

Creates a new fleet.

Parameters:

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

Returns:

Result of the CreateFleet operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createStack

default CreateStackResponse createStack(CreateStackRequest createStackRequest)
                                 throws LimitExceededException,
                                        ResourceAlreadyExistsException,
                                        ConcurrentModificationException,
                                        InvalidRoleException,
                                        ResourceNotFoundException,
                                        InvalidParameterCombinationException,
                                        SdkBaseException,
                                        SdkClientException,
                                        AppStreamException

Create a new stack.

Parameters:

createStackRequest -

Returns:

Result of the CreateStack operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createStreamingURL

default CreateStreamingURLResponse createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)
                                               throws ResourceNotFoundException,
                                                      ResourceNotAvailableException,
                                                      OperationNotPermittedException,
                                                      InvalidParameterCombinationException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      AppStreamException

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:

Result of the CreateStreamingURL operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteFleet

default DeleteFleetResponse deleteFleet(DeleteFleetRequest deleteFleetRequest)
                                 throws ResourceInUseException,
                                        ResourceNotFoundException,
                                        ConcurrentModificationException,
                                        SdkBaseException,
                                        SdkClientException,
                                        AppStreamException

Deletes a fleet.

Parameters:

deleteFleetRequest -

Returns:

Result of the DeleteFleet operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteStack

default DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest)
                                 throws ResourceInUseException,
                                        ResourceNotFoundException,
                                        ConcurrentModificationException,
                                        SdkBaseException,
                                        SdkClientException,
                                        AppStreamException

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:

Result of the DeleteStack operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeFleets

default DescribeFleetsResponse describeFleets(DescribeFleetsRequest describeFleetsRequest)
                                       throws ResourceNotFoundException,
                                              SdkBaseException,
                                              SdkClientException,
                                              AppStreamException

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

Parameters:

describeFleetsRequest -

Returns:

Result of the DescribeFleets operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeImages

default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest)
                                       throws ResourceNotFoundException,
                                              SdkBaseException,
                                              SdkClientException,
                                              AppStreamException

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:

Result of the DescribeImages operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeSessions

default DescribeSessionsResponse describeSessions(DescribeSessionsRequest describeSessionsRequest)
                                           throws InvalidParameterCombinationException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  AppStreamException

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:

Result of the DescribeSessions operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeStacks

default DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest)
                                       throws ResourceNotFoundException,
                                              SdkBaseException,
                                              SdkClientException,
                                              AppStreamException

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:

Result of the DescribeStacks operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

disassociateFleet

default DisassociateFleetResponse disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)
                                             throws ResourceInUseException,
                                                    ResourceNotFoundException,
                                                    ConcurrentModificationException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    AppStreamException

Disassociates a fleet from a stack.

Parameters:

disassociateFleetRequest -

Returns:

Result of the DisassociateFleet operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

expireSession

default ExpireSessionResponse expireSession(ExpireSessionRequest expireSessionRequest)
                                     throws SdkBaseException,
                                            SdkClientException,
                                            AppStreamException

This operation immediately stops a streaming session.

Parameters:

expireSessionRequest -

Returns:

Result of the ExpireSession operation returned by the service.

Throws:

SdkBaseException

SdkClientException

AppStreamException

See Also:

AWS API Documentation

listAssociatedFleets

default ListAssociatedFleetsResponse listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)
                                                   throws SdkBaseException,
                                                          SdkClientException,
                                                          AppStreamException

Lists all fleets associated with the stack.

Parameters:

listAssociatedFleetsRequest -

Returns:

Result of the ListAssociatedFleets operation returned by the service.

Throws:

SdkBaseException

SdkClientException

AppStreamException

See Also:

AWS API Documentation

listAssociatedStacks

default ListAssociatedStacksResponse listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)
                                                   throws SdkBaseException,
                                                          SdkClientException,
                                                          AppStreamException

Lists all stacks to which the specified fleet is associated.

Parameters:

listAssociatedStacksRequest -

Returns:

Result of the ListAssociatedStacks operation returned by the service.

Throws:

SdkBaseException

SdkClientException

AppStreamException

See Also:

AWS API Documentation

startFleet

default StartFleetResponse startFleet(StartFleetRequest startFleetRequest)
                               throws ResourceNotFoundException,
                                      OperationNotPermittedException,
                                      LimitExceededException,
                                      ConcurrentModificationException,
                                      SdkBaseException,
                                      SdkClientException,
                                      AppStreamException

Starts a fleet.

Parameters:

startFleetRequest -

Returns:

Result of the StartFleet operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

stopFleet

default StopFleetResponse stopFleet(StopFleetRequest stopFleetRequest)
                             throws ResourceNotFoundException,
                                    ConcurrentModificationException,
                                    SdkBaseException,
                                    SdkClientException,
                                    AppStreamException

Stops a fleet.

Parameters:

stopFleetRequest -

Returns:

Result of the StopFleet operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateFleet

default UpdateFleetResponse updateFleet(UpdateFleetRequest updateFleetRequest)
                                 throws ResourceInUseException,
                                        LimitExceededException,
                                        InvalidRoleException,
                                        ResourceNotFoundException,
                                        ResourceNotAvailableException,
                                        InvalidParameterCombinationException,
                                        ConcurrentModificationException,
                                        IncompatibleImageException,
                                        SdkBaseException,
                                        SdkClientException,
                                        AppStreamException

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:

Result of the UpdateFleet operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateStack

default UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest)
                                 throws ResourceNotFoundException,
                                        ResourceInUseException,
                                        InvalidRoleException,
                                        InvalidParameterCombinationException,
                                        LimitExceededException,
                                        IncompatibleImageException,
                                        SdkBaseException,
                                        SdkClientException,
                                        AppStreamException

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

Parameters:

updateStackRequest -

Returns:

Result of the UpdateStack operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()

waiters

AppStreamClientWaiters waiters()