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.
-
#associate_software_to_image_builder(params = {}) ⇒ Struct
Associates license included application(s) with an existing image builder instance.
-
#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 WorkSpaces Applications.
-
#create_entitlement(params = {}) ⇒ Types::CreateEntitlementResult
Creates a new entitlement.
-
#create_export_image_task(params = {}) ⇒ Types::CreateExportImageTaskResult
Creates a task to export a WorkSpaces Applications image to an EC2 AMI.
-
#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_imported_image(params = {}) ⇒ Types::CreateImportedImageResult
Creates a custom WorkSpaces Applications image by importing an EC2 AMI.
-
#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 WorkSpaces Applications 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 WorkSpaces Applications 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 WorkSpaces Applications.
-
#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_app_license_usage(params = {}) ⇒ Types::DescribeAppLicenseUsageResult
Retrieves license included application usage information.
-
#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 WorkSpaces Applications, 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_software_associations(params = {}) ⇒ Types::DescribeSoftwareAssociationsResult
Retrieves license included application associations for a specified resource.
-
#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.
-
#disassociate_software_from_image_builder(params = {}) ⇒ Struct
Removes license included application(s) association(s) from an image builder instance.
-
#drain_session_instance(params = {}) ⇒ Struct
Drains the instance hosting the specified streaming session.
-
#enable_user(params = {}) ⇒ Struct
Enables a user in the user pool.
-
#expire_session(params = {}) ⇒ Struct
Immediately stops the specified streaming session.
-
#get_export_image_task(params = {}) ⇒ Types::GetExportImageTaskResult
Retrieves information about an export image task, including its current state, progress, and any error details.
-
#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_export_image_tasks(params = {}) ⇒ Types::ListExportImageTasksResult
Lists export image tasks, with optional filtering and pagination.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of all tags for the specified WorkSpaces Applications 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.
-
#start_software_deployment_to_image_builder(params = {}) ⇒ Struct
Initiates license included applications deployment to an image builder instance.
-
#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 WorkSpaces Applications resource.
-
#untag_resource(params = {}) ⇒ Struct
Disassociates one or more specified tags from the specified WorkSpaces Applications 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 WorkSpaces Applications.
-
#update_entitlement(params = {}) ⇒ Types::UpdateEntitlementResult
Updates the specified entitlement.
-
#update_fleet(params = {}) ⇒ Types::UpdateFleetResult
Updates the specified fleet.
-
#update_image_builder(params = {}) ⇒ Types::UpdateImageBuilderResult
Updates the specified fields for the specified image builder.
-
#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.
486 487 488 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 486 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.
521 522 523 524 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 521 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.
555 556 557 558 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 555 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.
585 586 587 588 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 585 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.
611 612 613 614 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 611 def associate_fleet(params = {}, = {}) req = build_request(:associate_fleet, params) req.send_request() end |
#associate_software_to_image_builder(params = {}) ⇒ Struct
Associates license included application(s) with an existing image builder instance.
689 690 691 692 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 689 def associate_software_to_image_builder(params = {}, = {}) req = build_request(:associate_software_to_image_builder, 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.
732 733 734 735 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 732 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.
773 774 775 776 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 773 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.
819 820 821 822 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 819 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 a WorkSpaces Applications 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.
928 929 930 931 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 928 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1079 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.
1114 1115 1116 1117 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1114 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 a WorkSpaces Applications 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.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1218 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 WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
1285 1286 1287 1288 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1285 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. WorkSpaces Applications 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.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1348 def create_entitlement(params = {}, = {}) req = build_request(:create_entitlement, params) req.send_request() end |
#create_export_image_task(params = {}) ⇒ Types::CreateExportImageTaskResult
Creates a task to export a WorkSpaces Applications image to an EC2 AMI. This allows you to use your customized WorkSpaces Applications images with other AWS services or for backup purposes.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1414 def create_export_image_task(params = {}, = {}) req = build_request(:create_export_image_task, 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.
1823 1824 1825 1826 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1823 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.
2245 2246 2247 2248 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2245 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.
2280 2281 2282 2283 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2280 def create_image_builder_streaming_url(params = {}, = {}) req = build_request(:create_image_builder_streaming_url, params) req.send_request() end |
#create_imported_image(params = {}) ⇒ Types::CreateImportedImageResult
Creates a custom WorkSpaces Applications image by importing an EC2 AMI. This allows you to use your own customized AMI to create WorkSpaces Applications images that support additional instance types beyond the standard stream.* instances.
2432 2433 2434 2435 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2432 def create_imported_image(params = {}, = {}) req = build_request(:create_imported_image, 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.
2644 2645 2646 2647 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2644 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 WorkSpaces Applications streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
2706 2707 2708 2709 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2706 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.
2784 2785 2786 2787 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2784 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 WorkSpaces Applications agent software.
For more information, see the "Update an Image by Using Managed WorkSpaces Applications Image Updates" section in Administer Your WorkSpaces Applications Images, in the Amazon WorkSpaces Applications Administration Guide.
2917 2918 2919 2920 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2917 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.
2939 2940 2941 2942 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2939 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.
2993 2994 2995 2996 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2993 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_app_block(params = {}) ⇒ Struct
Deletes an app block.
3015 3016 3017 3018 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3015 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.
3040 3041 3042 3043 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3040 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.
3062 3063 3064 3065 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3062 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 WorkSpaces Applications. This object includes the information required to join streaming instances to an Active Directory domain.
3086 3087 3088 3089 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3086 def delete_directory_config(params = {}, = {}) req = build_request(:delete_directory_config, params) req.send_request() end |
#delete_entitlement(params = {}) ⇒ Struct
Deletes the specified entitlement.
3112 3113 3114 3115 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3112 def delete_entitlement(params = {}, = {}) req = build_request(:delete_entitlement, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes the specified fleet.
3134 3135 3136 3137 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3134 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.
3212 3213 3214 3215 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3212 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.
3281 3282 3283 3284 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3281 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.
3310 3311 3312 3313 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3310 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.
3335 3336 3337 3338 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3335 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.
3358 3359 3360 3361 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3358 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.
3371 3372 3373 3374 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3371 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.
3401 3402 3403 3404 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3401 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.
3449 3450 3451 3452 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3449 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.
3514 3515 3516 3517 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3514 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.
3575 3576 3577 3578 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3575 def describe_app_blocks(params = {}, = {}) req = build_request(:describe_app_blocks, params) req.send_request() end |
#describe_app_license_usage(params = {}) ⇒ Types::DescribeAppLicenseUsageResult
Retrieves license included application usage information.
3623 3624 3625 3626 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3623 def describe_app_license_usage(params = {}, = {}) req = build_request(:describe_app_license_usage, 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.
3669 3670 3671 3672 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3669 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.
3727 3728 3729 3730 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3727 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 WorkSpaces Applications, 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.
3782 3783 3784 3785 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3782 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.
3834 3835 3836 3837 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3834 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
3922 3923 3924 3925 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3922 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.
The description of each image builder includes its agent access configuration, if agent access is enabled.
4008 4009 4010 4011 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4008 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.
4061 4062 4063 4064 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4061 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.
4161 4162 4163 4164 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4161 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.
4239 4240 4241 4242 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4239 def describe_sessions(params = {}, = {}) req = build_request(:describe_sessions, params) req.send_request() end |
#describe_software_associations(params = {}) ⇒ Types::DescribeSoftwareAssociationsResult
Retrieves license included application associations for a specified resource.
4287 4288 4289 4290 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4287 def describe_software_associations(params = {}, = {}) req = build_request(:describe_software_associations, 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.
4370 4371 4372 4373 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4370 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.
4409 4410 4411 4412 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4409 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.
4451 4452 4453 4454 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4451 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
4513 4514 4515 4516 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4513 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.
4562 4563 4564 4565 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4562 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 WorkSpaces Applications until they are re-enabled. This action does not delete the user.
4594 4595 4596 4597 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4594 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.
4621 4622 4623 4624 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4621 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.
4647 4648 4649 4650 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4647 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.
4677 4678 4679 4680 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4677 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.
4703 4704 4705 4706 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4703 def disassociate_fleet(params = {}, = {}) req = build_request(:disassociate_fleet, params) req.send_request() end |
#disassociate_software_from_image_builder(params = {}) ⇒ Struct
Removes license included application(s) association(s) from an image builder instance.
4781 4782 4783 4784 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4781 def disassociate_software_from_image_builder(params = {}, = {}) req = build_request(:disassociate_software_from_image_builder, params) req.send_request() end |
#drain_session_instance(params = {}) ⇒ Struct
Drains the instance hosting the specified streaming session. The instance stops accepting new sessions while existing sessions continue uninterrupted. Once all sessions end, the instance is reclaimed and replaced. This only applies to multi-session fleets.
4806 4807 4808 4809 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4806 def drain_session_instance(params = {}, = {}) req = build_request(:drain_session_instance, params) req.send_request() end |
#enable_user(params = {}) ⇒ Struct
Enables a user in the user pool. After being enabled, users can sign in to WorkSpaces Applications and open applications from the stacks to which they are assigned.
4841 4842 4843 4844 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4841 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#expire_session(params = {}) ⇒ Struct
Immediately stops the specified streaming session.
4863 4864 4865 4866 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4863 def expire_session(params = {}, = {}) req = build_request(:expire_session, params) req.send_request() end |
#get_export_image_task(params = {}) ⇒ Types::GetExportImageTaskResult
Retrieves information about an export image task, including its current state, progress, and any error details.
4904 4905 4906 4907 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4904 def get_export_image_task(params = {}, = {}) req = build_request(:get_export_image_task, params) req.send_request() end |
#list_associated_fleets(params = {}) ⇒ Types::ListAssociatedFleetsResult
Retrieves the name of the fleet that is associated with the specified stack.
4941 4942 4943 4944 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4941 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.
4978 4979 4980 4981 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4978 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.
5022 5023 5024 5025 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5022 def list_entitled_applications(params = {}, = {}) req = build_request(:list_entitled_applications, params) req.send_request() end |
#list_export_image_tasks(params = {}) ⇒ Types::ListExportImageTasksResult
Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.
5082 5083 5084 5085 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5082 def list_export_image_tasks(params = {}, = {}) req = build_request(:list_export_image_tasks, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of all tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets, and stacks.
For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.
5120 5121 5122 5123 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5120 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.
5178 5179 5180 5181 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5178 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.
5200 5201 5202 5203 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5200 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.
5275 5276 5277 5278 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5275 def start_image_builder(params = {}, = {}) req = build_request(:start_image_builder, params) req.send_request() end |
#start_software_deployment_to_image_builder(params = {}) ⇒ Struct
Initiates license included applications deployment to an image builder instance.
5303 5304 5305 5306 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5303 def start_software_deployment_to_image_builder(params = {}, = {}) req = build_request(:start_software_deployment_to_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.
5357 5358 5359 5360 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5357 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.
5379 5380 5381 5382 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5379 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.
5448 5449 5450 5451 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5448 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 WorkSpaces Applications resource. You can tag WorkSpaces Applications 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 WorkSpaces Applications Administration Guide.
5500 5501 5502 5503 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5500 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 WorkSpaces Applications resource.
To list the current tags for your resources, use ListTagsForResource.
For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.
5536 5537 5538 5539 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5536 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.
5675 5676 5677 5678 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5675 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.
5758 5759 5760 5761 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5758 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 WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
5825 5826 5827 5828 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5825 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.
5882 5883 5884 5885 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 5882 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, andDisconnectTimeoutInSecondsattributes.Elastic fleet type
You can update the
DisplayName,IdleDisconnectTimeoutInSeconds,DisconnectTimeoutInSeconds,MaxConcurrentSessions,SessionScriptS3LocationandUsbDeviceFilterStringsattributes.
If the fleet is in the STARTING or STOPPED state, you can't
update it.
6277 6278 6279 6280 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 6277 def update_fleet(params = {}, = {}) req = build_request(:update_fleet, params) req.send_request() end |
#update_image_builder(params = {}) ⇒ Types::UpdateImageBuilderResult
Updates the specified fields for the specified image builder. The image builder must be in the STOPPED state.
6377 6378 6379 6380 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 6377 def update_image_builder(params = {}, = {}) req = build_request(:update_image_builder, params) req.send_request() end |
#update_image_permissions(params = {}) ⇒ Struct
Adds or updates permissions for the specified private image.
6411 6412 6413 6414 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 6411 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.
6609 6610 6611 6612 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 6609 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.
6696 6697 6698 6699 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 6696 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 |
6812 6813 6814 6815 6816 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 6812 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |