@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AppStreamClient extends AwsClient
builder() method.
This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
To learn more about AppStream 2.0, see the following resources:
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateApplicationFleetResponse |
associateApplicationFleet(AssociateApplicationFleetRequest associateApplicationFleetRequest)
Associates the specified application with the specified fleet.
|
default AssociateApplicationFleetResponse |
associateApplicationFleet(Consumer<AssociateApplicationFleetRequest.Builder> associateApplicationFleetRequest)
Associates the specified application with the specified fleet.
|
default AssociateApplicationToEntitlementResponse |
associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest associateApplicationToEntitlementRequest)
Associates an application to entitle.
|
default AssociateApplicationToEntitlementResponse |
associateApplicationToEntitlement(Consumer<AssociateApplicationToEntitlementRequest.Builder> associateApplicationToEntitlementRequest)
Associates an application to entitle.
|
default AssociateFleetResponse |
associateFleet(AssociateFleetRequest associateFleetRequest)
Associates the specified fleet with the specified stack.
|
default AssociateFleetResponse |
associateFleet(Consumer<AssociateFleetRequest.Builder> associateFleetRequest)
Associates the specified fleet with the specified stack.
|
default BatchAssociateUserStackResponse |
batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest)
Associates the specified users with the specified stacks.
|
default BatchAssociateUserStackResponse |
batchAssociateUserStack(Consumer<BatchAssociateUserStackRequest.Builder> batchAssociateUserStackRequest)
Associates the specified users with the specified stacks.
|
default BatchDisassociateUserStackResponse |
batchDisassociateUserStack(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest)
Disassociates the specified users from the specified stacks.
|
default BatchDisassociateUserStackResponse |
batchDisassociateUserStack(Consumer<BatchDisassociateUserStackRequest.Builder> batchDisassociateUserStackRequest)
Disassociates the specified users from the specified stacks.
|
static AppStreamClientBuilder |
builder()
Create a builder that can be used to configure and create a
AppStreamClient. |
default CopyImageResponse |
copyImage(Consumer<CopyImageRequest.Builder> copyImageRequest)
Copies the image within the same region or to a new region within the same AWS account.
|
default CopyImageResponse |
copyImage(CopyImageRequest copyImageRequest)
Copies the image within the same region or to a new region within the same AWS account.
|
static AppStreamClient |
create()
Create a
AppStreamClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAppBlockResponse |
createAppBlock(Consumer<CreateAppBlockRequest.Builder> createAppBlockRequest)
Creates an app block.
|
default CreateAppBlockResponse |
createAppBlock(CreateAppBlockRequest createAppBlockRequest)
Creates an app block.
|
default CreateApplicationResponse |
createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
Creates an application.
|
default CreateApplicationResponse |
createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application.
|
default CreateDirectoryConfigResponse |
createDirectoryConfig(Consumer<CreateDirectoryConfigRequest.Builder> createDirectoryConfigRequest)
Creates a Directory Config object in AppStream 2.0.
|
default CreateDirectoryConfigResponse |
createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)
Creates a Directory Config object in AppStream 2.0.
|
default CreateEntitlementResponse |
createEntitlement(Consumer<CreateEntitlementRequest.Builder> createEntitlementRequest)
Creates a new entitlement.
|
default CreateEntitlementResponse |
createEntitlement(CreateEntitlementRequest createEntitlementRequest)
Creates a new entitlement.
|
default CreateFleetResponse |
createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest)
Creates a fleet.
|
default CreateFleetResponse |
createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet.
|
default CreateImageBuilderResponse |
createImageBuilder(Consumer<CreateImageBuilderRequest.Builder> createImageBuilderRequest)
Creates an image builder.
|
default CreateImageBuilderResponse |
createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)
Creates an image builder.
|
default CreateImageBuilderStreamingUrlResponse |
createImageBuilderStreamingURL(Consumer<CreateImageBuilderStreamingUrlRequest.Builder> createImageBuilderStreamingUrlRequest)
Creates a URL to start an image builder streaming session.
|
default CreateImageBuilderStreamingUrlResponse |
createImageBuilderStreamingURL(CreateImageBuilderStreamingUrlRequest createImageBuilderStreamingUrlRequest)
Creates a URL to start an image builder streaming session.
|
default CreateStackResponse |
createStack(Consumer<CreateStackRequest.Builder> createStackRequest)
Creates a stack to start streaming applications to users.
|
default CreateStackResponse |
createStack(CreateStackRequest createStackRequest)
Creates a stack to start streaming applications to users.
|
default CreateStreamingUrlResponse |
createStreamingURL(Consumer<CreateStreamingUrlRequest.Builder> createStreamingUrlRequest)
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
|
default CreateStreamingUrlResponse |
createStreamingURL(CreateStreamingUrlRequest createStreamingUrlRequest)
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
|
default CreateUpdatedImageResponse |
createUpdatedImage(Consumer<CreateUpdatedImageRequest.Builder> createUpdatedImageRequest)
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent
software.
|
default CreateUpdatedImageResponse |
createUpdatedImage(CreateUpdatedImageRequest createUpdatedImageRequest)
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent
software.
|
default CreateUsageReportSubscriptionResponse |
createUsageReportSubscription(Consumer<CreateUsageReportSubscriptionRequest.Builder> createUsageReportSubscriptionRequest)
Creates a usage report subscription.
|
default CreateUsageReportSubscriptionResponse |
createUsageReportSubscription(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest)
Creates a usage report subscription.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a new user in the user pool.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a new user in the user pool.
|
default DeleteAppBlockResponse |
deleteAppBlock(Consumer<DeleteAppBlockRequest.Builder> deleteAppBlockRequest)
Deletes an app block.
|
default DeleteAppBlockResponse |
deleteAppBlock(DeleteAppBlockRequest deleteAppBlockRequest)
Deletes an app block.
|
default DeleteApplicationResponse |
deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
Deletes an application.
|
default DeleteApplicationResponse |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application.
|
default DeleteDirectoryConfigResponse |
deleteDirectoryConfig(Consumer<DeleteDirectoryConfigRequest.Builder> deleteDirectoryConfigRequest)
Deletes the specified Directory Config object from AppStream 2.0.
|
default DeleteDirectoryConfigResponse |
deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)
Deletes the specified Directory Config object from AppStream 2.0.
|
default DeleteEntitlementResponse |
deleteEntitlement(Consumer<DeleteEntitlementRequest.Builder> deleteEntitlementRequest)
Deletes the specified entitlement.
|
default DeleteEntitlementResponse |
deleteEntitlement(DeleteEntitlementRequest deleteEntitlementRequest)
Deletes the specified entitlement.
|
default DeleteFleetResponse |
deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest)
Deletes the specified fleet.
|
default DeleteFleetResponse |
deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes the specified fleet.
|
default DeleteImageResponse |
deleteImage(Consumer<DeleteImageRequest.Builder> deleteImageRequest)
Deletes the specified image.
|
default DeleteImageResponse |
deleteImage(DeleteImageRequest deleteImageRequest)
Deletes the specified image.
|
default DeleteImageBuilderResponse |
deleteImageBuilder(Consumer<DeleteImageBuilderRequest.Builder> deleteImageBuilderRequest)
Deletes the specified image builder and releases the capacity.
|
default DeleteImageBuilderResponse |
deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)
Deletes the specified image builder and releases the capacity.
|
default DeleteImagePermissionsResponse |
deleteImagePermissions(Consumer<DeleteImagePermissionsRequest.Builder> deleteImagePermissionsRequest)
Deletes permissions for the specified private image.
|
default DeleteImagePermissionsResponse |
deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest)
Deletes permissions for the specified private image.
|
default DeleteStackResponse |
deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest)
Deletes the specified stack.
|
default DeleteStackResponse |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes the specified stack.
|
default DeleteUsageReportSubscriptionResponse |
deleteUsageReportSubscription(Consumer<DeleteUsageReportSubscriptionRequest.Builder> deleteUsageReportSubscriptionRequest)
Disables usage report generation.
|
default DeleteUsageReportSubscriptionResponse |
deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest)
Disables usage report generation.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a user from the user pool.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user from the user pool.
|
default DescribeAppBlocksResponse |
describeAppBlocks(Consumer<DescribeAppBlocksRequest.Builder> describeAppBlocksRequest)
Retrieves a list that describes one or more app blocks.
|
default DescribeAppBlocksResponse |
describeAppBlocks(DescribeAppBlocksRequest describeAppBlocksRequest)
Retrieves a list that describes one or more app blocks.
|
default DescribeApplicationFleetAssociationsResponse |
describeApplicationFleetAssociations(Consumer<DescribeApplicationFleetAssociationsRequest.Builder> describeApplicationFleetAssociationsRequest)
Retrieves a list that describes one or more application fleet associations.
|
default DescribeApplicationFleetAssociationsResponse |
describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest describeApplicationFleetAssociationsRequest)
Retrieves a list that describes one or more application fleet associations.
|
default DescribeApplicationsResponse |
describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest)
Retrieves a list that describes one or more applications.
|
default DescribeApplicationsResponse |
describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Retrieves a list that describes one or more applications.
|
default DescribeDirectoryConfigsResponse |
describeDirectoryConfigs()
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names
for these objects are provided.
|
default DescribeDirectoryConfigsResponse |
describeDirectoryConfigs(Consumer<DescribeDirectoryConfigsRequest.Builder> describeDirectoryConfigsRequest)
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names
for these objects are provided.
|
default DescribeDirectoryConfigsResponse |
describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names
for these objects are provided.
|
default DescribeEntitlementsResponse |
describeEntitlements(Consumer<DescribeEntitlementsRequest.Builder> describeEntitlementsRequest)
Retrieves a list that describes one of more entitlements.
|
default DescribeEntitlementsResponse |
describeEntitlements(DescribeEntitlementsRequest describeEntitlementsRequest)
Retrieves a list that describes one of more entitlements.
|
default DescribeFleetsResponse |
describeFleets()
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
|
default DescribeFleetsResponse |
describeFleets(Consumer<DescribeFleetsRequest.Builder> describeFleetsRequest)
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
|
default DescribeFleetsResponse |
describeFleets(DescribeFleetsRequest describeFleetsRequest)
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
|
default DescribeImageBuildersResponse |
describeImageBuilders()
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
|
default DescribeImageBuildersResponse |
describeImageBuilders(Consumer<DescribeImageBuildersRequest.Builder> describeImageBuildersRequest)
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
|
default DescribeImageBuildersResponse |
describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
|
default DescribeImagePermissionsResponse |
describeImagePermissions(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
|
default DescribeImagePermissionsResponse |
describeImagePermissions(DescribeImagePermissionsRequest describeImagePermissionsRequest)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
|
default DescribeImagePermissionsIterable |
describeImagePermissionsPaginator(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
|
default DescribeImagePermissionsIterable |
describeImagePermissionsPaginator(DescribeImagePermissionsRequest describeImagePermissionsRequest)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
|
default DescribeImagesResponse |
describeImages()
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
default DescribeImagesResponse |
describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
default DescribeImagesResponse |
describeImages(DescribeImagesRequest describeImagesRequest)
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
default DescribeImagesIterable |
describeImagesPaginator()
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
default DescribeImagesIterable |
describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
default DescribeImagesIterable |
describeImagesPaginator(DescribeImagesRequest describeImagesRequest)
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
default DescribeSessionsResponse |
describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
Retrieves a list that describes the streaming sessions for a specified stack and fleet.
|
default DescribeSessionsResponse |
describeSessions(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list that describes the streaming sessions for a specified stack and fleet.
|
default DescribeStacksResponse |
describeStacks()
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
|
default DescribeStacksResponse |
describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
|
default DescribeStacksResponse |
describeStacks(DescribeStacksRequest describeStacksRequest)
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
|
default DescribeUsageReportSubscriptionsResponse |
describeUsageReportSubscriptions(Consumer<DescribeUsageReportSubscriptionsRequest.Builder> describeUsageReportSubscriptionsRequest)
Retrieves a list that describes one or more usage report subscriptions.
|
default DescribeUsageReportSubscriptionsResponse |
describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest)
Retrieves a list that describes one or more usage report subscriptions.
|
default DescribeUsersResponse |
describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Retrieves a list that describes one or more specified users in the user pool.
|
default DescribeUsersResponse |
describeUsers(DescribeUsersRequest describeUsersRequest)
Retrieves a list that describes one or more specified users in the user pool.
|
default DescribeUserStackAssociationsResponse |
describeUserStackAssociations(Consumer<DescribeUserStackAssociationsRequest.Builder> describeUserStackAssociationsRequest)
Retrieves a list that describes the UserStackAssociation objects.
|
default DescribeUserStackAssociationsResponse |
describeUserStackAssociations(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest)
Retrieves a list that describes the UserStackAssociation objects.
|
default DisableUserResponse |
disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest)
Disables the specified user in the user pool.
|
default DisableUserResponse |
disableUser(DisableUserRequest disableUserRequest)
Disables the specified user in the user pool.
|
default DisassociateApplicationFleetResponse |
disassociateApplicationFleet(Consumer<DisassociateApplicationFleetRequest.Builder> disassociateApplicationFleetRequest)
Disassociates the specified application from the fleet.
|
default DisassociateApplicationFleetResponse |
disassociateApplicationFleet(DisassociateApplicationFleetRequest disassociateApplicationFleetRequest)
Disassociates the specified application from the fleet.
|
default DisassociateApplicationFromEntitlementResponse |
disassociateApplicationFromEntitlement(Consumer<DisassociateApplicationFromEntitlementRequest.Builder> disassociateApplicationFromEntitlementRequest)
Deletes the specified application from the specified entitlement.
|
default DisassociateApplicationFromEntitlementResponse |
disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest disassociateApplicationFromEntitlementRequest)
Deletes the specified application from the specified entitlement.
|
default DisassociateFleetResponse |
disassociateFleet(Consumer<DisassociateFleetRequest.Builder> disassociateFleetRequest)
Disassociates the specified fleet from the specified stack.
|
default DisassociateFleetResponse |
disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)
Disassociates the specified fleet from the specified stack.
|
default EnableUserResponse |
enableUser(Consumer<EnableUserRequest.Builder> enableUserRequest)
Enables a user in the user pool.
|
default EnableUserResponse |
enableUser(EnableUserRequest enableUserRequest)
Enables a user in the user pool.
|
default ExpireSessionResponse |
expireSession(Consumer<ExpireSessionRequest.Builder> expireSessionRequest)
Immediately stops the specified streaming session.
|
default ExpireSessionResponse |
expireSession(ExpireSessionRequest expireSessionRequest)
Immediately stops the specified streaming session.
|
default ListAssociatedFleetsResponse |
listAssociatedFleets(Consumer<ListAssociatedFleetsRequest.Builder> listAssociatedFleetsRequest)
Retrieves the name of the fleet that is associated with the specified stack.
|
default ListAssociatedFleetsResponse |
listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)
Retrieves the name of the fleet that is associated with the specified stack.
|
default ListAssociatedStacksResponse |
listAssociatedStacks(Consumer<ListAssociatedStacksRequest.Builder> listAssociatedStacksRequest)
Retrieves the name of the stack with which the specified fleet is associated.
|
default ListAssociatedStacksResponse |
listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)
Retrieves the name of the stack with which the specified fleet is associated.
|
default ListEntitledApplicationsResponse |
listEntitledApplications(Consumer<ListEntitledApplicationsRequest.Builder> listEntitledApplicationsRequest)
Retrieves a list of entitled applications.
|
default ListEntitledApplicationsResponse |
listEntitledApplications(ListEntitledApplicationsRequest listEntitledApplicationsRequest)
Retrieves a list of entitled applications.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieves a list of all tags for the specified AppStream 2.0 resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves a list of all tags for the specified AppStream 2.0 resource.
|
default AppStreamServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartFleetResponse |
startFleet(Consumer<StartFleetRequest.Builder> startFleetRequest)
Starts the specified fleet.
|
default StartFleetResponse |
startFleet(StartFleetRequest startFleetRequest)
Starts the specified fleet.
|
default StartImageBuilderResponse |
startImageBuilder(Consumer<StartImageBuilderRequest.Builder> startImageBuilderRequest)
Starts the specified image builder.
|
default StartImageBuilderResponse |
startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)
Starts the specified image builder.
|
default StopFleetResponse |
stopFleet(Consumer<StopFleetRequest.Builder> stopFleetRequest)
Stops the specified fleet.
|
default StopFleetResponse |
stopFleet(StopFleetRequest stopFleetRequest)
Stops the specified fleet.
|
default StopImageBuilderResponse |
stopImageBuilder(Consumer<StopImageBuilderRequest.Builder> stopImageBuilderRequest)
Stops the specified image builder.
|
default StopImageBuilderResponse |
stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)
Stops the specified image builder.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Disassociates one or more specified tags from the specified AppStream 2.0 resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Disassociates one or more specified tags from the specified AppStream 2.0 resource.
|
default UpdateApplicationResponse |
updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
Updates the specified application.
|
default UpdateApplicationResponse |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates the specified application.
|
default UpdateDirectoryConfigResponse |
updateDirectoryConfig(Consumer<UpdateDirectoryConfigRequest.Builder> updateDirectoryConfigRequest)
Updates the specified Directory Config object in AppStream 2.0.
|
default UpdateDirectoryConfigResponse |
updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)
Updates the specified Directory Config object in AppStream 2.0.
|
default UpdateEntitlementResponse |
updateEntitlement(Consumer<UpdateEntitlementRequest.Builder> updateEntitlementRequest)
Updates the specified entitlement.
|
default UpdateEntitlementResponse |
updateEntitlement(UpdateEntitlementRequest updateEntitlementRequest)
Updates the specified entitlement.
|
default UpdateFleetResponse |
updateFleet(Consumer<UpdateFleetRequest.Builder> updateFleetRequest)
Updates the specified fleet.
|
default UpdateFleetResponse |
updateFleet(UpdateFleetRequest updateFleetRequest)
Updates the specified fleet.
|
default UpdateImagePermissionsResponse |
updateImagePermissions(Consumer<UpdateImagePermissionsRequest.Builder> updateImagePermissionsRequest)
Adds or updates permissions for the specified private image.
|
default UpdateImagePermissionsResponse |
updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest)
Adds or updates permissions for the specified private image.
|
default UpdateStackResponse |
updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest)
Updates the specified fields for the specified stack.
|
default UpdateStackResponse |
updateStack(UpdateStackRequest updateStackRequest)
Updates the specified fields for the specified stack.
|
default AppStreamWaiter |
waiter()
Create an instance of
AppStreamWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AssociateApplicationFleetResponse associateApplicationFleet(AssociateApplicationFleetRequest associateApplicationFleetRequest) throws ConcurrentModificationException, LimitExceededException, ResourceNotFoundException, InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
associateApplicationFleetRequest - ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.LimitExceededException - The requested limit exceeds the permitted limit for an account.ResourceNotFoundException - The specified resource was not found.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateApplicationFleetResponse associateApplicationFleet(Consumer<AssociateApplicationFleetRequest.Builder> associateApplicationFleetRequest) throws ConcurrentModificationException, LimitExceededException, ResourceNotFoundException, InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
This is a convenience which creates an instance of the AssociateApplicationFleetRequest.Builder avoiding
the need to create one manually via AssociateApplicationFleetRequest.builder()
associateApplicationFleetRequest - A Consumer that will call methods on AssociateApplicationFleetRequest.Builder to create a
request.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.LimitExceededException - The requested limit exceeds the permitted limit for an account.ResourceNotFoundException - The specified resource was not found.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateApplicationToEntitlementResponse associateApplicationToEntitlement(AssociateApplicationToEntitlementRequest associateApplicationToEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException
Associates an application to entitle.
associateApplicationToEntitlementRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.LimitExceededException - The requested limit exceeds the permitted limit for an account.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateApplicationToEntitlementResponse associateApplicationToEntitlement(Consumer<AssociateApplicationToEntitlementRequest.Builder> associateApplicationToEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException
Associates an application to entitle.
This is a convenience which creates an instance of the AssociateApplicationToEntitlementRequest.Builder
avoiding the need to create one manually via AssociateApplicationToEntitlementRequest.builder()
associateApplicationToEntitlementRequest - A Consumer that will call methods on AssociateApplicationToEntitlementRequest.Builder to
create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.LimitExceededException - The requested limit exceeds the permitted limit for an account.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateFleetResponse associateFleet(AssociateFleetRequest associateFleetRequest) throws LimitExceededException, InvalidAccountStatusException, ResourceNotFoundException, ConcurrentModificationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Associates the specified fleet with the specified stack.
associateFleetRequest - LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException - The specified resource was not found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.IncompatibleImageException - The image can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateFleetResponse associateFleet(Consumer<AssociateFleetRequest.Builder> associateFleetRequest) throws LimitExceededException, InvalidAccountStatusException, ResourceNotFoundException, ConcurrentModificationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Associates the specified fleet with the specified stack.
This is a convenience which creates an instance of the AssociateFleetRequest.Builder avoiding the need to
create one manually via AssociateFleetRequest.builder()
associateFleetRequest - A Consumer that will call methods on AssociateFleetRequest.Builder to create a request.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException - The specified resource was not found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.IncompatibleImageException - The image can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchAssociateUserStackResponse batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest) throws OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
batchAssociateUserStackRequest - OperationNotPermittedException - The attempted operation is not permitted.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchAssociateUserStackResponse batchAssociateUserStack(Consumer<BatchAssociateUserStackRequest.Builder> batchAssociateUserStackRequest) throws OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
This is a convenience which creates an instance of the BatchAssociateUserStackRequest.Builder avoiding
the need to create one manually via BatchAssociateUserStackRequest.builder()
batchAssociateUserStackRequest - A Consumer that will call methods on BatchAssociateUserStackRequest.Builder to create a
request.OperationNotPermittedException - The attempted operation is not permitted.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDisassociateUserStackResponse batchDisassociateUserStack(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest) throws OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Disassociates the specified users from the specified stacks.
batchDisassociateUserStackRequest - OperationNotPermittedException - The attempted operation is not permitted.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDisassociateUserStackResponse batchDisassociateUserStack(Consumer<BatchDisassociateUserStackRequest.Builder> batchDisassociateUserStackRequest) throws OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Disassociates the specified users from the specified stacks.
This is a convenience which creates an instance of the BatchDisassociateUserStackRequest.Builder avoiding
the need to create one manually via BatchDisassociateUserStackRequest.builder()
batchDisassociateUserStackRequest - A Consumer that will call methods on BatchDisassociateUserStackRequest.Builder to create a
request.OperationNotPermittedException - The attempted operation is not permitted.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyImageResponse copyImage(CopyImageRequest copyImageRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, ResourceNotAvailableException, LimitExceededException, InvalidAccountStatusException, IncompatibleImageException, AwsServiceException, SdkClientException, AppStreamException
Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
copyImageRequest - ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The specified resource was not found.ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException - The image can't be updated because it's not compatible for updates.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyImageResponse copyImage(Consumer<CopyImageRequest.Builder> copyImageRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, ResourceNotAvailableException, LimitExceededException, InvalidAccountStatusException, IncompatibleImageException, AwsServiceException, SdkClientException, AppStreamException
Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
This is a convenience which creates an instance of the CopyImageRequest.Builder avoiding the need to
create one manually via CopyImageRequest.builder()
copyImageRequest - A Consumer that will call methods on CopyImageRequest.Builder to create a request.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The specified resource was not found.ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException - The image can't be updated because it's not compatible for updates.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAppBlockResponse createAppBlock(CreateAppBlockRequest createAppBlockRequest) throws ConcurrentModificationException, LimitExceededException, OperationNotPermittedException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, AppStreamException
Creates an app block.
App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.
This is only supported for Elastic fleets.
createAppBlockRequest - ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.LimitExceededException - The requested limit exceeds the permitted limit for an account.OperationNotPermittedException - The attempted operation is not permitted.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAppBlockResponse createAppBlock(Consumer<CreateAppBlockRequest.Builder> createAppBlockRequest) throws ConcurrentModificationException, LimitExceededException, OperationNotPermittedException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, AppStreamException
Creates an app block.
App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.
This is only supported for Elastic fleets.
This is a convenience which creates an instance of the CreateAppBlockRequest.Builder avoiding the need to
create one manually via CreateAppBlockRequest.builder()
createAppBlockRequest - A Consumer that will call methods on CreateAppBlockRequest.Builder to create a request.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.LimitExceededException - The requested limit exceeds the permitted limit for an account.OperationNotPermittedException - The attempted operation is not permitted.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws OperationNotPermittedException, ResourceAlreadyExistsException, LimitExceededException, ConcurrentModificationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Creates an application.
Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch.
This is only supported for Elastic fleets.
createApplicationRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The requested limit exceeds the permitted limit for an account.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws OperationNotPermittedException, ResourceAlreadyExistsException, LimitExceededException, ConcurrentModificationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Creates an application.
Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch.
This is only supported for Elastic fleets.
This is a convenience which creates an instance of the CreateApplicationRequest.Builder avoiding the need
to create one manually via CreateApplicationRequest.builder()
createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The requested limit exceeds the permitted limit for an account.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDirectoryConfigResponse createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, InvalidAccountStatusException, OperationNotPermittedException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException
Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
createDirectoryConfigRequest - ResourceNotFoundException - The specified resource was not found.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.OperationNotPermittedException - The attempted operation is not permitted.InvalidRoleException - The specified role is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDirectoryConfigResponse createDirectoryConfig(Consumer<CreateDirectoryConfigRequest.Builder> createDirectoryConfigRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, InvalidAccountStatusException, OperationNotPermittedException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException
Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
This is a convenience which creates an instance of the CreateDirectoryConfigRequest.Builder avoiding the
need to create one manually via CreateDirectoryConfigRequest.builder()
createDirectoryConfigRequest - A Consumer that will call methods on CreateDirectoryConfigRequest.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.OperationNotPermittedException - The attempted operation is not permitted.InvalidRoleException - The specified role is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEntitlementResponse createEntitlement(CreateEntitlementRequest createEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, LimitExceededException, EntitlementAlreadyExistsException, AwsServiceException, SdkClientException, AppStreamException
Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
createEntitlementRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The requested limit exceeds the permitted limit for an account.EntitlementAlreadyExistsException - The entitlement already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEntitlementResponse createEntitlement(Consumer<CreateEntitlementRequest.Builder> createEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, LimitExceededException, EntitlementAlreadyExistsException, AwsServiceException, SdkClientException, AppStreamException
Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
This is a convenience which creates an instance of the CreateEntitlementRequest.Builder avoiding the need
to create one manually via CreateEntitlementRequest.builder()
createEntitlementRequest - A Consumer that will call methods on CreateEntitlementRequest.Builder to create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.LimitExceededException - The requested limit exceeds the permitted limit for an account.EntitlementAlreadyExistsException - The entitlement already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFleetResponse createFleet(CreateFleetRequest createFleetRequest) throws ResourceAlreadyExistsException, ResourceNotAvailableException, ResourceNotFoundException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, InvalidRoleException, ConcurrentModificationException, InvalidParameterCombinationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
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.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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 can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFleetResponse createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest) throws ResourceAlreadyExistsException, ResourceNotAvailableException, ResourceNotFoundException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, InvalidRoleException, ConcurrentModificationException, InvalidParameterCombinationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
This is a convenience which creates an instance of the CreateFleetRequest.Builder avoiding the need to
create one manually via CreateFleetRequest.builder()
createFleetRequest - A Consumer that will call methods on CreateFleetRequest.Builder to create a request.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.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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 can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateImageBuilderResponse createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest) throws LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, ResourceAlreadyExistsException, ResourceNotAvailableException, ResourceNotFoundException, InvalidRoleException, ConcurrentModificationException, InvalidParameterCombinationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Creates an image builder. An image builder is a virtual machine that is used to create an image.
The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
createImageBuilderRequest - LimitExceededException - The requested limit exceeds the permitted limit for an account.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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 can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateImageBuilderResponse createImageBuilder(Consumer<CreateImageBuilderRequest.Builder> createImageBuilderRequest) throws LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, ResourceAlreadyExistsException, ResourceNotAvailableException, ResourceNotFoundException, InvalidRoleException, ConcurrentModificationException, InvalidParameterCombinationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Creates an image builder. An image builder is a virtual machine that is used to create an image.
The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
This is a convenience which creates an instance of the CreateImageBuilderRequest.Builder avoiding the
need to create one manually via CreateImageBuilderRequest.builder()
createImageBuilderRequest - A Consumer that will call methods on CreateImageBuilderRequest.Builder to create a
request.LimitExceededException - The requested limit exceeds the permitted limit for an account.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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 can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateImageBuilderStreamingUrlResponse createImageBuilderStreamingURL(CreateImageBuilderStreamingUrlRequest createImageBuilderStreamingUrlRequest) throws OperationNotPermittedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Creates a URL to start an image builder streaming session.
createImageBuilderStreamingUrlRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateImageBuilderStreamingUrlResponse createImageBuilderStreamingURL(Consumer<CreateImageBuilderStreamingUrlRequest.Builder> createImageBuilderStreamingUrlRequest) throws OperationNotPermittedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Creates a URL to start an image builder streaming session.
This is a convenience which creates an instance of the CreateImageBuilderStreamingUrlRequest.Builder
avoiding the need to create one manually via CreateImageBuilderStreamingUrlRequest.builder()
createImageBuilderStreamingUrlRequest - A Consumer that will call methods on CreateImageBuilderStreamingURLRequest.Builder to
create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackResponse createStack(CreateStackRequest createStackRequest) throws LimitExceededException, InvalidAccountStatusException, ResourceAlreadyExistsException, ConcurrentModificationException, InvalidRoleException, ResourceNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
createStackRequest - LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackResponse createStack(Consumer<CreateStackRequest.Builder> createStackRequest) throws LimitExceededException, InvalidAccountStatusException, ResourceAlreadyExistsException, ConcurrentModificationException, InvalidRoleException, ResourceNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
This is a convenience which creates an instance of the CreateStackRequest.Builder avoiding the need to
create one manually via CreateStackRequest.builder()
createStackRequest - A Consumer that will call methods on CreateStackRequest.Builder to create a request.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStreamingUrlResponse createStreamingURL(CreateStreamingUrlRequest createStreamingUrlRequest) throws ResourceNotFoundException, ResourceNotAvailableException, OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStreamingUrlResponse createStreamingURL(Consumer<CreateStreamingUrlRequest.Builder> createStreamingUrlRequest) throws ResourceNotFoundException, ResourceNotAvailableException, OperationNotPermittedException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
This is a convenience which creates an instance of the CreateStreamingUrlRequest.Builder avoiding the
need to create one manually via CreateStreamingUrlRequest.builder()
createStreamingUrlRequest - A Consumer that will call methods on CreateStreamingURLRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUpdatedImageResponse createUpdatedImage(CreateUpdatedImageRequest createUpdatedImageRequest) throws LimitExceededException, InvalidAccountStatusException, OperationNotPermittedException, ResourceAlreadyExistsException, ResourceNotFoundException, ConcurrentModificationException, IncompatibleImageException, AwsServiceException, SdkClientException, AppStreamException
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
createUpdatedImageRequest - LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.OperationNotPermittedException - The attempted operation is not permitted.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The specified resource was not found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.IncompatibleImageException - The image can't be updated because it's not compatible for updates.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUpdatedImageResponse createUpdatedImage(Consumer<CreateUpdatedImageRequest.Builder> createUpdatedImageRequest) throws LimitExceededException, InvalidAccountStatusException, OperationNotPermittedException, ResourceAlreadyExistsException, ResourceNotFoundException, ConcurrentModificationException, IncompatibleImageException, AwsServiceException, SdkClientException, AppStreamException
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
This is a convenience which creates an instance of the CreateUpdatedImageRequest.Builder avoiding the
need to create one manually via CreateUpdatedImageRequest.builder()
createUpdatedImageRequest - A Consumer that will call methods on CreateUpdatedImageRequest.Builder to create a
request.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.OperationNotPermittedException - The attempted operation is not permitted.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The specified resource was not found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.IncompatibleImageException - The image can't be updated because it's not compatible for updates.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUsageReportSubscriptionResponse createUsageReportSubscription(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest) throws InvalidRoleException, InvalidAccountStatusException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException
Creates a usage report subscription. Usage reports are generated daily.
createUsageReportSubscriptionRequest - InvalidRoleException - The specified role is invalid.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.LimitExceededException - The requested limit exceeds the permitted limit for an account.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUsageReportSubscriptionResponse createUsageReportSubscription(Consumer<CreateUsageReportSubscriptionRequest.Builder> createUsageReportSubscriptionRequest) throws InvalidRoleException, InvalidAccountStatusException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException
Creates a usage report subscription. Usage reports are generated daily.
This is a convenience which creates an instance of the CreateUsageReportSubscriptionRequest.Builder
avoiding the need to create one manually via CreateUsageReportSubscriptionRequest.builder()
createUsageReportSubscriptionRequest - A Consumer that will call methods on CreateUsageReportSubscriptionRequest.Builder to
create a request.InvalidRoleException - The specified role is invalid.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.LimitExceededException - The requested limit exceeds the permitted limit for an account.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceAlreadyExistsException, InvalidAccountStatusException, InvalidParameterCombinationException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Creates a new user in the user pool.
createUserRequest - ResourceAlreadyExistsException - The specified resource already exists.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.LimitExceededException - The requested limit exceeds the permitted limit for an account.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws ResourceAlreadyExistsException, InvalidAccountStatusException, InvalidParameterCombinationException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Creates a new user in the user pool.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.ResourceAlreadyExistsException - The specified resource already exists.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.LimitExceededException - The requested limit exceeds the permitted limit for an account.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAppBlockResponse deleteAppBlock(DeleteAppBlockRequest deleteAppBlockRequest) throws ConcurrentModificationException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes an app block.
deleteAppBlockRequest - ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceInUseException - The specified resource is in use.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAppBlockResponse deleteAppBlock(Consumer<DeleteAppBlockRequest.Builder> deleteAppBlockRequest) throws ConcurrentModificationException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes an app block.
This is a convenience which creates an instance of the DeleteAppBlockRequest.Builder avoiding the need to
create one manually via DeleteAppBlockRequest.builder()
deleteAppBlockRequest - A Consumer that will call methods on DeleteAppBlockRequest.Builder to create a request.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceInUseException - The specified resource is in use.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws OperationNotPermittedException, ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes an application.
deleteApplicationRequest - OperationNotPermittedException - The attempted operation is not permitted.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws OperationNotPermittedException, ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes an application.
This is a convenience which creates an instance of the DeleteApplicationRequest.Builder avoiding the need
to create one manually via DeleteApplicationRequest.builder()
deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.OperationNotPermittedException - The attempted operation is not permitted.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDirectoryConfigResponse deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
deleteDirectoryConfigRequest - ResourceInUseException - The specified resource is in use.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDirectoryConfigResponse deleteDirectoryConfig(Consumer<DeleteDirectoryConfigRequest.Builder> deleteDirectoryConfigRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
This is a convenience which creates an instance of the DeleteDirectoryConfigRequest.Builder avoiding the
need to create one manually via DeleteDirectoryConfigRequest.builder()
deleteDirectoryConfigRequest - A Consumer that will call methods on DeleteDirectoryConfigRequest.Builder to create a
request.ResourceInUseException - The specified resource is in use.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEntitlementResponse deleteEntitlement(DeleteEntitlementRequest deleteEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified entitlement.
deleteEntitlementRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.OperationNotPermittedException - The attempted operation is not permitted.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEntitlementResponse deleteEntitlement(Consumer<DeleteEntitlementRequest.Builder> deleteEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified entitlement.
This is a convenience which creates an instance of the DeleteEntitlementRequest.Builder avoiding the need
to create one manually via DeleteEntitlementRequest.builder()
deleteEntitlementRequest - A Consumer that will call methods on DeleteEntitlementRequest.Builder to create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.OperationNotPermittedException - The attempted operation is not permitted.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFleetResponse deleteFleet(DeleteFleetRequest deleteFleetRequest) throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified fleet.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFleetResponse deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest) throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified fleet.
This is a convenience which creates an instance of the DeleteFleetRequest.Builder avoiding the need to
create one manually via DeleteFleetRequest.builder()
deleteFleetRequest - A Consumer that will call methods on DeleteFleetRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteImageResponse deleteImage(DeleteImageRequest deleteImageRequest) throws ResourceInUseException, ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteImageResponse deleteImage(Consumer<DeleteImageRequest.Builder> deleteImageRequest) throws ResourceInUseException, ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
This is a convenience which creates an instance of the DeleteImageRequest.Builder avoiding the need to
create one manually via DeleteImageRequest.builder()
deleteImageRequest - A Consumer that will call methods on DeleteImageRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteImageBuilderResponse deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest) throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified image builder and releases the capacity.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteImageBuilderResponse deleteImageBuilder(Consumer<DeleteImageBuilderRequest.Builder> deleteImageBuilderRequest) throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified image builder and releases the capacity.
This is a convenience which creates an instance of the DeleteImageBuilderRequest.Builder avoiding the
need to create one manually via DeleteImageBuilderRequest.builder()
deleteImageBuilderRequest - A Consumer that will call methods on DeleteImageBuilderRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteImagePermissionsResponse deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest) throws ResourceNotAvailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
deleteImagePermissionsRequest - ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteImagePermissionsResponse deleteImagePermissions(Consumer<DeleteImagePermissionsRequest.Builder> deleteImagePermissionsRequest) throws ResourceNotAvailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
This is a convenience which creates an instance of the DeleteImagePermissionsRequest.Builder avoiding the
need to create one manually via DeleteImagePermissionsRequest.builder()
deleteImagePermissionsRequest - A Consumer that will call methods on DeleteImagePermissionsRequest.Builder to create a
request.ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws ResourceInUseException, ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
deleteStackRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackResponse deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) throws ResourceInUseException, ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
This is a convenience which creates an instance of the DeleteStackRequest.Builder avoiding the need to
create one manually via DeleteStackRequest.builder()
deleteStackRequest - A Consumer that will call methods on DeleteStackRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUsageReportSubscriptionResponse deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest) throws InvalidAccountStatusException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Disables usage report generation.
deleteUsageReportSubscriptionRequest - InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUsageReportSubscriptionResponse deleteUsageReportSubscription(Consumer<DeleteUsageReportSubscriptionRequest.Builder> deleteUsageReportSubscriptionRequest) throws InvalidAccountStatusException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Disables usage report generation.
This is a convenience which creates an instance of the DeleteUsageReportSubscriptionRequest.Builder
avoiding the need to create one manually via DeleteUsageReportSubscriptionRequest.builder()
deleteUsageReportSubscriptionRequest - A Consumer that will call methods on DeleteUsageReportSubscriptionRequest.Builder to
create a request.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes a user from the user pool.
deleteUserRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes a user from the user pool.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAppBlocksResponse describeAppBlocks(DescribeAppBlocksRequest describeAppBlocksRequest) throws OperationNotPermittedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more app blocks.
describeAppBlocksRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAppBlocksResponse describeAppBlocks(Consumer<DescribeAppBlocksRequest.Builder> describeAppBlocksRequest) throws OperationNotPermittedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more app blocks.
This is a convenience which creates an instance of the DescribeAppBlocksRequest.Builder avoiding the need
to create one manually via DescribeAppBlocksRequest.builder()
describeAppBlocksRequest - A Consumer that will call methods on DescribeAppBlocksRequest.Builder to create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeApplicationFleetAssociationsResponse describeApplicationFleetAssociations(DescribeApplicationFleetAssociationsRequest describeApplicationFleetAssociationsRequest) throws InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
describeApplicationFleetAssociationsRequest - InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeApplicationFleetAssociationsResponse describeApplicationFleetAssociations(Consumer<DescribeApplicationFleetAssociationsRequest.Builder> describeApplicationFleetAssociationsRequest) throws InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
This is a convenience which creates an instance of the
DescribeApplicationFleetAssociationsRequest.Builder avoiding the need to create one manually via
DescribeApplicationFleetAssociationsRequest.builder()
describeApplicationFleetAssociationsRequest - A Consumer that will call methods on DescribeApplicationFleetAssociationsRequest.Builder
to create a request.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeApplicationsResponse describeApplications(DescribeApplicationsRequest describeApplicationsRequest) throws OperationNotPermittedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more applications.
describeApplicationsRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeApplicationsResponse describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) throws OperationNotPermittedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more applications.
This is a convenience which creates an instance of the DescribeApplicationsRequest.Builder avoiding the
need to create one manually via DescribeApplicationsRequest.builder()
describeApplicationsRequest - A Consumer that will call methods on DescribeApplicationsRequest.Builder to create a
request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDirectoryConfigsResponse describeDirectoryConfigs() throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDirectoryConfigs(DescribeDirectoryConfigsRequest),
AWS API Documentationdefault DescribeDirectoryConfigsResponse describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
describeDirectoryConfigsRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDirectoryConfigsResponse describeDirectoryConfigs(Consumer<DescribeDirectoryConfigsRequest.Builder> describeDirectoryConfigsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
This is a convenience which creates an instance of the DescribeDirectoryConfigsRequest.Builder avoiding
the need to create one manually via DescribeDirectoryConfigsRequest.builder()
describeDirectoryConfigsRequest - A Consumer that will call methods on DescribeDirectoryConfigsRequest.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEntitlementsResponse describeEntitlements(DescribeEntitlementsRequest describeEntitlementsRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one of more entitlements.
describeEntitlementsRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEntitlementsResponse describeEntitlements(Consumer<DescribeEntitlementsRequest.Builder> describeEntitlementsRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one of more entitlements.
This is a convenience which creates an instance of the DescribeEntitlementsRequest.Builder avoiding the
need to create one manually via DescribeEntitlementsRequest.builder()
describeEntitlementsRequest - A Consumer that will call methods on DescribeEntitlementsRequest.Builder to create a
request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFleetsResponse describeFleets() throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeFleets(DescribeFleetsRequest),
AWS API
Documentationdefault DescribeFleetsResponse describeFleets(DescribeFleetsRequest describeFleetsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
describeFleetsRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFleetsResponse describeFleets(Consumer<DescribeFleetsRequest.Builder> describeFleetsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
This is a convenience which creates an instance of the DescribeFleetsRequest.Builder avoiding the need to
create one manually via DescribeFleetsRequest.builder()
describeFleetsRequest - A Consumer that will call methods on DescribeFleetsRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageBuildersResponse describeImageBuilders() throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeImageBuilders(DescribeImageBuildersRequest),
AWS API Documentationdefault DescribeImageBuildersResponse describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
describeImageBuildersRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageBuildersResponse describeImageBuilders(Consumer<DescribeImageBuildersRequest.Builder> describeImageBuildersRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
This is a convenience which creates an instance of the DescribeImageBuildersRequest.Builder avoiding the
need to create one manually via DescribeImageBuildersRequest.builder()
describeImageBuildersRequest - A Consumer that will call methods on DescribeImageBuildersRequest.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagePermissionsResponse describeImagePermissions(DescribeImagePermissionsRequest describeImagePermissionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
describeImagePermissionsRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagePermissionsResponse describeImagePermissions(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
This is a convenience which creates an instance of the DescribeImagePermissionsRequest.Builder avoiding
the need to create one manually via DescribeImagePermissionsRequest.builder()
describeImagePermissionsRequest - A Consumer that will call methods on DescribeImagePermissionsRequest.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagePermissionsIterable describeImagePermissionsPaginator(DescribeImagePermissionsRequest describeImagePermissionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
This is a variant of
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client
.describeImagePermissionsPaginator(request);
for (software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation.
describeImagePermissionsRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagePermissionsIterable describeImagePermissionsPaginator(Consumer<DescribeImagePermissionsRequest.Builder> describeImagePermissionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
This is a variant of
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client
.describeImagePermissionsPaginator(request);
for (software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.appstream.paginators.DescribeImagePermissionsIterable responses = client.describeImagePermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImagePermissions(software.amazon.awssdk.services.appstream.model.DescribeImagePermissionsRequest)
operation.
This is a convenience which creates an instance of the DescribeImagePermissionsRequest.Builder avoiding
the need to create one manually via DescribeImagePermissionsRequest.builder()
describeImagePermissionsRequest - A Consumer that will call methods on DescribeImagePermissionsRequest.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesResponse describeImages() throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeImages(DescribeImagesRequest),
AWS API
Documentationdefault DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
describeImagesRequest - InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on DescribeImagesRequest.Builder to create a request.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesIterable describeImagesPaginator() throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
This is a variant of
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client
.describeImagesPaginator(request);
for (software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest) operation.
InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeImagesPaginator(DescribeImagesRequest),
AWS API
Documentationdefault DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
This is a variant of
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client
.describeImagesPaginator(request);
for (software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest) operation.
describeImagesRequest - InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws InvalidParameterCombinationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
This is a variant of
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client
.describeImagesPaginator(request);
for (software.amazon.awssdk.services.appstream.model.DescribeImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.appstream.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.appstream.model.DescribeImagesRequest) operation.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on DescribeImagesRequest.Builder to create a request.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSessionsResponse describeSessions(DescribeSessionsRequest describeSessionsRequest) throws InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
describeSessionsRequest - InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSessionsResponse describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest) throws InvalidParameterCombinationException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
This is a convenience which creates an instance of the DescribeSessionsRequest.Builder avoiding the need
to create one manually via DescribeSessionsRequest.builder()
describeSessionsRequest - A Consumer that will call methods on DescribeSessionsRequest.Builder to create a request.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksResponse describeStacks() throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeStacks(DescribeStacksRequest),
AWS API
Documentationdefault DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
describeStacksRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksResponse describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
This is a convenience which creates an instance of the DescribeStacksRequest.Builder avoiding the need to
create one manually via DescribeStacksRequest.builder()
describeStacksRequest - A Consumer that will call methods on DescribeStacksRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUsageReportSubscriptionsResponse describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest) throws ResourceNotFoundException, InvalidAccountStatusException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more usage report subscriptions.
describeUsageReportSubscriptionsRequest - ResourceNotFoundException - The specified resource was not found.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUsageReportSubscriptionsResponse describeUsageReportSubscriptions(Consumer<DescribeUsageReportSubscriptionsRequest.Builder> describeUsageReportSubscriptionsRequest) throws ResourceNotFoundException, InvalidAccountStatusException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more usage report subscriptions.
This is a convenience which creates an instance of the DescribeUsageReportSubscriptionsRequest.Builder
avoiding the need to create one manually via DescribeUsageReportSubscriptionsRequest.builder()
describeUsageReportSubscriptionsRequest - A Consumer that will call methods on DescribeUsageReportSubscriptionsRequest.Builder to
create a request.ResourceNotFoundException - The specified resource was not found.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserStackAssociationsResponse describeUserStackAssociations(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest) throws InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
The stack name
The user name (email address of the user associated with the stack) and the authentication type for the user
describeUserStackAssociationsRequest - InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUserStackAssociationsResponse describeUserStackAssociations(Consumer<DescribeUserStackAssociationsRequest.Builder> describeUserStackAssociationsRequest) throws InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
The stack name
The user name (email address of the user associated with the stack) and the authentication type for the user
This is a convenience which creates an instance of the DescribeUserStackAssociationsRequest.Builder
avoiding the need to create one manually via DescribeUserStackAssociationsRequest.builder()
describeUserStackAssociationsRequest - A Consumer that will call methods on DescribeUserStackAssociationsRequest.Builder to
create a request.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUsersResponse describeUsers(DescribeUsersRequest describeUsersRequest) throws ResourceNotFoundException, InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified users in the user pool.
describeUsersRequest - ResourceNotFoundException - The specified resource was not found.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUsersResponse describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws ResourceNotFoundException, InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list that describes one or more specified users in the user pool.
This is a convenience which creates an instance of the DescribeUsersRequest.Builder avoiding the need to
create one manually via DescribeUsersRequest.builder()
describeUsersRequest - A Consumer that will call methods on DescribeUsersRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableUserResponse disableUser(DisableUserRequest disableUserRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
disableUserRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableUserResponse disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
This is a convenience which creates an instance of the DisableUserRequest.Builder avoiding the need to
create one manually via DisableUserRequest.builder()
disableUserRequest - A Consumer that will call methods on DisableUserRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateApplicationFleetResponse disassociateApplicationFleet(DisassociateApplicationFleetRequest disassociateApplicationFleetRequest) throws ConcurrentModificationException, InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Disassociates the specified application from the fleet.
disassociateApplicationFleetRequest - ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateApplicationFleetResponse disassociateApplicationFleet(Consumer<DisassociateApplicationFleetRequest.Builder> disassociateApplicationFleetRequest) throws ConcurrentModificationException, InvalidParameterCombinationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Disassociates the specified application from the fleet.
This is a convenience which creates an instance of the DisassociateApplicationFleetRequest.Builder
avoiding the need to create one manually via DisassociateApplicationFleetRequest.builder()
disassociateApplicationFleetRequest - A Consumer that will call methods on DisassociateApplicationFleetRequest.Builder to create
a request.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateApplicationFromEntitlementResponse disassociateApplicationFromEntitlement(DisassociateApplicationFromEntitlementRequest disassociateApplicationFromEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified application from the specified entitlement.
disassociateApplicationFromEntitlementRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateApplicationFromEntitlementResponse disassociateApplicationFromEntitlement(Consumer<DisassociateApplicationFromEntitlementRequest.Builder> disassociateApplicationFromEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Deletes the specified application from the specified entitlement.
This is a convenience which creates an instance of the
DisassociateApplicationFromEntitlementRequest.Builder avoiding the need to create one manually via
DisassociateApplicationFromEntitlementRequest.builder()
disassociateApplicationFromEntitlementRequest - A Consumer that will call methods on DisassociateApplicationFromEntitlementRequest.Builder
to create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateFleetResponse disassociateFleet(DisassociateFleetRequest disassociateFleetRequest) throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Disassociates the specified fleet from the specified stack.
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.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateFleetResponse disassociateFleet(Consumer<DisassociateFleetRequest.Builder> disassociateFleetRequest) throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
Disassociates the specified fleet from the specified stack.
This is a convenience which creates an instance of the DisassociateFleetRequest.Builder avoiding the need
to create one manually via DisassociateFleetRequest.builder()
disassociateFleetRequest - A Consumer that will call methods on DisassociateFleetRequest.Builder to create a request.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.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableUserResponse enableUser(EnableUserRequest enableUserRequest) throws ResourceNotFoundException, InvalidAccountStatusException, AwsServiceException, SdkClientException, AppStreamException
Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
enableUserRequest - ResourceNotFoundException - The specified resource was not found.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableUserResponse enableUser(Consumer<EnableUserRequest.Builder> enableUserRequest) throws ResourceNotFoundException, InvalidAccountStatusException, AwsServiceException, SdkClientException, AppStreamException
Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
This is a convenience which creates an instance of the EnableUserRequest.Builder avoiding the need to
create one manually via EnableUserRequest.builder()
enableUserRequest - A Consumer that will call methods on EnableUserRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExpireSessionResponse expireSession(ExpireSessionRequest expireSessionRequest) throws AwsServiceException, SdkClientException, AppStreamException
Immediately stops the specified streaming session.
expireSessionRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExpireSessionResponse expireSession(Consumer<ExpireSessionRequest.Builder> expireSessionRequest) throws AwsServiceException, SdkClientException, AppStreamException
Immediately stops the specified streaming session.
This is a convenience which creates an instance of the ExpireSessionRequest.Builder avoiding the need to
create one manually via ExpireSessionRequest.builder()
expireSessionRequest - A Consumer that will call methods on ExpireSessionRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssociatedFleetsResponse listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest) throws AwsServiceException, SdkClientException, AppStreamException
Retrieves the name of the fleet that is associated with the specified stack.
listAssociatedFleetsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssociatedFleetsResponse listAssociatedFleets(Consumer<ListAssociatedFleetsRequest.Builder> listAssociatedFleetsRequest) throws AwsServiceException, SdkClientException, AppStreamException
Retrieves the name of the fleet that is associated with the specified stack.
This is a convenience which creates an instance of the ListAssociatedFleetsRequest.Builder avoiding the
need to create one manually via ListAssociatedFleetsRequest.builder()
listAssociatedFleetsRequest - A Consumer that will call methods on ListAssociatedFleetsRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssociatedStacksResponse listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest) throws AwsServiceException, SdkClientException, AppStreamException
Retrieves the name of the stack with which the specified fleet is associated.
listAssociatedStacksRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAssociatedStacksResponse listAssociatedStacks(Consumer<ListAssociatedStacksRequest.Builder> listAssociatedStacksRequest) throws AwsServiceException, SdkClientException, AppStreamException
Retrieves the name of the stack with which the specified fleet is associated.
This is a convenience which creates an instance of the ListAssociatedStacksRequest.Builder avoiding the
need to create one manually via ListAssociatedStacksRequest.builder()
listAssociatedStacksRequest - A Consumer that will call methods on ListAssociatedStacksRequest.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEntitledApplicationsResponse listEntitledApplications(ListEntitledApplicationsRequest listEntitledApplicationsRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list of entitled applications.
listEntitledApplicationsRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEntitledApplicationsResponse listEntitledApplications(Consumer<ListEntitledApplicationsRequest.Builder> listEntitledApplicationsRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list of entitled applications.
This is a convenience which creates an instance of the ListEntitledApplicationsRequest.Builder avoiding
the need to create one manually via ListEntitledApplicationsRequest.builder()
listEntitledApplicationsRequest - A Consumer that will call methods on ListEntitledApplicationsRequest.Builder to create a
request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list of all 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 Administration Guide.
listTagsForResourceRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Retrieves a list of all 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 Administration Guide.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartFleetResponse startFleet(StartFleetRequest startFleetRequest) throws ResourceNotFoundException, OperationNotPermittedException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, ConcurrentModificationException, ResourceNotAvailableException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException
Starts the specified fleet.
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.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.InvalidRoleException - The specified role is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartFleetResponse startFleet(Consumer<StartFleetRequest.Builder> startFleetRequest) throws ResourceNotFoundException, OperationNotPermittedException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, ConcurrentModificationException, ResourceNotAvailableException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException
Starts the specified fleet.
This is a convenience which creates an instance of the StartFleetRequest.Builder avoiding the need to
create one manually via StartFleetRequest.builder()
startFleetRequest - A Consumer that will call methods on StartFleetRequest.Builder to create a request.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.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.InvalidRoleException - The specified role is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartImageBuilderResponse startImageBuilder(StartImageBuilderRequest startImageBuilderRequest) throws ResourceNotAvailableException, ResourceNotFoundException, ConcurrentModificationException, InvalidAccountStatusException, IncompatibleImageException, AwsServiceException, SdkClientException, AppStreamException
Starts the specified image builder.
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.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException - The image can't be updated because it's not compatible for updates.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartImageBuilderResponse startImageBuilder(Consumer<StartImageBuilderRequest.Builder> startImageBuilderRequest) throws ResourceNotAvailableException, ResourceNotFoundException, ConcurrentModificationException, InvalidAccountStatusException, IncompatibleImageException, AwsServiceException, SdkClientException, AppStreamException
Starts the specified image builder.
This is a convenience which creates an instance of the StartImageBuilderRequest.Builder avoiding the need
to create one manually via StartImageBuilderRequest.builder()
startImageBuilderRequest - A Consumer that will call methods on StartImageBuilderRequest.Builder to create a request.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.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException - The image can't be updated because it's not compatible for updates.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopFleetResponse stopFleet(StopFleetRequest stopFleetRequest) throws ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Stops the specified fleet.
stopFleetRequest - ResourceNotFoundException - The specified resource was not found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopFleetResponse stopFleet(Consumer<StopFleetRequest.Builder> stopFleetRequest) throws ResourceNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Stops the specified fleet.
This is a convenience which creates an instance of the StopFleetRequest.Builder avoiding the need to
create one manually via StopFleetRequest.builder()
stopFleetRequest - A Consumer that will call methods on StopFleetRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopImageBuilderResponse stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest) throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Stops the specified image builder.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopImageBuilderResponse stopImageBuilder(Consumer<StopImageBuilderRequest.Builder> stopImageBuilderRequest) throws ResourceNotFoundException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Stops the specified image builder.
This is a convenience which creates an instance of the StopImageBuilderRequest.Builder avoiding the need
to create one manually via StopImageBuilderRequest.builder()
stopImageBuilderRequest - A Consumer that will call methods on StopImageBuilderRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws LimitExceededException, InvalidAccountStatusException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
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 Administration Guide.
tagResourceRequest - LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws LimitExceededException, InvalidAccountStatusException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
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 Administration Guide.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.LimitExceededException - The requested limit exceeds the permitted limit for an account.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Disassociates one or more 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 Administration Guide.
untagResourceRequest - ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Disassociates one or more 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 Administration Guide.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws OperationNotPermittedException, ConcurrentModificationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified application.
updateApplicationRequest - OperationNotPermittedException - The attempted operation is not permitted.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws OperationNotPermittedException, ConcurrentModificationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified application.
This is a convenience which creates an instance of the UpdateApplicationRequest.Builder avoiding the need
to create one manually via UpdateApplicationRequest.builder()
updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.OperationNotPermittedException - The attempted operation is not permitted.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.ResourceNotFoundException - The specified resource was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDirectoryConfigResponse updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest) throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, OperationNotPermittedException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
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.OperationNotPermittedException - The attempted operation is not permitted.InvalidRoleException - The specified role is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDirectoryConfigResponse updateDirectoryConfig(Consumer<UpdateDirectoryConfigRequest.Builder> updateDirectoryConfigRequest) throws ResourceInUseException, ResourceNotFoundException, ConcurrentModificationException, OperationNotPermittedException, InvalidRoleException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
This is a convenience which creates an instance of the UpdateDirectoryConfigRequest.Builder avoiding the
need to create one manually via UpdateDirectoryConfigRequest.builder()
updateDirectoryConfigRequest - A Consumer that will call methods on UpdateDirectoryConfigRequest.Builder to create a
request.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.OperationNotPermittedException - The attempted operation is not permitted.InvalidRoleException - The specified role is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateEntitlementResponse updateEntitlement(UpdateEntitlementRequest updateEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified entitlement.
updateEntitlementRequest - OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateEntitlementResponse updateEntitlement(Consumer<UpdateEntitlementRequest.Builder> updateEntitlementRequest) throws OperationNotPermittedException, ResourceNotFoundException, EntitlementNotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified entitlement.
This is a convenience which creates an instance of the UpdateEntitlementRequest.Builder avoiding the need
to create one manually via UpdateEntitlementRequest.builder()
updateEntitlementRequest - A Consumer that will call methods on UpdateEntitlementRequest.Builder to create a request.OperationNotPermittedException - The attempted operation is not permitted.ResourceNotFoundException - The specified resource was not found.EntitlementNotFoundException - The entitlement can't be found.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFleetResponse updateFleet(UpdateFleetRequest updateFleetRequest) throws ResourceInUseException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, InvalidRoleException, ResourceNotFoundException, ResourceNotAvailableException, InvalidParameterCombinationException, ConcurrentModificationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
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 following based on the fleet type:
Always-On and On-Demand fleet types
You can update the DisplayName, ComputeCapacity, ImageARN,
ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds
attributes.
Elastic fleet type
You can update the DisplayName, IdleDisconnectTimeoutInSeconds,
DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location
and UsbDeviceFilterStrings attributes.
If the fleet is in the STARTING or STOPPED state, you can't update it.
updateFleetRequest - ResourceInUseException - The specified resource is in use.LimitExceededException - The requested limit exceeds the permitted limit for an account.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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 can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFleetResponse updateFleet(Consumer<UpdateFleetRequest.Builder> updateFleetRequest) throws ResourceInUseException, LimitExceededException, RequestLimitExceededException, InvalidAccountStatusException, InvalidRoleException, ResourceNotFoundException, ResourceNotAvailableException, InvalidParameterCombinationException, ConcurrentModificationException, IncompatibleImageException, OperationNotPermittedException, AwsServiceException, SdkClientException, AppStreamException
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 following based on the fleet type:
Always-On and On-Demand fleet types
You can update the DisplayName, ComputeCapacity, ImageARN,
ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds
attributes.
Elastic fleet type
You can update the DisplayName, IdleDisconnectTimeoutInSeconds,
DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location
and UsbDeviceFilterStrings attributes.
If the fleet is in the STARTING or STOPPED state, you can't update it.
This is a convenience which creates an instance of the UpdateFleetRequest.Builder avoiding the need to
create one manually via UpdateFleetRequest.builder()
updateFleetRequest - A Consumer that will call methods on UpdateFleetRequest.Builder to create a request.ResourceInUseException - The specified resource is in use.LimitExceededException - The requested limit exceeds the permitted limit for an account.RequestLimitExceededException - AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are
being throttled by Amazon EC2. Try again later.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.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 can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateImagePermissionsResponse updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest) throws ResourceNotFoundException, ResourceNotAvailableException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException
Adds or updates permissions for the specified private image.
updateImagePermissionsRequest - ResourceNotFoundException - The specified resource was not found.ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.LimitExceededException - The requested limit exceeds the permitted limit for an account.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateImagePermissionsResponse updateImagePermissions(Consumer<UpdateImagePermissionsRequest.Builder> updateImagePermissionsRequest) throws ResourceNotFoundException, ResourceNotAvailableException, LimitExceededException, AwsServiceException, SdkClientException, AppStreamException
Adds or updates permissions for the specified private image.
This is a convenience which creates an instance of the UpdateImagePermissionsRequest.Builder avoiding the
need to create one manually via UpdateImagePermissionsRequest.builder()
updateImagePermissionsRequest - A Consumer that will call methods on UpdateImagePermissionsRequest.Builder to create a
request.ResourceNotFoundException - The specified resource was not found.ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.LimitExceededException - The requested limit exceeds the permitted limit for an account.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidRoleException, InvalidParameterCombinationException, LimitExceededException, InvalidAccountStatusException, IncompatibleImageException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified fields for the specified stack.
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.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException - The image can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackResponse updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidRoleException, InvalidParameterCombinationException, LimitExceededException, InvalidAccountStatusException, IncompatibleImageException, OperationNotPermittedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AppStreamException
Updates the specified fields for the specified stack.
This is a convenience which creates an instance of the UpdateStackRequest.Builder avoiding the need to
create one manually via UpdateStackRequest.builder()
updateStackRequest - A Consumer that will call methods on UpdateStackRequest.Builder to create a request.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.InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS
Support.IncompatibleImageException - The image can't be updated because it's not compatible for updates.OperationNotPermittedException - The attempted operation is not permitted.ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppStreamException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AppStreamWaiter waiter()
AppStreamWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
AppStreamWaiterstatic AppStreamClient create()
AppStreamClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AppStreamClientBuilder builder()
AppStreamClient.static ServiceMetadata serviceMetadata()
default AppStreamServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.