com.amazonaws.services.appstream

Class AmazonAppStreamClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.appstream.AmazonAppStreamClient

All Implemented Interfaces:

AmazonAppStream

Direct Known Subclasses:

AmazonAppStreamAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAppStreamClient
extends AmazonWebServiceClient
implements AmazonAppStream

Client for accessing Amazon AppStream. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon AppStream 2.0

API documentation for Amazon AppStream 2.0.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.appstream.AmazonAppStream

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonAppStreamClient() Deprecated. use AmazonAppStreamClientBuilder.defaultClient()
AmazonAppStreamClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonAppStreamClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonAppStreamClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AssociateFleetResult	associateFleet(AssociateFleetRequest request) Associate a fleet to a stack.
static AmazonAppStreamClientBuilder	builder()
CreateDirectoryConfigResult	createDirectoryConfig(CreateDirectoryConfigRequest request) Creates a directory configuration with the given parameters.
CreateFleetResult	createFleet(CreateFleetRequest request) Creates a new fleet.
CreateStackResult	createStack(CreateStackRequest request) Create a new stack.
CreateStreamingURLResult	createStreamingURL(CreateStreamingURLRequest request) Creates a URL to start an AppStream 2.0 streaming session for a user.
DeleteDirectoryConfigResult	deleteDirectoryConfig(DeleteDirectoryConfigRequest request) Deletes the directory configuration with the given parameters.
DeleteFleetResult	deleteFleet(DeleteFleetRequest request) Deletes a fleet.
DeleteStackResult	deleteStack(DeleteStackRequest request) Deletes the stack.
DescribeDirectoryConfigsResult	describeDirectoryConfigs(DescribeDirectoryConfigsRequest request) Returns a list describing the specified directory configurations.
DescribeFleetsResult	describeFleets(DescribeFleetsRequest request) If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
DescribeImagesResult	describeImages(DescribeImagesRequest request) Describes the images.
DescribeSessionsResult	describeSessions(DescribeSessionsRequest request) Describes the streaming sessions for a stack and a fleet.
DescribeStacksResult	describeStacks(DescribeStacksRequest request) If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described.
DisassociateFleetResult	disassociateFleet(DisassociateFleetRequest request) Disassociates a fleet from a stack.
ExpireSessionResult	expireSession(ExpireSessionRequest request) This operation immediately stops a streaming session.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListAssociatedFleetsResult	listAssociatedFleets(ListAssociatedFleetsRequest request) Lists all fleets associated with the stack.
ListAssociatedStacksResult	listAssociatedStacks(ListAssociatedStacksRequest request) Lists all stacks to which the specified fleet is associated.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartFleetResult	startFleet(StartFleetRequest request) Starts a fleet.
StopFleetResult	stopFleet(StopFleetRequest request) Stops a fleet.
UpdateDirectoryConfigResult	updateDirectoryConfig(UpdateDirectoryConfigRequest request) Updates the directory configuration with the given parameters.
UpdateFleetResult	updateFleet(UpdateFleetRequest request) Updates an existing fleet.
UpdateStackResult	updateStack(UpdateStackRequest request) Updates the specified fields in the stack with the specified name.
AmazonAppStreamWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.appstream.AmazonAppStream

setEndpoint, setRegion

Constructor Detail

AmazonAppStreamClient

@Deprecated
public AmazonAppStreamClient()

Deprecated. use AmazonAppStreamClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon AppStream. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonAppStreamClient

@Deprecated
public AmazonAppStreamClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon AppStream. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonAppStreamClient

@Deprecated
public AmazonAppStreamClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonAppStreamClient

@Deprecated
public AmazonAppStreamClient(AWSCredentials awsCredentials,
                                         ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy settings, retry counts, etc.).

AmazonAppStreamClient

@Deprecated
public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonAppStreamClient

@Deprecated
public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy settings, retry counts, etc.).

AmazonAppStreamClient

@Deprecated
public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration,
                                         RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonAppStreamClientBuilder builder()

associateFleet

public AssociateFleetResult associateFleet(AssociateFleetRequest request)

Associate a fleet to a stack.

Specified by:

associateFleet in interface AmazonAppStream

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.

OperationNotPermittedException - The attempted operation is not permitted.

See Also:

AWS API Documentation

createDirectoryConfig

public CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest request)

Creates a directory configuration with the given parameters.

Specified by:

createDirectoryConfig in interface AmazonAppStream

Parameters:

createDirectoryConfigRequest -

Returns:

Result of the CreateDirectoryConfig operation returned by the service.

Throws:

ResourceAlreadyExistsException - The specified resource already exists.

LimitExceededException - The requested limit exceeds the permitted limit for an account.

See Also:

AWS API Documentation

createFleet

public CreateFleetResult createFleet(CreateFleetRequest request)

Creates a new fleet.

Specified by:

createFleet in interface AmazonAppStream

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.

InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.

IncompatibleImageException - The image does not support storage connectors.

See Also:

AWS API Documentation

createStack

public CreateStackResult createStack(CreateStackRequest request)

Create a new stack.

Specified by:

createStack in interface AmazonAppStream

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.

See Also:

AWS API Documentation

createStreamingURL

public CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest request)

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.

Specified by:

createStreamingURL in interface AmazonAppStream

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.

See Also:

AWS API Documentation

deleteDirectoryConfig

public DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest request)

Deletes the directory configuration with the given parameters.

Specified by:

deleteDirectoryConfig in interface AmazonAppStream

Parameters:

deleteDirectoryConfigRequest -

Returns:

Result of the DeleteDirectoryConfig operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

deleteFleet

public DeleteFleetResult deleteFleet(DeleteFleetRequest request)

Deletes a fleet.

Specified by:

deleteFleet in interface AmazonAppStream

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.

See Also:

AWS API Documentation

deleteStack

public DeleteStackResult deleteStack(DeleteStackRequest request)

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

Specified by:

deleteStack in interface AmazonAppStream

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.

See Also:

AWS API Documentation

describeDirectoryConfigs

public DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)

Returns a list describing the specified directory configurations.

Specified by:

describeDirectoryConfigs in interface AmazonAppStream

Parameters:

describeDirectoryConfigsRequest -

Returns:

Result of the DescribeDirectoryConfigs operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeFleets

public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)

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

Specified by:

describeFleets in interface AmazonAppStream

Parameters:

describeFleetsRequest -

Returns:

Result of the DescribeFleets operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeImages

public DescribeImagesResult describeImages(DescribeImagesRequest request)

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.

Specified by:

describeImages in interface AmazonAppStream

Parameters:

describeImagesRequest -

Returns:

Result of the DescribeImages operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeSessions

public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)

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. To retrieve the next set of items, pass this value for the nextToken parameter in a subsequent call to this operation. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Specified by:

describeSessions in interface AmazonAppStream

Parameters:

describeSessionsRequest -

Returns:

Result of the DescribeSessions operation returned by the service.

Throws:

InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.

See Also:

AWS API Documentation

describeStacks

public DescribeStacksResult describeStacks(DescribeStacksRequest request)

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

Specified by:

describeStacks in interface AmazonAppStream

Parameters:

describeStacksRequest -

Returns:

Result of the DescribeStacks operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

disassociateFleet

public DisassociateFleetResult disassociateFleet(DisassociateFleetRequest request)

Disassociates a fleet from a stack.

Specified by:

disassociateFleet in interface AmazonAppStream

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.

See Also:

AWS API Documentation

expireSession

public ExpireSessionResult expireSession(ExpireSessionRequest request)

This operation immediately stops a streaming session.

Specified by:

expireSession in interface AmazonAppStream

Parameters:

expireSessionRequest -

Returns:

Result of the ExpireSession operation returned by the service.

See Also:

AWS API Documentation

listAssociatedFleets

public ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest request)

Lists all fleets associated with the stack.

Specified by:

listAssociatedFleets in interface AmazonAppStream

Parameters:

listAssociatedFleetsRequest -

Returns:

Result of the ListAssociatedFleets operation returned by the service.

See Also:

AWS API Documentation

listAssociatedStacks

public ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest request)

Lists all stacks to which the specified fleet is associated.

Specified by:

listAssociatedStacks in interface AmazonAppStream

Parameters:

listAssociatedStacksRequest -

Returns:

Result of the ListAssociatedStacks operation returned by the service.

See Also:

AWS API Documentation

startFleet

public StartFleetResult startFleet(StartFleetRequest request)

Starts a fleet.

Specified by:

startFleet in interface AmazonAppStream

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.

See Also:

AWS API Documentation

stopFleet

public StopFleetResult stopFleet(StopFleetRequest request)

Stops a fleet.

Specified by:

stopFleet in interface AmazonAppStream

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.

See Also:

AWS API Documentation

updateDirectoryConfig

public UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest request)

Updates the directory configuration with the given parameters.

Specified by:

updateDirectoryConfig in interface AmazonAppStream

Parameters:

updateDirectoryConfigRequest -

Returns:

Result of the UpdateDirectoryConfig 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.

See Also:

AWS API Documentation

updateFleet

public UpdateFleetResult updateFleet(UpdateFleetRequest request)

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.

Specified by:

updateFleet in interface AmazonAppStream

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.

OperationNotPermittedException - The attempted operation is not permitted.

See Also:

AWS API Documentation

updateStack

public UpdateStackResult updateStack(UpdateStackRequest request)

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

Specified by:

updateStack in interface AmazonAppStream

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonAppStream

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

waiters

public AmazonAppStreamWaiters waiters()

Specified by:

waiters in interface AmazonAppStream

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonAppStream

Overrides:

shutdown in class AmazonWebServiceClient