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_theme_for_stack(params = {}) ⇒ Types::CreateThemeForStackResult
Creates custom branding that customizes the appearance of the streaming application catalog page.
-
#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_theme_for_stack(params = {}) ⇒ Struct
Deletes custom branding that customizes the appearance of the streaming application catalog page.
-
#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_theme_for_stack(params = {}) ⇒ Types::DescribeThemeForStackResult
Retrieves a list that describes the theme for a specified stack.
-
#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.
-
#update_theme_for_stack(params = {}) ⇒ Types::UpdateThemeForStackResult
Updates custom branding that customizes the appearance of the streaming application catalog page.
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.
453 454 455 |
# File 'lib/aws-sdk-appstream/client.rb', line 453 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.
5553 5554 5555 |
# File 'lib/aws-sdk-appstream/client.rb', line 5553 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.
5556 5557 5558 |
# File 'lib/aws-sdk-appstream/client.rb', line 5556 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.
488 489 490 491 |
# File 'lib/aws-sdk-appstream/client.rb', line 488 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.
522 523 524 525 |
# File 'lib/aws-sdk-appstream/client.rb', line 522 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.
552 553 554 555 |
# File 'lib/aws-sdk-appstream/client.rb', line 552 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.
578 579 580 581 |
# File 'lib/aws-sdk-appstream/client.rb', line 578 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.
621 622 623 624 |
# File 'lib/aws-sdk-appstream/client.rb', line 621 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.
662 663 664 665 |
# File 'lib/aws-sdk-appstream/client.rb', line 662 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.
5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 |
# File 'lib/aws-sdk-appstream/client.rb', line 5411 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::AppStream') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-appstream' context[:gem_version] = '1.99.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.
708 709 710 711 |
# File 'lib/aws-sdk-appstream/client.rb', line 708 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.
817 818 819 820 |
# File 'lib/aws-sdk-appstream/client.rb', line 817 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.
961 962 963 964 |
# File 'lib/aws-sdk-appstream/client.rb', line 961 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.
996 997 998 999 |
# File 'lib/aws-sdk-appstream/client.rb', line 996 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.
1100 1101 1102 1103 |
# File 'lib/aws-sdk-appstream/client.rb', line 1100 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.
1167 1168 1169 1170 |
# File 'lib/aws-sdk-appstream/client.rb', line 1167 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.
1230 1231 1232 1233 |
# File 'lib/aws-sdk-appstream/client.rb', line 1230 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.
1589 1590 1591 1592 |
# File 'lib/aws-sdk-appstream/client.rb', line 1589 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`.
1814 1815 1816 1817 |
# File 'lib/aws-sdk-appstream/client.rb', line 1814 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.
1849 1850 1851 1852 |
# File 'lib/aws-sdk-appstream/client.rb', line 1849 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.
2002 2003 2004 2005 |
# File 'lib/aws-sdk-appstream/client.rb', line 2002 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.
2064 2065 2066 2067 |
# File 'lib/aws-sdk-appstream/client.rb', line 2064 def create_streaming_url(params = {}, = {}) req = build_request(:create_streaming_url, params) req.send_request() end |
#create_theme_for_stack(params = {}) ⇒ Types::CreateThemeForStackResult
Creates custom branding that customizes the appearance of the streaming application catalog page.
2142 2143 2144 2145 |
# File 'lib/aws-sdk-appstream/client.rb', line 2142 def create_theme_for_stack(params = {}, = {}) req = build_request(:create_theme_for_stack, 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
2270 2271 2272 2273 |
# File 'lib/aws-sdk-appstream/client.rb', line 2270 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.
2292 2293 2294 2295 |
# File 'lib/aws-sdk-appstream/client.rb', line 2292 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.
2346 2347 2348 2349 |
# File 'lib/aws-sdk-appstream/client.rb', line 2346 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_app_block(params = {}) ⇒ Struct
Deletes an app block.
2368 2369 2370 2371 |
# File 'lib/aws-sdk-appstream/client.rb', line 2368 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.
2393 2394 2395 2396 |
# File 'lib/aws-sdk-appstream/client.rb', line 2393 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.
2415 2416 2417 2418 |
# File 'lib/aws-sdk-appstream/client.rb', line 2415 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.
2439 2440 2441 2442 |
# File 'lib/aws-sdk-appstream/client.rb', line 2439 def delete_directory_config(params = {}, = {}) req = build_request(:delete_directory_config, params) req.send_request() end |
#delete_entitlement(params = {}) ⇒ Struct
Deletes the specified entitlement.
2465 2466 2467 2468 |
# File 'lib/aws-sdk-appstream/client.rb', line 2465 def delete_entitlement(params = {}, = {}) req = build_request(:delete_entitlement, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes the specified fleet.
2487 2488 2489 2490 |
# File 'lib/aws-sdk-appstream/client.rb', line 2487 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.
2562 2563 2564 2565 |
# File 'lib/aws-sdk-appstream/client.rb', line 2562 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.
2619 2620 2621 2622 |
# File 'lib/aws-sdk-appstream/client.rb', line 2619 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.
2648 2649 2650 2651 |
# File 'lib/aws-sdk-appstream/client.rb', line 2648 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.
2673 2674 2675 2676 |
# File 'lib/aws-sdk-appstream/client.rb', line 2673 def delete_stack(params = {}, = {}) req = build_request(:delete_stack, params) req.send_request() end |
#delete_theme_for_stack(params = {}) ⇒ Struct
Deletes custom branding that customizes the appearance of the streaming application catalog page.
2696 2697 2698 2699 |
# File 'lib/aws-sdk-appstream/client.rb', line 2696 def delete_theme_for_stack(params = {}, = {}) req = build_request(:delete_theme_for_stack, params) req.send_request() end |
#delete_usage_report_subscription(params = {}) ⇒ Struct
Disables usage report generation.
2709 2710 2711 2712 |
# File 'lib/aws-sdk-appstream/client.rb', line 2709 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.
2739 2740 2741 2742 |
# File 'lib/aws-sdk-appstream/client.rb', line 2739 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.
2787 2788 2789 2790 |
# File 'lib/aws-sdk-appstream/client.rb', line 2787 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.
2851 2852 2853 2854 |
# File 'lib/aws-sdk-appstream/client.rb', line 2851 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.
2912 2913 2914 2915 |
# File 'lib/aws-sdk-appstream/client.rb', line 2912 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.
2958 2959 2960 2961 |
# File 'lib/aws-sdk-appstream/client.rb', line 2958 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.
3016 3017 3018 3019 |
# File 'lib/aws-sdk-appstream/client.rb', line 3016 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.
3071 3072 3073 3074 |
# File 'lib/aws-sdk-appstream/client.rb', line 3071 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.
3123 3124 3125 3126 |
# File 'lib/aws-sdk-appstream/client.rb', line 3123 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
3206 3207 3208 3209 |
# File 'lib/aws-sdk-appstream/client.rb', line 3206 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.
3277 3278 3279 3280 |
# File 'lib/aws-sdk-appstream/client.rb', line 3277 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.
3330 3331 3332 3333 |
# File 'lib/aws-sdk-appstream/client.rb', line 3330 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.
3427 3428 3429 3430 |
# File 'lib/aws-sdk-appstream/client.rb', line 3427 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.
3502 3503 3504 3505 |
# File 'lib/aws-sdk-appstream/client.rb', line 3502 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.
3567 3568 3569 3570 |
# File 'lib/aws-sdk-appstream/client.rb', line 3567 def describe_stacks(params = {}, = {}) req = build_request(:describe_stacks, params) req.send_request() end |
#describe_theme_for_stack(params = {}) ⇒ Types::DescribeThemeForStackResult
Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.
3606 3607 3608 3609 |
# File 'lib/aws-sdk-appstream/client.rb', line 3606 def describe_theme_for_stack(params = {}, = {}) req = build_request(:describe_theme_for_stack, params) req.send_request() end |
#describe_usage_report_subscriptions(params = {}) ⇒ Types::DescribeUsageReportSubscriptionsResult
Retrieves a list that describes one or more usage report subscriptions.
3648 3649 3650 3651 |
# File 'lib/aws-sdk-appstream/client.rb', line 3648 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
3710 3711 3712 3713 |
# File 'lib/aws-sdk-appstream/client.rb', line 3710 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.
3759 3760 3761 3762 |
# File 'lib/aws-sdk-appstream/client.rb', line 3759 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.
3791 3792 3793 3794 |
# File 'lib/aws-sdk-appstream/client.rb', line 3791 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.
3818 3819 3820 3821 |
# File 'lib/aws-sdk-appstream/client.rb', line 3818 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.
3844 3845 3846 3847 |
# File 'lib/aws-sdk-appstream/client.rb', line 3844 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.
3874 3875 3876 3877 |
# File 'lib/aws-sdk-appstream/client.rb', line 3874 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.
3900 3901 3902 3903 |
# File 'lib/aws-sdk-appstream/client.rb', line 3900 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.
3935 3936 3937 3938 |
# File 'lib/aws-sdk-appstream/client.rb', line 3935 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#expire_session(params = {}) ⇒ Struct
Immediately stops the specified streaming session.
3957 3958 3959 3960 |
# File 'lib/aws-sdk-appstream/client.rb', line 3957 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.
3994 3995 3996 3997 |
# File 'lib/aws-sdk-appstream/client.rb', line 3994 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.
4031 4032 4033 4034 |
# File 'lib/aws-sdk-appstream/client.rb', line 4031 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.
4075 4076 4077 4078 |
# File 'lib/aws-sdk-appstream/client.rb', line 4075 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
4112 4113 4114 4115 |
# File 'lib/aws-sdk-appstream/client.rb', line 4112 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.
4169 4170 4171 4172 |
# File 'lib/aws-sdk-appstream/client.rb', line 4169 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.
4191 4192 4193 4194 |
# File 'lib/aws-sdk-appstream/client.rb', line 4191 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.
4254 4255 4256 4257 |
# File 'lib/aws-sdk-appstream/client.rb', line 4254 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.
4307 4308 4309 4310 |
# File 'lib/aws-sdk-appstream/client.rb', line 4307 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.
4329 4330 4331 4332 |
# File 'lib/aws-sdk-appstream/client.rb', line 4329 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.
4386 4387 4388 4389 |
# File 'lib/aws-sdk-appstream/client.rb', line 4386 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
4438 4439 4440 4441 |
# File 'lib/aws-sdk-appstream/client.rb', line 4438 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
4474 4475 4476 4477 |
# File 'lib/aws-sdk-appstream/client.rb', line 4474 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.
4606 4607 4608 4609 |
# File 'lib/aws-sdk-appstream/client.rb', line 4606 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.
4689 4690 4691 4692 |
# File 'lib/aws-sdk-appstream/client.rb', line 4689 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.
4755 4756 4757 4758 |
# File 'lib/aws-sdk-appstream/client.rb', line 4755 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.
4812 4813 4814 4815 |
# File 'lib/aws-sdk-appstream/client.rb', line 4812 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.
5144 5145 5146 5147 |
# File 'lib/aws-sdk-appstream/client.rb', line 5144 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.
5178 5179 5180 5181 |
# File 'lib/aws-sdk-appstream/client.rb', line 5178 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.
5315 5316 5317 5318 |
# File 'lib/aws-sdk-appstream/client.rb', line 5315 def update_stack(params = {}, = {}) req = build_request(:update_stack, params) req.send_request() end |
#update_theme_for_stack(params = {}) ⇒ Types::UpdateThemeForStackResult
Updates custom branding that customizes the appearance of the streaming application catalog page.
5402 5403 5404 5405 |
# File 'lib/aws-sdk-appstream/client.rb', line 5402 def update_theme_for_stack(params = {}, = {}) req = build_request(:update_theme_for_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 |
5518 5519 5520 5521 5522 |
# File 'lib/aws-sdk-appstream/client.rb', line 5518 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.
5526 5527 5528 |
# File 'lib/aws-sdk-appstream/client.rb', line 5526 def waiter_names waiters.keys end |