Class: Aws::AppStream::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppStream::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-appstream/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#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.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 429 def initialize(*args) super end |
Instance Method Details
#associate_app_block_builder_app_block(params = {}) ⇒ Types::AssociateAppBlockBuilderAppBlockResult
Associates the specified app block builder with the specified app block.
464 465 466 467 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 464 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.
498 499 500 501 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 498 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.
528 529 530 531 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 528 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.
554 555 556 557 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 554 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.
597 598 599 600 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 597 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.
638 639 640 641 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 638 def batch_disassociate_user_stack(params = {}, = {}) req = build_request(:batch_disassociate_user_stack, params) req.send_request() 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.
684 685 686 687 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 684 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.
793 794 795 796 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 793 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.
937 938 939 940 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 937 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.
972 973 974 975 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 972 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.
1076 1077 1078 1079 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1076 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.
1143 1144 1145 1146 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1143 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.
1206 1207 1208 1209 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1206 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.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1565 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
.
1790 1791 1792 1793 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1790 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.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1825 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.
1978 1979 1980 1981 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1978 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.
2040 2041 2042 2043 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2040 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.
2118 2119 2120 2121 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2118 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.
2246 2247 2248 2249 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2246 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.
2268 2269 2270 2271 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2268 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.
2322 2323 2324 2325 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2322 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_app_block(params = {}) ⇒ Struct
Deletes an app block.
2344 2345 2346 2347 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2344 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.
2369 2370 2371 2372 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2369 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.
2391 2392 2393 2394 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2391 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.
2415 2416 2417 2418 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2415 def delete_directory_config(params = {}, = {}) req = build_request(:delete_directory_config, params) req.send_request() end |
#delete_entitlement(params = {}) ⇒ Struct
Deletes the specified entitlement.
2441 2442 2443 2444 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2441 def delete_entitlement(params = {}, = {}) req = build_request(:delete_entitlement, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes the specified fleet.
2463 2464 2465 2466 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2463 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.
2538 2539 2540 2541 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2538 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.
2595 2596 2597 2598 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2595 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.
2624 2625 2626 2627 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2624 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.
2649 2650 2651 2652 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2649 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.
2672 2673 2674 2675 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2672 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.
2685 2686 2687 2688 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2685 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.
2715 2716 2717 2718 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2715 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.
2763 2764 2765 2766 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2763 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.
2827 2828 2829 2830 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2827 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.
2888 2889 2890 2891 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2888 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.
2934 2935 2936 2937 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2934 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.
2992 2993 2994 2995 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2992 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.
3047 3048 3049 3050 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3047 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.
3099 3100 3101 3102 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3099 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
3182 3183 3184 3185 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3182 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.
3253 3254 3255 3256 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3253 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.
3306 3307 3308 3309 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3306 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.
3403 3404 3405 3406 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3403 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.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3478 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.
3543 3544 3545 3546 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3543 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.
3582 3583 3584 3585 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3582 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.
3624 3625 3626 3627 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3624 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
3686 3687 3688 3689 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3686 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.
3735 3736 3737 3738 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3735 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.
3767 3768 3769 3770 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3767 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.
3794 3795 3796 3797 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3794 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.
3820 3821 3822 3823 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3820 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.
3850 3851 3852 3853 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3850 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.
3876 3877 3878 3879 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3876 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.
3911 3912 3913 3914 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3911 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#expire_session(params = {}) ⇒ Struct
Immediately stops the specified streaming session.
3933 3934 3935 3936 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3933 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.
3970 3971 3972 3973 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3970 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.
4007 4008 4009 4010 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4007 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.
4051 4052 4053 4054 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4051 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.
4088 4089 4090 4091 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4088 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.
4145 4146 4147 4148 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4145 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.
4167 4168 4169 4170 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4167 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.
4230 4231 4232 4233 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4230 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.
4283 4284 4285 4286 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4283 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.
4305 4306 4307 4308 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4305 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.
4362 4363 4364 4365 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4362 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.
4414 4415 4416 4417 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4414 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.
4450 4451 4452 4453 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4450 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.
4582 4583 4584 4585 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4582 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.
4665 4666 4667 4668 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4665 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.
4731 4732 4733 4734 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4731 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.
4788 4789 4790 4791 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4788 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
, andDisconnectTimeoutInSeconds
attributes.Elastic fleet type
You can update the
DisplayName
,IdleDisconnectTimeoutInSeconds
,DisconnectTimeoutInSeconds
,MaxConcurrentSessions
,SessionScriptS3Location
andUsbDeviceFilterStrings
attributes.
If the fleet is in the STARTING
or STOPPED
state, you can't
update it.
5120 5121 5122 5123 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5120 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.
5154 5155 5156 5157 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5154 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.
5291 5292 5293 5294 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5291 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.
5378 5379 5380 5381 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5378 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 |
5489 5490 5491 5492 5493 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5489 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |