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
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() Constructs a new client to invoke service methods on Amazon AppStream.
AmazonAppStreamClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials.
AmazonAppStreamClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials and client configuration options.
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider.
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon AppStream using the specified AWS account credentials provider and client configuration options.
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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.
AmazonAppStreamClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon AppStream.

Method Summary

Modifier and Type	Method and Description
AssociateFleetResult	associateFleet(AssociateFleetRequest associateFleetRequest) Associate a fleet to a stack.
CreateFleetResult	createFleet(CreateFleetRequest createFleetRequest) Creates a new fleet.
CreateStackResult	createStack(CreateStackRequest createStackRequest) Create a new stack.
CreateStreamingURLResult	createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest) Creates a URL to start an AppStream 2.0 streaming session for a user.
DeleteFleetResult	deleteFleet(DeleteFleetRequest deleteFleetRequest) Deletes a fleet.
DeleteStackResult	deleteStack(DeleteStackRequest deleteStackRequest) Deletes the stack.
DescribeFleetsResult	describeFleets(DescribeFleetsRequest describeFleetsRequest) If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.
DescribeImagesResult	describeImages(DescribeImagesRequest describeImagesRequest) Describes the images.
DescribeSessionsResult	describeSessions(DescribeSessionsRequest describeSessionsRequest) Describes the streaming sessions for a stack and a fleet.
DescribeStacksResult	describeStacks(DescribeStacksRequest describeStacksRequest) If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described.
DisassociateFleetResult	disassociateFleet(DisassociateFleetRequest disassociateFleetRequest) Disassociates a fleet from a stack.
ExpireSessionResult	expireSession(ExpireSessionRequest expireSessionRequest) 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 listAssociatedFleetsRequest) Lists all fleets associated with the stack.
ListAssociatedStacksResult	listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest) Lists all stacks to which the specified fleet is associated.
StartFleetResult	startFleet(StartFleetRequest startFleetRequest) Starts a fleet.
StopFleetResult	stopFleet(StopFleetRequest stopFleetRequest) Stops a fleet.
UpdateFleetResult	updateFleet(UpdateFleetRequest updateFleetRequest) Updates an existing fleet.
UpdateStackResult	updateStack(UpdateStackRequest updateStackRequest) 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, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, 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, shutdown

Constructor Detail

AmazonAppStreamClient

public AmazonAppStreamClient()

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

public AmazonAppStreamClient(ClientConfiguration 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

public AmazonAppStreamClient(AWSCredentials awsCredentials)

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

public AmazonAppStreamClient(AWSCredentials awsCredentials,
                             ClientConfiguration 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

public AmazonAppStreamClient(AWSCredentialsProvider 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

public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration 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

public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration,
                             RequestMetricCollector 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

associateFleet

public AssociateFleetResult associateFleet(AssociateFleetRequest associateFleetRequest)

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.

createFleet

public CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)

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.

createStack

public CreateStackResult createStack(CreateStackRequest createStackRequest)

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.

createStreamingURL

public CreateStreamingURLResult 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.

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.

deleteFleet

public DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)

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.

deleteStack

public DeleteStackResult 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.

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.

describeFleets

public DescribeFleetsResult describeFleets(DescribeFleetsRequest describeFleetsRequest)

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.

describeImages

public DescribeImagesResult 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.

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.

describeSessions

public DescribeSessionsResult 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.

Specified by:

describeSessions in interface AmazonAppStream

Parameters:

describeSessionsRequest -

Returns:

Result of the DescribeSessions operation returned by the service.

describeStacks

public DescribeStacksResult 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.

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.

disassociateFleet

public DisassociateFleetResult disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)

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.

expireSession

public ExpireSessionResult expireSession(ExpireSessionRequest expireSessionRequest)

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.

listAssociatedFleets

public ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)

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.

listAssociatedStacks

public ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)

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.

startFleet

public StartFleetResult startFleet(StartFleetRequest startFleetRequest)

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.

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

stopFleet

public StopFleetResult stopFleet(StopFleetRequest stopFleetRequest)

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.

updateFleet

public UpdateFleetResult updateFleet(UpdateFleetRequest updateFleetRequest)

Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. Only ComputeCapacity and ImageName can be updated in any other state.

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.

updateStack

public UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)

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.

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