@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonAppStream extends Object implements AmazonAppStream
AmazonAppStream
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateFleetResult |
associateFleet(AssociateFleetRequest request)
Associates the specified fleet with the specified stack.
|
BatchAssociateUserStackResult |
batchAssociateUserStack(BatchAssociateUserStackRequest request)
Associates the specified users with the specified stacks.
|
BatchDisassociateUserStackResult |
batchDisassociateUserStack(BatchDisassociateUserStackRequest request)
Disassociates the specified users from the specified stacks.
|
CopyImageResult |
copyImage(CopyImageRequest request)
Copies the image within the same region or to a new region within the same AWS account.
|
CreateDirectoryConfigResult |
createDirectoryConfig(CreateDirectoryConfigRequest request)
Creates a Directory Config object in AppStream 2.0.
|
CreateFleetResult |
createFleet(CreateFleetRequest request)
Creates a fleet.
|
CreateImageBuilderResult |
createImageBuilder(CreateImageBuilderRequest request)
Creates an image builder.
|
CreateImageBuilderStreamingURLResult |
createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)
Creates a URL to start an image builder streaming session.
|
CreateStackResult |
createStack(CreateStackRequest request)
Creates a stack to start streaming applications to users.
|
CreateStreamingURLResult |
createStreamingURL(CreateStreamingURLRequest request)
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
|
CreateUsageReportSubscriptionResult |
createUsageReportSubscription(CreateUsageReportSubscriptionRequest request)
Creates a usage report subscription.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a new user in the user pool.
|
DeleteDirectoryConfigResult |
deleteDirectoryConfig(DeleteDirectoryConfigRequest request)
Deletes the specified Directory Config object from AppStream 2.0.
|
DeleteFleetResult |
deleteFleet(DeleteFleetRequest request)
Deletes the specified fleet.
|
DeleteImageResult |
deleteImage(DeleteImageRequest request)
Deletes the specified image.
|
DeleteImageBuilderResult |
deleteImageBuilder(DeleteImageBuilderRequest request)
Deletes the specified image builder and releases the capacity.
|
DeleteImagePermissionsResult |
deleteImagePermissions(DeleteImagePermissionsRequest request)
Deletes permissions for the specified private image.
|
DeleteStackResult |
deleteStack(DeleteStackRequest request)
Deletes the specified stack.
|
DeleteUsageReportSubscriptionResult |
deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest request)
Disables usage report generation.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user from the user pool.
|
DescribeDirectoryConfigsResult |
describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names
for these objects are provided.
|
DescribeFleetsResult |
describeFleets(DescribeFleetsRequest request)
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
|
DescribeImageBuildersResult |
describeImageBuilders(DescribeImageBuildersRequest request)
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
|
DescribeImagePermissionsResult |
describeImagePermissions(DescribeImagePermissionsRequest request)
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
|
DescribeImagesResult |
describeImages(DescribeImagesRequest request)
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
|
DescribeSessionsResult |
describeSessions(DescribeSessionsRequest request)
Retrieves a list that describes the streaming sessions for a specified stack and fleet.
|
DescribeStacksResult |
describeStacks(DescribeStacksRequest request)
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
|
DescribeUsageReportSubscriptionsResult |
describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest request)
Retrieves a list that describes one or more usage report subscriptions.
|
DescribeUsersResult |
describeUsers(DescribeUsersRequest request)
Retrieves a list that describes one or more specified users in the user pool.
|
DescribeUserStackAssociationsResult |
describeUserStackAssociations(DescribeUserStackAssociationsRequest request)
Retrieves a list that describes the UserStackAssociation objects.
|
DisableUserResult |
disableUser(DisableUserRequest request)
Disables the specified user in the user pool.
|
DisassociateFleetResult |
disassociateFleet(DisassociateFleetRequest request)
Disassociates the specified fleet from the specified stack.
|
EnableUserResult |
enableUser(EnableUserRequest request)
Enables a user in the user pool.
|
ExpireSessionResult |
expireSession(ExpireSessionRequest request)
Immediately stops the specified streaming session.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAssociatedFleetsResult |
listAssociatedFleets(ListAssociatedFleetsRequest request)
Retrieves the name of the fleet that is associated with the specified stack.
|
ListAssociatedStacksResult |
listAssociatedStacks(ListAssociatedStacksRequest request)
Retrieves the name of the stack with which the specified fleet is associated.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves a list of all tags for the specified AppStream 2.0 resource.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("appstream2.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonAppStream.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartFleetResult |
startFleet(StartFleetRequest request)
Starts the specified fleet.
|
StartImageBuilderResult |
startImageBuilder(StartImageBuilderRequest request)
Starts the specified image builder.
|
StopFleetResult |
stopFleet(StopFleetRequest request)
Stops the specified fleet.
|
StopImageBuilderResult |
stopImageBuilder(StopImageBuilderRequest request)
Stops the specified image builder.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Disassociates one or more specified tags from the specified AppStream 2.0 resource.
|
UpdateDirectoryConfigResult |
updateDirectoryConfig(UpdateDirectoryConfigRequest request)
Updates the specified Directory Config object in AppStream 2.0.
|
UpdateFleetResult |
updateFleet(UpdateFleetRequest request)
Updates the specified fleet.
|
UpdateImagePermissionsResult |
updateImagePermissions(UpdateImagePermissionsRequest request)
Adds or updates permissions for the specified private image.
|
UpdateStackResult |
updateStack(UpdateStackRequest request)
Updates the specified fields for the specified stack.
|
AmazonAppStreamWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonAppStream
Callers can pass in just the endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "appstream2.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonAppStream
endpoint
- The endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"appstream2.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonAppStream
AmazonAppStream.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonAppStream
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AssociateFleetResult associateFleet(AssociateFleetRequest request)
AmazonAppStream
Associates the specified fleet with the specified stack.
associateFleet
in interface AmazonAppStream
public BatchAssociateUserStackResult batchAssociateUserStack(BatchAssociateUserStackRequest request)
AmazonAppStream
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.
batchAssociateUserStack
in interface AmazonAppStream
public BatchDisassociateUserStackResult batchDisassociateUserStack(BatchDisassociateUserStackRequest request)
AmazonAppStream
Disassociates the specified users from the specified stacks.
batchDisassociateUserStack
in interface AmazonAppStream
public CopyImageResult copyImage(CopyImageRequest request)
AmazonAppStream
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.
copyImage
in interface AmazonAppStream
public CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest request)
AmazonAppStream
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.
createDirectoryConfig
in interface AmazonAppStream
public CreateFleetResult createFleet(CreateFleetRequest request)
AmazonAppStream
Creates a fleet. A fleet consists of streaming instances that run a specified image.
createFleet
in interface AmazonAppStream
public CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest request)
AmazonAppStream
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
.
createImageBuilder
in interface AmazonAppStream
public CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest request)
AmazonAppStream
Creates a URL to start an image builder streaming session.
createImageBuilderStreamingURL
in interface AmazonAppStream
public CreateStackResult createStack(CreateStackRequest request)
AmazonAppStream
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
createStack
in interface AmazonAppStream
public CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest request)
AmazonAppStream
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.
createStreamingURL
in interface AmazonAppStream
public CreateUsageReportSubscriptionResult createUsageReportSubscription(CreateUsageReportSubscriptionRequest request)
AmazonAppStream
Creates a usage report subscription. Usage reports are generated daily.
createUsageReportSubscription
in interface AmazonAppStream
public CreateUserResult createUser(CreateUserRequest request)
AmazonAppStream
Creates a new user in the user pool.
createUser
in interface AmazonAppStream
public DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest request)
AmazonAppStream
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.
deleteDirectoryConfig
in interface AmazonAppStream
public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
AmazonAppStream
Deletes the specified fleet.
deleteFleet
in interface AmazonAppStream
public DeleteImageResult deleteImage(DeleteImageRequest request)
AmazonAppStream
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.
deleteImage
in interface AmazonAppStream
public DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest request)
AmazonAppStream
Deletes the specified image builder and releases the capacity.
deleteImageBuilder
in interface AmazonAppStream
public DeleteImagePermissionsResult deleteImagePermissions(DeleteImagePermissionsRequest request)
AmazonAppStream
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.
deleteImagePermissions
in interface AmazonAppStream
public DeleteStackResult deleteStack(DeleteStackRequest request)
AmazonAppStream
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.
deleteStack
in interface AmazonAppStream
public DeleteUsageReportSubscriptionResult deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest request)
AmazonAppStream
Disables usage report generation.
deleteUsageReportSubscription
in interface AmazonAppStream
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonAppStream
Deletes a user from the user pool.
deleteUser
in interface AmazonAppStream
public DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest request)
AmazonAppStream
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.
describeDirectoryConfigs
in interface AmazonAppStream
public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)
AmazonAppStream
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
describeFleets
in interface AmazonAppStream
public DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest request)
AmazonAppStream
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.
describeImageBuilders
in interface AmazonAppStream
public DescribeImagePermissionsResult describeImagePermissions(DescribeImagePermissionsRequest request)
AmazonAppStream
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
describeImagePermissions
in interface AmazonAppStream
public DescribeImagesResult describeImages(DescribeImagesRequest request)
AmazonAppStream
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.
describeImages
in interface AmazonAppStream
public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)
AmazonAppStream
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.
describeSessions
in interface AmazonAppStream
public DescribeStacksResult describeStacks(DescribeStacksRequest request)
AmazonAppStream
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
describeStacks
in interface AmazonAppStream
public DescribeUsageReportSubscriptionsResult describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest request)
AmazonAppStream
Retrieves a list that describes one or more usage report subscriptions.
describeUsageReportSubscriptions
in interface AmazonAppStream
public DescribeUserStackAssociationsResult describeUserStackAssociations(DescribeUserStackAssociationsRequest request)
AmazonAppStream
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
describeUserStackAssociations
in interface AmazonAppStream
public DescribeUsersResult describeUsers(DescribeUsersRequest request)
AmazonAppStream
Retrieves a list that describes one or more specified users in the user pool.
describeUsers
in interface AmazonAppStream
public DisableUserResult disableUser(DisableUserRequest request)
AmazonAppStream
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.
disableUser
in interface AmazonAppStream
public DisassociateFleetResult disassociateFleet(DisassociateFleetRequest request)
AmazonAppStream
Disassociates the specified fleet from the specified stack.
disassociateFleet
in interface AmazonAppStream
public EnableUserResult enableUser(EnableUserRequest request)
AmazonAppStream
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.
enableUser
in interface AmazonAppStream
public ExpireSessionResult expireSession(ExpireSessionRequest request)
AmazonAppStream
Immediately stops the specified streaming session.
expireSession
in interface AmazonAppStream
public ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest request)
AmazonAppStream
Retrieves the name of the fleet that is associated with the specified stack.
listAssociatedFleets
in interface AmazonAppStream
public ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest request)
AmazonAppStream
Retrieves the name of the stack with which the specified fleet is associated.
listAssociatedStacks
in interface AmazonAppStream
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonAppStream
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.
listTagsForResource
in interface AmazonAppStream
public StartFleetResult startFleet(StartFleetRequest request)
AmazonAppStream
Starts the specified fleet.
startFleet
in interface AmazonAppStream
public StartImageBuilderResult startImageBuilder(StartImageBuilderRequest request)
AmazonAppStream
Starts the specified image builder.
startImageBuilder
in interface AmazonAppStream
public StopFleetResult stopFleet(StopFleetRequest request)
AmazonAppStream
Stops the specified fleet.
stopFleet
in interface AmazonAppStream
public StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest request)
AmazonAppStream
Stops the specified image builder.
stopImageBuilder
in interface AmazonAppStream
public TagResourceResult tagResource(TagResourceRequest request)
AmazonAppStream
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.
tagResource
in interface AmazonAppStream
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonAppStream
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.
untagResource
in interface AmazonAppStream
public UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest request)
AmazonAppStream
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.
updateDirectoryConfig
in interface AmazonAppStream
public UpdateFleetResult updateFleet(UpdateFleetRequest request)
AmazonAppStream
Updates the specified fleet.
If the fleet is in the STOPPED
state, you can update any attribute except the fleet name. If the
fleet is in the RUNNING
state, you can update the DisplayName
,
ComputeCapacity
, ImageARN
, ImageName
,
IdleDisconnectTimeoutInSeconds
, and DisconnectTimeoutInSeconds
attributes. If the fleet
is in the STARTING
or STOPPING
state, you can't update it.
updateFleet
in interface AmazonAppStream
public UpdateImagePermissionsResult updateImagePermissions(UpdateImagePermissionsRequest request)
AmazonAppStream
Adds or updates permissions for the specified private image.
updateImagePermissions
in interface AmazonAppStream
public UpdateStackResult updateStack(UpdateStackRequest request)
AmazonAppStream
Updates the specified fields for the specified stack.
updateStack
in interface AmazonAppStream
public void shutdown()
AmazonAppStream
shutdown
in interface AmazonAppStream
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonAppStream
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonAppStream
request
- The originally executed request.public AmazonAppStreamWaiters waiters()
waiters
in interface AmazonAppStream