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

You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.

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) Associates the specified fleet with the specified stack.
static AmazonAppStreamClientBuilder	builder()
CreateDirectoryConfigResult	createDirectoryConfig(CreateDirectoryConfigRequest request) Creates a directory configuration.
CreateFleetResult	createFleet(CreateFleetRequest request) Creates a fleet.
CreateImageBuilderResult	createImageBuilder(CreateImageBuilderRequest request) Creates an image builder.
CreateImageBuilderStreamingURLResult	createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request) Creates a URL to start an image builder streaming session.
CreateStackResult	createStack(CreateStackRequest request) Creates a stack.
CreateStreamingURLResult	createStreamingURL(CreateStreamingURLRequest request) Creates a URL to start a streaming session for the specified user.
DeleteDirectoryConfigResult	deleteDirectoryConfig(DeleteDirectoryConfigRequest request) Deletes the specified directory configuration.
DeleteFleetResult	deleteFleet(DeleteFleetRequest request) Deletes the specified fleet.
DeleteImageResult	deleteImage(DeleteImageRequest request) Deletes the specified image.
DeleteImageBuilderResult	deleteImageBuilder(DeleteImageBuilderRequest request) Deletes the specified image builder and releases the capacity.
DeleteStackResult	deleteStack(DeleteStackRequest request) Deletes the specified stack.
DescribeDirectoryConfigsResult	describeDirectoryConfigs(DescribeDirectoryConfigsRequest request) Describes the specified directory configurations.
DescribeFleetsResult	describeFleets(DescribeFleetsRequest request) Describes the specified fleets or all fleets in the account.
DescribeImageBuildersResult	describeImageBuilders(DescribeImageBuildersRequest request) Describes the specified image builders or all image builders in the account.
DescribeImagesResult	describeImages(DescribeImagesRequest request) Describes the specified images or all images in the account.
DescribeSessionsResult	describeSessions(DescribeSessionsRequest request) Describes the streaming sessions for the specified stack and fleet.
DescribeStacksResult	describeStacks(DescribeStacksRequest request) Describes the specified stacks or all stacks in the account.
DisassociateFleetResult	disassociateFleet(DisassociateFleetRequest request) Disassociates the specified fleet from the specified stack.
ExpireSessionResult	expireSession(ExpireSessionRequest request) Stops the specified 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 the fleets associated with the specified stack.
ListAssociatedStacksResult	listAssociatedStacks(ListAssociatedStacksRequest request) Lists the stacks associated with the specified fleet.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for the specified AppStream 2.0 resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartFleetResult	startFleet(StartFleetRequest request) Starts the specified fleet.
StartImageBuilderResult	startImageBuilder(StartImageBuilderRequest request) Starts the specified image builder.
StopFleetResult	stopFleet(StopFleetRequest request) Stops the specified fleet.
StopImageBuilderResult	stopImageBuilder(StopImageBuilderRequest request) Stops the specified image builder.
TagResourceResult	tagResource(TagResourceRequest request) Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Disassociates the specified tags from the specified AppStream 2.0 resource.
UpdateDirectoryConfigResult	updateDirectoryConfig(UpdateDirectoryConfigRequest request) Updates the specified directory configuration.
UpdateFleetResult	updateFleet(UpdateFleetRequest request) Updates the specified fleet.
UpdateStackResult	updateStack(UpdateStackRequest request) Updates the specified stack.
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)

Associates the specified fleet with the specified 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.

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 fleet.

Specified by:

createFleet in interface AmazonAppStream

Parameters:

createFleetRequest -

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

createImageBuilder

public CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest request)

Creates an image builder.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Specified by:

createImageBuilder in interface AmazonAppStream

Parameters:

createImageBuilderRequest -

Returns:

Result of the CreateImageBuilder operation returned by the service.

Throws:

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

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.

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

createImageBuilderStreamingURL

public CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)

Creates a URL to start an image builder streaming session.

Specified by:

createImageBuilderStreamingURL in interface AmazonAppStream

Parameters:

createImageBuilderStreamingURLRequest -

Returns:

Result of the CreateImageBuilderStreamingURL operation returned by the service.

Throws:

OperationNotPermittedException - The attempted operation is not permitted.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

createStack

public CreateStackResult createStack(CreateStackRequest request)

Creates a 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 a streaming session for the specified user.

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 specified directory configuration.

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 the specified 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

deleteImage

public DeleteImageResult deleteImage(DeleteImageRequest request)

Deletes the specified image. You cannot delete an image that is currently in use. After you delete an image, you cannot provision new capacity using the image.

Specified by:

deleteImage in interface AmazonAppStream

Parameters:

deleteImageRequest -

Returns:

Result of the DeleteImage operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource was not found.

OperationNotPermittedException - The attempted operation is not permitted.

ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.

See Also:

AWS API Documentation

deleteImageBuilder

public DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest request)

Deletes the specified image builder and releases the capacity.

Specified by:

deleteImageBuilder in interface AmazonAppStream

Parameters:

deleteImageBuilderRequest -

Returns:

Result of the DeleteImageBuilder operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

OperationNotPermittedException - The attempted operation is not permitted.

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 specified 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)

Describes the specified directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.

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)

Describes the specified fleets or all fleets in the account.

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

describeImageBuilders

public DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest request)

Describes the specified image builders or all image builders in the account.

Specified by:

describeImageBuilders in interface AmazonAppStream

Parameters:

describeImageBuildersRequest -

Returns:

Result of the DescribeImageBuilders 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 specified images or all images in the account.

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 the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users 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)

Describes the specified stacks or all stacks in the account.

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 the specified fleet from the specified 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)

Stops the specified 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 the fleets associated with the specified 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 the stacks associated with the specified fleet.

Specified by:

listAssociatedStacks in interface AmazonAppStream

Parameters:

listAssociatedStacksRequest -

Returns:

Result of the ListAssociatedStacks operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

Specified by:

listTagsForResource in interface AmazonAppStream

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

startFleet

public StartFleetResult startFleet(StartFleetRequest request)

Starts the specified 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

startImageBuilder

public StartImageBuilderResult startImageBuilder(StartImageBuilderRequest request)

Starts the specified image builder.

Specified by:

startImageBuilder in interface AmazonAppStream

Parameters:

startImageBuilderRequest -

Returns:

Result of the StartImageBuilder operation returned by the service.

Throws:

ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.

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.

See Also:

AWS API Documentation

stopFleet

public StopFleetResult stopFleet(StopFleetRequest request)

Stops the specified 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

stopImageBuilder

public StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest request)

Stops the specified image builder.

Specified by:

stopImageBuilder in interface AmazonAppStream

Parameters:

stopImageBuilderRequest -

Returns:

Result of the StopImageBuilder operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

OperationNotPermittedException - The attempted operation is not permitted.

ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

Specified by:

tagResource in interface AmazonAppStream

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Disassociates the specified tags from the specified AppStream 2.0 resource.

To list the current tags for your resources, use ListTagsForResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

Specified by:

untagResource in interface AmazonAppStream

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

updateDirectoryConfig

public UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest request)

Updates the specified directory configuration.

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 the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

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 stack.

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