Class: Aws::AppStream::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppStream::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-appstream/client.rb
Overview
An API client for AppStream. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::AppStream::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_app_block_builder_app_block(params = {}) ⇒ Types::AssociateAppBlockBuilderAppBlockResult
Associates the specified app block builder with the specified app block.
-
#associate_application_fleet(params = {}) ⇒ Types::AssociateApplicationFleetResult
Associates the specified application with the specified fleet.
-
#associate_application_to_entitlement(params = {}) ⇒ Struct
Associates an application to entitle.
-
#associate_fleet(params = {}) ⇒ Struct
Associates the specified fleet with the specified stack.
-
#batch_associate_user_stack(params = {}) ⇒ Types::BatchAssociateUserStackResult
Associates the specified users with the specified stacks.
-
#batch_disassociate_user_stack(params = {}) ⇒ Types::BatchDisassociateUserStackResult
Disassociates the specified users from the specified stacks.
-
#copy_image(params = {}) ⇒ Types::CopyImageResponse
Copies the image within the same region or to a new region within the same AWS account.
-
#create_app_block(params = {}) ⇒ Types::CreateAppBlockResult
Creates an app block.
-
#create_app_block_builder(params = {}) ⇒ Types::CreateAppBlockBuilderResult
Creates an app block builder.
-
#create_app_block_builder_streaming_url(params = {}) ⇒ Types::CreateAppBlockBuilderStreamingURLResult
Creates a URL to start a create app block builder streaming session.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResult
Creates an application.
-
#create_directory_config(params = {}) ⇒ Types::CreateDirectoryConfigResult
Creates a Directory Config object in AppStream 2.0.
-
#create_entitlement(params = {}) ⇒ Types::CreateEntitlementResult
Creates a new entitlement.
-
#create_fleet(params = {}) ⇒ Types::CreateFleetResult
Creates a fleet.
-
#create_image_builder(params = {}) ⇒ Types::CreateImageBuilderResult
Creates an image builder.
-
#create_image_builder_streaming_url(params = {}) ⇒ Types::CreateImageBuilderStreamingURLResult
Creates a URL to start an image builder streaming session.
-
#create_stack(params = {}) ⇒ Types::CreateStackResult
Creates a stack to start streaming applications to users.
-
#create_streaming_url(params = {}) ⇒ Types::CreateStreamingURLResult
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
-
#create_updated_image(params = {}) ⇒ Types::CreateUpdatedImageResult
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
-
#create_usage_report_subscription(params = {}) ⇒ Types::CreateUsageReportSubscriptionResult
Creates a usage report subscription.
-
#create_user(params = {}) ⇒ Struct
Creates a new user in the user pool.
-
#delete_app_block(params = {}) ⇒ Struct
Deletes an app block.
-
#delete_app_block_builder(params = {}) ⇒ Struct
Deletes an app block builder.
-
#delete_application(params = {}) ⇒ Struct
Deletes an application.
-
#delete_directory_config(params = {}) ⇒ Struct
Deletes the specified Directory Config object from AppStream 2.0.
-
#delete_entitlement(params = {}) ⇒ Struct
Deletes the specified entitlement.
-
#delete_fleet(params = {}) ⇒ Struct
Deletes the specified fleet.
-
#delete_image(params = {}) ⇒ Types::DeleteImageResult
Deletes the specified image.
-
#delete_image_builder(params = {}) ⇒ Types::DeleteImageBuilderResult
Deletes the specified image builder and releases the capacity.
-
#delete_image_permissions(params = {}) ⇒ Struct
Deletes permissions for the specified private image.
-
#delete_stack(params = {}) ⇒ Struct
Deletes the specified stack.
-
#delete_usage_report_subscription(params = {}) ⇒ Struct
Disables usage report generation.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user from the user pool.
-
#describe_app_block_builder_app_block_associations(params = {}) ⇒ Types::DescribeAppBlockBuilderAppBlockAssociationsResult
Retrieves a list that describes one or more app block builder associations.
-
#describe_app_block_builders(params = {}) ⇒ Types::DescribeAppBlockBuildersResult
Retrieves a list that describes one or more app block builders.
-
#describe_app_blocks(params = {}) ⇒ Types::DescribeAppBlocksResult
Retrieves a list that describes one or more app blocks.
-
#describe_application_fleet_associations(params = {}) ⇒ Types::DescribeApplicationFleetAssociationsResult
Retrieves a list that describes one or more application fleet associations.
-
#describe_applications(params = {}) ⇒ Types::DescribeApplicationsResult
Retrieves a list that describes one or more applications.
-
#describe_directory_configs(params = {}) ⇒ Types::DescribeDirectoryConfigsResult
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.
-
#describe_entitlements(params = {}) ⇒ Types::DescribeEntitlementsResult
Retrieves a list that describes one of more entitlements.
-
#describe_fleets(params = {}) ⇒ Types::DescribeFleetsResult
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
-
#describe_image_builders(params = {}) ⇒ Types::DescribeImageBuildersResult
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
-
#describe_image_permissions(params = {}) ⇒ Types::DescribeImagePermissionsResult
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
-
#describe_images(params = {}) ⇒ Types::DescribeImagesResult
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
-
#describe_sessions(params = {}) ⇒ Types::DescribeSessionsResult
Retrieves a list that describes the streaming sessions for a specified stack and fleet.
-
#describe_stacks(params = {}) ⇒ Types::DescribeStacksResult
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
-
#describe_usage_report_subscriptions(params = {}) ⇒ Types::DescribeUsageReportSubscriptionsResult
Retrieves a list that describes one or more usage report subscriptions.
-
#describe_user_stack_associations(params = {}) ⇒ Types::DescribeUserStackAssociationsResult
Retrieves a list that describes the UserStackAssociation objects.
-
#describe_users(params = {}) ⇒ Types::DescribeUsersResult
Retrieves a list that describes one or more specified users in the user pool.
-
#disable_user(params = {}) ⇒ Struct
Disables the specified user in the user pool.
-
#disassociate_app_block_builder_app_block(params = {}) ⇒ Struct
Disassociates a specified app block builder from a specified app block.
-
#disassociate_application_fleet(params = {}) ⇒ Struct
Disassociates the specified application from the fleet.
-
#disassociate_application_from_entitlement(params = {}) ⇒ Struct
Deletes the specified application from the specified entitlement.
-
#disassociate_fleet(params = {}) ⇒ Struct
Disassociates the specified fleet from the specified stack.
-
#enable_user(params = {}) ⇒ Struct
Enables a user in the user pool.
-
#expire_session(params = {}) ⇒ Struct
Immediately stops the specified streaming session.
-
#list_associated_fleets(params = {}) ⇒ Types::ListAssociatedFleetsResult
Retrieves the name of the fleet that is associated with the specified stack.
-
#list_associated_stacks(params = {}) ⇒ Types::ListAssociatedStacksResult
Retrieves the name of the stack with which the specified fleet is associated.
-
#list_entitled_applications(params = {}) ⇒ Types::ListEntitledApplicationsResult
Retrieves a list of entitled applications.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of all tags for the specified AppStream 2.0 resource.
-
#start_app_block_builder(params = {}) ⇒ Types::StartAppBlockBuilderResult
Starts an app block builder.
-
#start_fleet(params = {}) ⇒ Struct
Starts the specified fleet.
-
#start_image_builder(params = {}) ⇒ Types::StartImageBuilderResult
Starts the specified image builder.
-
#stop_app_block_builder(params = {}) ⇒ Types::StopAppBlockBuilderResult
Stops an app block builder.
-
#stop_fleet(params = {}) ⇒ Struct
Stops the specified fleet.
-
#stop_image_builder(params = {}) ⇒ Types::StopImageBuilderResult
Stops the specified image builder.
-
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
-
#untag_resource(params = {}) ⇒ Struct
Disassociates one or more specified tags from the specified AppStream 2.0 resource.
-
#update_app_block_builder(params = {}) ⇒ Types::UpdateAppBlockBuilderResult
Updates an app block builder.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationResult
Updates the specified application.
-
#update_directory_config(params = {}) ⇒ Types::UpdateDirectoryConfigResult
Updates the specified Directory Config object in AppStream 2.0.
-
#update_entitlement(params = {}) ⇒ Types::UpdateEntitlementResult
Updates the specified entitlement.
-
#update_fleet(params = {}) ⇒ Types::UpdateFleetResult
Updates the specified fleet.
-
#update_image_permissions(params = {}) ⇒ Struct
Adds or updates permissions for the specified private image.
-
#update_stack(params = {}) ⇒ Types::UpdateStackResult
Updates the specified fields for the specified stack.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-appstream/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5229 5230 5231 |
# File 'lib/aws-sdk-appstream/client.rb', line 5229 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5232 5233 5234 |
# File 'lib/aws-sdk-appstream/client.rb', line 5232 def errors_module Errors end |
Instance Method Details
#associate_app_block_builder_app_block(params = {}) ⇒ Types::AssociateAppBlockBuilderAppBlockResult
Associates the specified app block builder with the specified app block.
430 431 432 433 |
# File 'lib/aws-sdk-appstream/client.rb', line 430 def associate_app_block_builder_app_block(params = {}, = {}) req = build_request(:associate_app_block_builder_app_block, params) req.send_request() end |
#associate_application_fleet(params = {}) ⇒ Types::AssociateApplicationFleetResult
Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
464 465 466 467 |
# File 'lib/aws-sdk-appstream/client.rb', line 464 def associate_application_fleet(params = {}, = {}) req = build_request(:associate_application_fleet, params) req.send_request() end |
#associate_application_to_entitlement(params = {}) ⇒ Struct
Associates an application to entitle.
494 495 496 497 |
# File 'lib/aws-sdk-appstream/client.rb', line 494 def associate_application_to_entitlement(params = {}, = {}) req = build_request(:associate_application_to_entitlement, params) req.send_request() end |
#associate_fleet(params = {}) ⇒ Struct
Associates the specified fleet with the specified stack.
520 521 522 523 |
# File 'lib/aws-sdk-appstream/client.rb', line 520 def associate_fleet(params = {}, = {}) req = build_request(:associate_fleet, params) req.send_request() end |
#batch_associate_user_stack(params = {}) ⇒ Types::BatchAssociateUserStackResult
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.
563 564 565 566 |
# File 'lib/aws-sdk-appstream/client.rb', line 563 def batch_associate_user_stack(params = {}, = {}) req = build_request(:batch_associate_user_stack, params) req.send_request() end |
#batch_disassociate_user_stack(params = {}) ⇒ Types::BatchDisassociateUserStackResult
Disassociates the specified users from the specified stacks.
604 605 606 607 |
# File 'lib/aws-sdk-appstream/client.rb', line 604 def batch_disassociate_user_stack(params = {}, = {}) req = build_request(:batch_disassociate_user_stack, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 |
# File 'lib/aws-sdk-appstream/client.rb', line 5092 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-appstream' context[:gem_version] = '1.85.0' Seahorse::Client::Request.new(handlers, context) end |
#copy_image(params = {}) ⇒ Types::CopyImageResponse
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.
650 651 652 653 |
# File 'lib/aws-sdk-appstream/client.rb', line 650 def copy_image(params = {}, = {}) req = build_request(:copy_image, params) req.send_request() end |
#create_app_block(params = {}) ⇒ Types::CreateAppBlockResult
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.
759 760 761 762 |
# File 'lib/aws-sdk-appstream/client.rb', line 759 def create_app_block(params = {}, = {}) req = build_request(:create_app_block, params) req.send_request() end |
#create_app_block_builder(params = {}) ⇒ Types::CreateAppBlockBuilderResult
Creates an app block builder.
903 904 905 906 |
# File 'lib/aws-sdk-appstream/client.rb', line 903 def create_app_block_builder(params = {}, = {}) req = build_request(:create_app_block_builder, params) req.send_request() end |
#create_app_block_builder_streaming_url(params = {}) ⇒ Types::CreateAppBlockBuilderStreamingURLResult
Creates a URL to start a create app block builder streaming session.
938 939 940 941 |
# File 'lib/aws-sdk-appstream/client.rb', line 938 def create_app_block_builder_streaming_url(params = {}, = {}) req = build_request(:create_app_block_builder_streaming_url, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResult
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.
1042 1043 1044 1045 |
# File 'lib/aws-sdk-appstream/client.rb', line 1042 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_directory_config(params = {}) ⇒ Types::CreateDirectoryConfigResult
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.
1109 1110 1111 1112 |
# File 'lib/aws-sdk-appstream/client.rb', line 1109 def create_directory_config(params = {}, = {}) req = build_request(:create_directory_config, params) req.send_request() end |
#create_entitlement(params = {}) ⇒ Types::CreateEntitlementResult
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.
1172 1173 1174 1175 |
# File 'lib/aws-sdk-appstream/client.rb', line 1172 def create_entitlement(params = {}, = {}) req = build_request(:create_entitlement, params) req.send_request() end |
#create_fleet(params = {}) ⇒ Types::CreateFleetResult
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
1517 1518 1519 1520 |
# File 'lib/aws-sdk-appstream/client.rb', line 1517 def create_fleet(params = {}, = {}) req = build_request(:create_fleet, params) req.send_request() end |
#create_image_builder(params = {}) ⇒ Types::CreateImageBuilderResult
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`.
1741 1742 1743 1744 |
# File 'lib/aws-sdk-appstream/client.rb', line 1741 def create_image_builder(params = {}, = {}) req = build_request(:create_image_builder, params) req.send_request() end |
#create_image_builder_streaming_url(params = {}) ⇒ Types::CreateImageBuilderStreamingURLResult
Creates a URL to start an image builder streaming session.
1776 1777 1778 1779 |
# File 'lib/aws-sdk-appstream/client.rb', line 1776 def create_image_builder_streaming_url(params = {}, = {}) req = build_request(:create_image_builder_streaming_url, params) req.send_request() end |
#create_stack(params = {}) ⇒ Types::CreateStackResult
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
1929 1930 1931 1932 |
# File 'lib/aws-sdk-appstream/client.rb', line 1929 def create_stack(params = {}, = {}) req = build_request(:create_stack, params) req.send_request() end |
#create_streaming_url(params = {}) ⇒ Types::CreateStreamingURLResult
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.
1991 1992 1993 1994 |
# File 'lib/aws-sdk-appstream/client.rb', line 1991 def create_streaming_url(params = {}, = {}) req = build_request(:create_streaming_url, params) req.send_request() end |
#create_updated_image(params = {}) ⇒ Types::CreateUpdatedImageResult
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*.
[1]: docs.aws.amazon.com/appstream2/latest/developerguide/administer-images.html
2114 2115 2116 2117 |
# File 'lib/aws-sdk-appstream/client.rb', line 2114 def create_updated_image(params = {}, = {}) req = build_request(:create_updated_image, params) req.send_request() end |
#create_usage_report_subscription(params = {}) ⇒ Types::CreateUsageReportSubscriptionResult
Creates a usage report subscription. Usage reports are generated daily.
2136 2137 2138 2139 |
# File 'lib/aws-sdk-appstream/client.rb', line 2136 def create_usage_report_subscription(params = {}, = {}) req = build_request(:create_usage_report_subscription, params) req.send_request() end |
#create_user(params = {}) ⇒ Struct
Creates a new user in the user pool.
2190 2191 2192 2193 |
# File 'lib/aws-sdk-appstream/client.rb', line 2190 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_app_block(params = {}) ⇒ Struct
Deletes an app block.
2212 2213 2214 2215 |
# File 'lib/aws-sdk-appstream/client.rb', line 2212 def delete_app_block(params = {}, = {}) req = build_request(:delete_app_block, params) req.send_request() end |
#delete_app_block_builder(params = {}) ⇒ Struct
Deletes an app block builder.
An app block builder can only be deleted when it has no association with an app block.
2237 2238 2239 2240 |
# File 'lib/aws-sdk-appstream/client.rb', line 2237 def delete_app_block_builder(params = {}, = {}) req = build_request(:delete_app_block_builder, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes an application.
2259 2260 2261 2262 |
# File 'lib/aws-sdk-appstream/client.rb', line 2259 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_directory_config(params = {}) ⇒ Struct
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.
2283 2284 2285 2286 |
# File 'lib/aws-sdk-appstream/client.rb', line 2283 def delete_directory_config(params = {}, = {}) req = build_request(:delete_directory_config, params) req.send_request() end |
#delete_entitlement(params = {}) ⇒ Struct
Deletes the specified entitlement.
2309 2310 2311 2312 |
# File 'lib/aws-sdk-appstream/client.rb', line 2309 def delete_entitlement(params = {}, = {}) req = build_request(:delete_entitlement, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes the specified fleet.
2331 2332 2333 2334 |
# File 'lib/aws-sdk-appstream/client.rb', line 2331 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#delete_image(params = {}) ⇒ Types::DeleteImageResult
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.
2401 2402 2403 2404 |
# File 'lib/aws-sdk-appstream/client.rb', line 2401 def delete_image(params = {}, = {}) req = build_request(:delete_image, params) req.send_request() end |
#delete_image_builder(params = {}) ⇒ Types::DeleteImageBuilderResult
Deletes the specified image builder and releases the capacity.
2457 2458 2459 2460 |
# File 'lib/aws-sdk-appstream/client.rb', line 2457 def delete_image_builder(params = {}, = {}) req = build_request(:delete_image_builder, params) req.send_request() end |
#delete_image_permissions(params = {}) ⇒ Struct
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.
2486 2487 2488 2489 |
# File 'lib/aws-sdk-appstream/client.rb', line 2486 def (params = {}, = {}) req = build_request(:delete_image_permissions, params) req.send_request() end |
#delete_stack(params = {}) ⇒ Struct
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.
2511 2512 2513 2514 |
# File 'lib/aws-sdk-appstream/client.rb', line 2511 def delete_stack(params = {}, = {}) req = build_request(:delete_stack, params) req.send_request() end |
#delete_usage_report_subscription(params = {}) ⇒ Struct
Disables usage report generation.
2524 2525 2526 2527 |
# File 'lib/aws-sdk-appstream/client.rb', line 2524 def delete_usage_report_subscription(params = {}, = {}) req = build_request(:delete_usage_report_subscription, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user from the user pool.
2554 2555 2556 2557 |
# File 'lib/aws-sdk-appstream/client.rb', line 2554 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_app_block_builder_app_block_associations(params = {}) ⇒ Types::DescribeAppBlockBuilderAppBlockAssociationsResult
Retrieves a list that describes one or more app block builder associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2602 2603 2604 2605 |
# File 'lib/aws-sdk-appstream/client.rb', line 2602 def describe_app_block_builder_app_block_associations(params = {}, = {}) req = build_request(:describe_app_block_builder_app_block_associations, params) req.send_request() end |
#describe_app_block_builders(params = {}) ⇒ Types::DescribeAppBlockBuildersResult
Retrieves a list that describes one or more app block builders.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2666 2667 2668 2669 |
# File 'lib/aws-sdk-appstream/client.rb', line 2666 def describe_app_block_builders(params = {}, = {}) req = build_request(:describe_app_block_builders, params) req.send_request() end |
#describe_app_blocks(params = {}) ⇒ Types::DescribeAppBlocksResult
Retrieves a list that describes one or more app blocks.
2727 2728 2729 2730 |
# File 'lib/aws-sdk-appstream/client.rb', line 2727 def describe_app_blocks(params = {}, = {}) req = build_request(:describe_app_blocks, params) req.send_request() end |
#describe_application_fleet_associations(params = {}) ⇒ Types::DescribeApplicationFleetAssociationsResult
Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
2773 2774 2775 2776 |
# File 'lib/aws-sdk-appstream/client.rb', line 2773 def describe_application_fleet_associations(params = {}, = {}) req = build_request(:describe_application_fleet_associations, params) req.send_request() end |
#describe_applications(params = {}) ⇒ Types::DescribeApplicationsResult
Retrieves a list that describes one or more applications.
2831 2832 2833 2834 |
# File 'lib/aws-sdk-appstream/client.rb', line 2831 def describe_applications(params = {}, = {}) req = build_request(:describe_applications, params) req.send_request() end |
#describe_directory_configs(params = {}) ⇒ Types::DescribeDirectoryConfigsResult
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.
2886 2887 2888 2889 |
# File 'lib/aws-sdk-appstream/client.rb', line 2886 def describe_directory_configs(params = {}, = {}) req = build_request(:describe_directory_configs, params) req.send_request() end |
#describe_entitlements(params = {}) ⇒ Types::DescribeEntitlementsResult
Retrieves a list that describes one of more entitlements.
2938 2939 2940 2941 |
# File 'lib/aws-sdk-appstream/client.rb', line 2938 def describe_entitlements(params = {}, = {}) req = build_request(:describe_entitlements, params) req.send_request() end |
#describe_fleets(params = {}) ⇒ Types::DescribeFleetsResult
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
The following waiters are defined for this operation (see #wait_until for detailed usage):
* fleet_started
* fleet_stopped
3021 3022 3023 3024 |
# File 'lib/aws-sdk-appstream/client.rb', line 3021 def describe_fleets(params = {}, = {}) req = build_request(:describe_fleets, params) req.send_request() end |
#describe_image_builders(params = {}) ⇒ Types::DescribeImageBuildersResult
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.
3091 3092 3093 3094 |
# File 'lib/aws-sdk-appstream/client.rb', line 3091 def describe_image_builders(params = {}, = {}) req = build_request(:describe_image_builders, params) req.send_request() end |
#describe_image_permissions(params = {}) ⇒ Types::DescribeImagePermissionsResult
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3144 3145 3146 3147 |
# File 'lib/aws-sdk-appstream/client.rb', line 3144 def (params = {}, = {}) req = build_request(:describe_image_permissions, params) req.send_request() end |
#describe_images(params = {}) ⇒ Types::DescribeImagesResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3236 3237 3238 3239 |
# File 'lib/aws-sdk-appstream/client.rb', line 3236 def describe_images(params = {}, = {}) req = build_request(:describe_images, params) req.send_request() end |
#describe_sessions(params = {}) ⇒ Types::DescribeSessionsResult
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.
3311 3312 3313 3314 |
# File 'lib/aws-sdk-appstream/client.rb', line 3311 def describe_sessions(params = {}, = {}) req = build_request(:describe_sessions, params) req.send_request() end |
#describe_stacks(params = {}) ⇒ Types::DescribeStacksResult
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
3376 3377 3378 3379 |
# File 'lib/aws-sdk-appstream/client.rb', line 3376 def describe_stacks(params = {}, = {}) req = build_request(:describe_stacks, params) req.send_request() end |
#describe_usage_report_subscriptions(params = {}) ⇒ Types::DescribeUsageReportSubscriptionsResult
Retrieves a list that describes one or more usage report subscriptions.
3418 3419 3420 3421 |
# File 'lib/aws-sdk-appstream/client.rb', line 3418 def describe_usage_report_subscriptions(params = {}, = {}) req = build_request(:describe_usage_report_subscriptions, params) req.send_request() end |
#describe_user_stack_associations(params = {}) ⇒ Types::DescribeUserStackAssociationsResult
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
3480 3481 3482 3483 |
# File 'lib/aws-sdk-appstream/client.rb', line 3480 def describe_user_stack_associations(params = {}, = {}) req = build_request(:describe_user_stack_associations, params) req.send_request() end |
#describe_users(params = {}) ⇒ Types::DescribeUsersResult
Retrieves a list that describes one or more specified users in the user pool.
3529 3530 3531 3532 |
# File 'lib/aws-sdk-appstream/client.rb', line 3529 def describe_users(params = {}, = {}) req = build_request(:describe_users, params) req.send_request() end |
#disable_user(params = {}) ⇒ Struct
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.
3561 3562 3563 3564 |
# File 'lib/aws-sdk-appstream/client.rb', line 3561 def disable_user(params = {}, = {}) req = build_request(:disable_user, params) req.send_request() end |
#disassociate_app_block_builder_app_block(params = {}) ⇒ Struct
Disassociates a specified app block builder from a specified app block.
3588 3589 3590 3591 |
# File 'lib/aws-sdk-appstream/client.rb', line 3588 def disassociate_app_block_builder_app_block(params = {}, = {}) req = build_request(:disassociate_app_block_builder_app_block, params) req.send_request() end |
#disassociate_application_fleet(params = {}) ⇒ Struct
Disassociates the specified application from the fleet.
3614 3615 3616 3617 |
# File 'lib/aws-sdk-appstream/client.rb', line 3614 def disassociate_application_fleet(params = {}, = {}) req = build_request(:disassociate_application_fleet, params) req.send_request() end |
#disassociate_application_from_entitlement(params = {}) ⇒ Struct
Deletes the specified application from the specified entitlement.
3644 3645 3646 3647 |
# File 'lib/aws-sdk-appstream/client.rb', line 3644 def disassociate_application_from_entitlement(params = {}, = {}) req = build_request(:disassociate_application_from_entitlement, params) req.send_request() end |
#disassociate_fleet(params = {}) ⇒ Struct
Disassociates the specified fleet from the specified stack.
3670 3671 3672 3673 |
# File 'lib/aws-sdk-appstream/client.rb', line 3670 def disassociate_fleet(params = {}, = {}) req = build_request(:disassociate_fleet, params) req.send_request() end |
#enable_user(params = {}) ⇒ Struct
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.
3705 3706 3707 3708 |
# File 'lib/aws-sdk-appstream/client.rb', line 3705 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#expire_session(params = {}) ⇒ Struct
Immediately stops the specified streaming session.
3727 3728 3729 3730 |
# File 'lib/aws-sdk-appstream/client.rb', line 3727 def expire_session(params = {}, = {}) req = build_request(:expire_session, params) req.send_request() end |
#list_associated_fleets(params = {}) ⇒ Types::ListAssociatedFleetsResult
Retrieves the name of the fleet that is associated with the specified stack.
3764 3765 3766 3767 |
# File 'lib/aws-sdk-appstream/client.rb', line 3764 def list_associated_fleets(params = {}, = {}) req = build_request(:list_associated_fleets, params) req.send_request() end |
#list_associated_stacks(params = {}) ⇒ Types::ListAssociatedStacksResult
Retrieves the name of the stack with which the specified fleet is associated.
3801 3802 3803 3804 |
# File 'lib/aws-sdk-appstream/client.rb', line 3801 def list_associated_stacks(params = {}, = {}) req = build_request(:list_associated_stacks, params) req.send_request() end |
#list_entitled_applications(params = {}) ⇒ Types::ListEntitledApplicationsResult
Retrieves a list of entitled applications.
3845 3846 3847 3848 |
# File 'lib/aws-sdk-appstream/client.rb', line 3845 def list_entitled_applications(params = {}, = {}) req = build_request(:list_entitled_applications, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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*.
[1]: docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html
3882 3883 3884 3885 |
# File 'lib/aws-sdk-appstream/client.rb', line 3882 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_app_block_builder(params = {}) ⇒ Types::StartAppBlockBuilderResult
Starts an app block builder.
An app block builder can only be started when it’s associated with an app block.
Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
3939 3940 3941 3942 |
# File 'lib/aws-sdk-appstream/client.rb', line 3939 def start_app_block_builder(params = {}, = {}) req = build_request(:start_app_block_builder, params) req.send_request() end |
#start_fleet(params = {}) ⇒ Struct
Starts the specified fleet.
3961 3962 3963 3964 |
# File 'lib/aws-sdk-appstream/client.rb', line 3961 def start_fleet(params = {}, = {}) req = build_request(:start_fleet, params) req.send_request() end |
#start_image_builder(params = {}) ⇒ Types::StartImageBuilderResult
Starts the specified image builder.
4023 4024 4025 4026 |
# File 'lib/aws-sdk-appstream/client.rb', line 4023 def start_image_builder(params = {}, = {}) req = build_request(:start_image_builder, params) req.send_request() end |
#stop_app_block_builder(params = {}) ⇒ Types::StopAppBlockBuilderResult
Stops an app block builder.
Stopping an app block builder terminates the instance, and the instance state is not persisted.
4076 4077 4078 4079 |
# File 'lib/aws-sdk-appstream/client.rb', line 4076 def stop_app_block_builder(params = {}, = {}) req = build_request(:stop_app_block_builder, params) req.send_request() end |
#stop_fleet(params = {}) ⇒ Struct
Stops the specified fleet.
4098 4099 4100 4101 |
# File 'lib/aws-sdk-appstream/client.rb', line 4098 def stop_fleet(params = {}, = {}) req = build_request(:stop_fleet, params) req.send_request() end |
#stop_image_builder(params = {}) ⇒ Types::StopImageBuilderResult
Stops the specified image builder.
4154 4155 4156 4157 |
# File 'lib/aws-sdk-appstream/client.rb', line 4154 def stop_image_builder(params = {}, = {}) req = build_request(:stop_image_builder, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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*.
[1]: docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html
4206 4207 4208 4209 |
# File 'lib/aws-sdk-appstream/client.rb', line 4206 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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*.
[1]: docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html
4242 4243 4244 4245 |
# File 'lib/aws-sdk-appstream/client.rb', line 4242 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app_block_builder(params = {}) ⇒ Types::UpdateAppBlockBuilderResult
Updates an app block builder.
If the app block builder is in the ‘STARTING` or `STOPPING` state, you can’t update it. If the app block builder is in the ‘RUNNING` state, you can only update the DisplayName and Description. If the app block builder is in the `STOPPED` state, you can update any attribute except the Name.
4374 4375 4376 4377 |
# File 'lib/aws-sdk-appstream/client.rb', line 4374 def update_app_block_builder(params = {}, = {}) req = build_request(:update_app_block_builder, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResult
Updates the specified application.
4457 4458 4459 4460 |
# File 'lib/aws-sdk-appstream/client.rb', line 4457 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_directory_config(params = {}) ⇒ Types::UpdateDirectoryConfigResult
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.
4523 4524 4525 4526 |
# File 'lib/aws-sdk-appstream/client.rb', line 4523 def update_directory_config(params = {}, = {}) req = build_request(:update_directory_config, params) req.send_request() end |
#update_entitlement(params = {}) ⇒ Types::UpdateEntitlementResult
Updates the specified entitlement.
4580 4581 4582 4583 |
# File 'lib/aws-sdk-appstream/client.rb', line 4580 def update_entitlement(params = {}, = {}) req = build_request(:update_entitlement, params) req.send_request() end |
#update_fleet(params = {}) ⇒ Types::UpdateFleetResult
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.
4912 4913 4914 4915 |
# File 'lib/aws-sdk-appstream/client.rb', line 4912 def update_fleet(params = {}, = {}) req = build_request(:update_fleet, params) req.send_request() end |
#update_image_permissions(params = {}) ⇒ Struct
Adds or updates permissions for the specified private image.
4946 4947 4948 4949 |
# File 'lib/aws-sdk-appstream/client.rb', line 4946 def (params = {}, = {}) req = build_request(:update_image_permissions, params) req.send_request() end |
#update_stack(params = {}) ⇒ Types::UpdateStackResult
Updates the specified fields for the specified stack.
5083 5084 5085 5086 |
# File 'lib/aws-sdk-appstream/client.rb', line 5083 def update_stack(params = {}, = {}) req = build_request(:update_stack, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ————- | ———————— | ——– | ————- | | fleet_started | #describe_fleets | 30 | 40 | | fleet_stopped | #describe_fleets | 30 | 40 |
5194 5195 5196 5197 5198 |
# File 'lib/aws-sdk-appstream/client.rb', line 5194 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5202 5203 5204 |
# File 'lib/aws-sdk-appstream/client.rb', line 5202 def waiter_names waiters.keys end |