@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAppStreamClient extends AmazonWebServiceClient implements AmazonAppStream
You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonAppStreamClient()
Deprecated.
|
AmazonAppStreamClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonAppStreamClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonAppStreamClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonAppStreamClient()
AmazonAppStreamClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonAppStreamClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon AppStream (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonAppStreamClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonAppStreamClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonAppStreamClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AmazonAppStreamClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic static AmazonAppStreamClientBuilder builder()
public AssociateFleetResult associateFleet(AssociateFleetRequest request)
Associates the specified fleet with the specified stack.
associateFleet
in interface AmazonAppStream
associateFleetRequest
- 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.public CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest request)
Creates a directory configuration.
createDirectoryConfig
in interface AmazonAppStream
createDirectoryConfigRequest
- ResourceAlreadyExistsException
- The specified resource already exists.LimitExceededException
- The requested limit exceeds the permitted limit for an account.public CreateFleetResult createFleet(CreateFleetRequest request)
Creates a fleet.
createFleet
in interface AmazonAppStream
createFleetRequest
- 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.public CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest request)
createImageBuilder
in interface AmazonAppStream
createImageBuilderRequest
- 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.public CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)
createImageBuilderStreamingURL
in interface AmazonAppStream
createImageBuilderStreamingURLRequest
- OperationNotPermittedException
- The attempted operation is not permitted.ResourceNotFoundException
- The specified resource was not found.public CreateStackResult createStack(CreateStackRequest request)
Creates a stack.
createStack
in interface AmazonAppStream
createStackRequest
- 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.public CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest request)
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.
createStreamingURL
in interface AmazonAppStream
createStreamingURLRequest
- 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.public DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest request)
Deletes the specified directory configuration.
deleteDirectoryConfig
in interface AmazonAppStream
deleteDirectoryConfigRequest
- ResourceInUseException
- The specified resource is in use.ResourceNotFoundException
- The specified resource was not found.public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
Deletes the specified fleet.
deleteFleet
in interface AmazonAppStream
deleteFleetRequest
- 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.public DeleteImageResult deleteImage(DeleteImageRequest request)
deleteImage
in interface AmazonAppStream
deleteImageRequest
- 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.public DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest request)
deleteImageBuilder
in interface AmazonAppStream
deleteImageBuilderRequest
- 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.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.
deleteStack
in interface AmazonAppStream
deleteStackRequest
- 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.public DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)
Describes the specified directory configurations.
describeDirectoryConfigs
in interface AmazonAppStream
describeDirectoryConfigsRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)
Describes the specified fleets or all fleets in the account.
describeFleets
in interface AmazonAppStream
describeFleetsRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest request)
describeImageBuilders
in interface AmazonAppStream
describeImageBuildersRequest
- ResourceNotFoundException
- The specified resource was not found.public DescribeImagesResult describeImages(DescribeImagesRequest request)
Describes the specified images or all images in the account.
describeImages
in interface AmazonAppStream
describeImagesRequest
- ResourceNotFoundException
- The specified resource was not found.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.
describeSessions
in interface AmazonAppStream
describeSessionsRequest
- InvalidParameterCombinationException
- Indicates an incorrect combination of parameters, or a missing parameter.public DescribeStacksResult describeStacks(DescribeStacksRequest request)
Describes the specified stacks or all stacks in the account.
describeStacks
in interface AmazonAppStream
describeStacksRequest
- ResourceNotFoundException
- The specified resource was not found.public DisassociateFleetResult disassociateFleet(DisassociateFleetRequest request)
Disassociates the specified fleet from the specified stack.
disassociateFleet
in interface AmazonAppStream
disassociateFleetRequest
- 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.public ExpireSessionResult expireSession(ExpireSessionRequest request)
Stops the specified streaming session.
expireSession
in interface AmazonAppStream
expireSessionRequest
- public ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest request)
Lists the fleets associated with the specified stack.
listAssociatedFleets
in interface AmazonAppStream
listAssociatedFleetsRequest
- public ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest request)
Lists the stacks associated with the specified fleet.
listAssociatedStacks
in interface AmazonAppStream
listAssociatedStacksRequest
- public StartFleetResult startFleet(StartFleetRequest request)
Starts the specified fleet.
startFleet
in interface AmazonAppStream
startFleetRequest
- 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.public StartImageBuilderResult startImageBuilder(StartImageBuilderRequest request)
startImageBuilder
in interface AmazonAppStream
startImageBuilderRequest
- 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.public StopFleetResult stopFleet(StopFleetRequest request)
Stops the specified fleet.
stopFleet
in interface AmazonAppStream
stopFleetRequest
- ResourceNotFoundException
- The specified resource was not found.ConcurrentModificationException
- An API error occurred. Wait a few minutes and try again.public StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest request)
stopImageBuilder
in interface AmazonAppStream
stopImageBuilderRequest
- 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.public UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest request)
Updates the specified directory configuration.
updateDirectoryConfig
in interface AmazonAppStream
updateDirectoryConfigRequest
- 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.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.
updateFleet
in interface AmazonAppStream
updateFleetRequest
- 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.public UpdateStackResult updateStack(UpdateStackRequest request)
Updates the specified stack.
updateStack
in interface AmazonAppStream
updateStackRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonAppStream
request
- The originally executed requestpublic AmazonAppStreamWaiters waiters()
waiters
in interface AmazonAppStream
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonAppStream
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.