com.amazonaws.services.appstream

Interface AmazonAppStream

All Known Subinterfaces:

AmazonAppStreamAsync

All Known Implementing Classes:

AbstractAmazonAppStream, AbstractAmazonAppStreamAsync, AmazonAppStreamAsyncClient, AmazonAppStreamClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppStream

Interface for accessing Amazon AppStream.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAppStream instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateFleetResult	associateFleet(AssociateFleetRequest associateFleetRequest) Associates the specified fleet with the specified stack.
CreateDirectoryConfigResult	createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest) Creates a directory configuration.
CreateFleetResult	createFleet(CreateFleetRequest createFleetRequest) Creates a fleet.
CreateImageBuilderResult	createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)
CreateImageBuilderStreamingURLResult	createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest createImageBuilderStreamingURLRequest)
CreateStackResult	createStack(CreateStackRequest createStackRequest) Creates a stack.
CreateStreamingURLResult	createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest) Creates a URL to start a streaming session for the specified user.
DeleteDirectoryConfigResult	deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest) Deletes the specified directory configuration.
DeleteFleetResult	deleteFleet(DeleteFleetRequest deleteFleetRequest) Deletes the specified fleet.
DeleteImageResult	deleteImage(DeleteImageRequest deleteImageRequest)
DeleteImageBuilderResult	deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)
DeleteStackResult	deleteStack(DeleteStackRequest deleteStackRequest) Deletes the specified stack.
DescribeDirectoryConfigsResult	describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest) Describes the specified directory configurations.
DescribeFleetsResult	describeFleets(DescribeFleetsRequest describeFleetsRequest) Describes the specified fleets or all fleets in the account.
DescribeImageBuildersResult	describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)
DescribeImagesResult	describeImages(DescribeImagesRequest describeImagesRequest) Describes the specified images or all images in the account.
DescribeSessionsResult	describeSessions(DescribeSessionsRequest describeSessionsRequest) Describes the streaming sessions for the specified stack and fleet.
DescribeStacksResult	describeStacks(DescribeStacksRequest describeStacksRequest) Describes the specified stacks or all stacks in the account.
DisassociateFleetResult	disassociateFleet(DisassociateFleetRequest disassociateFleetRequest) Disassociates the specified fleet from the specified stack.
ExpireSessionResult	expireSession(ExpireSessionRequest expireSessionRequest) 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 listAssociatedFleetsRequest) Lists the fleets associated with the specified stack.
ListAssociatedStacksResult	listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest) Lists the stacks associated with the specified fleet.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartFleetResult	startFleet(StartFleetRequest startFleetRequest) Starts the specified fleet.
StartImageBuilderResult	startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)
StopFleetResult	stopFleet(StopFleetRequest stopFleetRequest) Stops the specified fleet.
StopImageBuilderResult	stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)
UpdateDirectoryConfigResult	updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest) Updates the specified directory configuration.
UpdateFleetResult	updateFleet(UpdateFleetRequest updateFleetRequest) Updates the specified fleet.
UpdateStackResult	updateStack(UpdateStackRequest updateStackRequest) Updates the specified stack.
AmazonAppStreamWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("appstream2.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "appstream2.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "appstream2.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

associateFleet

AssociateFleetResult associateFleet(AssociateFleetRequest associateFleetRequest)

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

OperationNotPermittedException - The attempted operation is not permitted.

See Also:

AWS API Documentation

createDirectoryConfig

CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)

Creates a directory configuration.

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

CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)

Creates a fleet.

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

CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)

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

CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest createImageBuilderStreamingURLRequest)

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

CreateStackResult createStack(CreateStackRequest createStackRequest)

Creates a 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.

See Also:

AWS API Documentation

createStreamingURL

CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)

Creates a URL to start a streaming session for the specified user.

By default, the URL is valid only for one 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.

See Also:

AWS API Documentation

deleteDirectoryConfig

DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)

Deletes the specified directory configuration.

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

DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)

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

See Also:

AWS API Documentation

deleteImage

DeleteImageResult deleteImage(DeleteImageRequest deleteImageRequest)

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

DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)

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

DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)

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

See Also:

AWS API Documentation

describeDirectoryConfigs

DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)

Describes the specified directory configurations.

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

DescribeFleetsResult describeFleets(DescribeFleetsRequest describeFleetsRequest)

Describes the specified fleets or all fleets in the account.

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

DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)

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

DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)

Describes the specified images or all images in the account.

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

DescribeSessionsResult describeSessions(DescribeSessionsRequest describeSessionsRequest)

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.

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

DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)

Describes the specified stacks or all stacks in the account.

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

DisassociateFleetResult disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)

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

See Also:

AWS API Documentation

expireSession

ExpireSessionResult expireSession(ExpireSessionRequest expireSessionRequest)

Stops the specified streaming session.

Parameters:

expireSessionRequest -

Returns:

Result of the ExpireSession operation returned by the service.

See Also:

AWS API Documentation

listAssociatedFleets

ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)

Lists the fleets associated with the specified stack.

Parameters:

listAssociatedFleetsRequest -

Returns:

Result of the ListAssociatedFleets operation returned by the service.

See Also:

AWS API Documentation

listAssociatedStacks

ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)

Lists the stacks associated with the specified fleet.

Parameters:

listAssociatedStacksRequest -

Returns:

Result of the ListAssociatedStacks operation returned by the service.

See Also:

AWS API Documentation

startFleet

StartFleetResult startFleet(StartFleetRequest startFleetRequest)

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

See Also:

AWS API Documentation

startImageBuilder

StartImageBuilderResult startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)

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.

See Also:

AWS API Documentation

stopFleet

StopFleetResult stopFleet(StopFleetRequest stopFleetRequest)

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

See Also:

AWS API Documentation

stopImageBuilder

StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)

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

updateDirectoryConfig

UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)

Updates the specified directory configuration.

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

UpdateFleetResult updateFleet(UpdateFleetRequest updateFleetRequest)

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.

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

UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)

Updates the specified stack.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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

waiters

AmazonAppStreamWaiters waiters()