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_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_application(params = {}) ⇒ Types::CreateApplicationResult
Creates an application.
-
#create_directory_config(params = {}) ⇒ Types::CreateDirectoryConfigResult
Creates a Directory Config object in AppStream 2.0.
-
#create_entitlement(params = {}) ⇒ Types::CreateEntitlementResult
Creates a new entitlement.
-
#create_fleet(params = {}) ⇒ Types::CreateFleetResult
Creates a fleet.
-
#create_image_builder(params = {}) ⇒ Types::CreateImageBuilderResult
Creates an image builder.
-
#create_image_builder_streaming_url(params = {}) ⇒ Types::CreateImageBuilderStreamingURLResult
Creates a URL to start an image builder streaming session.
-
#create_stack(params = {}) ⇒ Types::CreateStackResult
Creates a stack to start streaming applications to users.
-
#create_streaming_url(params = {}) ⇒ Types::CreateStreamingURLResult
Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
-
#create_updated_image(params = {}) ⇒ Types::CreateUpdatedImageResult
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
-
#create_usage_report_subscription(params = {}) ⇒ Types::CreateUsageReportSubscriptionResult
Creates a usage report subscription.
-
#create_user(params = {}) ⇒ Struct
Creates a new user in the user pool.
-
#delete_app_block(params = {}) ⇒ Struct
Deletes an app block.
-
#delete_application(params = {}) ⇒ Struct
Deletes an application.
-
#delete_directory_config(params = {}) ⇒ Struct
Deletes the specified Directory Config object from AppStream 2.0.
-
#delete_entitlement(params = {}) ⇒ Struct
Deletes the specified entitlement.
-
#delete_fleet(params = {}) ⇒ Struct
Deletes the specified fleet.
-
#delete_image(params = {}) ⇒ Types::DeleteImageResult
Deletes the specified image.
-
#delete_image_builder(params = {}) ⇒ Types::DeleteImageBuilderResult
Deletes the specified image builder and releases the capacity.
-
#delete_image_permissions(params = {}) ⇒ Struct
Deletes permissions for the specified private image.
-
#delete_stack(params = {}) ⇒ Struct
Deletes the specified stack.
-
#delete_usage_report_subscription(params = {}) ⇒ Struct
Disables usage report generation.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user from the user pool.
-
#describe_app_blocks(params = {}) ⇒ Types::DescribeAppBlocksResult
Retrieves a list that describes one or more app blocks.
-
#describe_application_fleet_associations(params = {}) ⇒ Types::DescribeApplicationFleetAssociationsResult
Retrieves a list that describes one or more application fleet associations.
-
#describe_applications(params = {}) ⇒ Types::DescribeApplicationsResult
Retrieves a list that describes one or more applications.
-
#describe_directory_configs(params = {}) ⇒ Types::DescribeDirectoryConfigsResult
Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.
-
#describe_entitlements(params = {}) ⇒ Types::DescribeEntitlementsResult
Retrieves a list that describes one of more entitlements.
-
#describe_fleets(params = {}) ⇒ Types::DescribeFleetsResult
Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
-
#describe_image_builders(params = {}) ⇒ Types::DescribeImageBuildersResult
Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
-
#describe_image_permissions(params = {}) ⇒ Types::DescribeImagePermissionsResult
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
-
#describe_images(params = {}) ⇒ Types::DescribeImagesResult
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
-
#describe_sessions(params = {}) ⇒ Types::DescribeSessionsResult
Retrieves a list that describes the streaming sessions for a specified stack and fleet.
-
#describe_stacks(params = {}) ⇒ Types::DescribeStacksResult
Retrieves a list that describes one or more specified stacks, if the stack names are provided.
-
#describe_usage_report_subscriptions(params = {}) ⇒ Types::DescribeUsageReportSubscriptionsResult
Retrieves a list that describes one or more usage report subscriptions.
-
#describe_user_stack_associations(params = {}) ⇒ Types::DescribeUserStackAssociationsResult
Retrieves a list that describes the UserStackAssociation objects.
-
#describe_users(params = {}) ⇒ Types::DescribeUsersResult
Retrieves a list that describes one or more specified users in the user pool.
-
#disable_user(params = {}) ⇒ Struct
Disables the specified user in the user pool.
-
#disassociate_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_fleet(params = {}) ⇒ Struct
Starts the specified fleet.
-
#start_image_builder(params = {}) ⇒ Types::StartImageBuilderResult
Starts the specified image 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_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.
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.
358 359 360 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#associate_application_fleet(params = {}) ⇒ Types::AssociateApplicationFleetResult
Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
393 394 395 396 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 393 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.
423 424 425 426 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 423 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.
449 450 451 452 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 449 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.
492 493 494 495 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 492 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.
533 534 535 536 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 533 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.
579 580 581 582 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 579 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.
660 661 662 663 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 660 def create_app_block(params = {}, = {}) req = build_request(:create_app_block, 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.
764 765 766 767 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 764 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.
813 814 815 816 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 813 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.
876 877 878 879 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 876 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 run a specified image when using Always-On or On-Demand.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1200 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
.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1424 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.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1459 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.
1602 1603 1604 1605 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1602 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.
1664 1665 1666 1667 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1664 def create_streaming_url(params = {}, = {}) req = build_request(:create_streaming_url, params) req.send_request() end |
#create_updated_image(params = {}) ⇒ Types::CreateUpdatedImageResult
Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
1787 1788 1789 1790 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1787 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.
1809 1810 1811 1812 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1809 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.
1863 1864 1865 1866 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1863 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_app_block(params = {}) ⇒ Struct
Deletes an app block.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1885 def delete_app_block(params = {}, = {}) req = build_request(:delete_app_block, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes an application.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1907 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.
1931 1932 1933 1934 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1931 def delete_directory_config(params = {}, = {}) req = build_request(:delete_directory_config, params) req.send_request() end |
#delete_entitlement(params = {}) ⇒ Struct
Deletes the specified entitlement.
1957 1958 1959 1960 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1957 def delete_entitlement(params = {}, = {}) req = build_request(:delete_entitlement, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes the specified fleet.
1979 1980 1981 1982 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 1979 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.
2049 2050 2051 2052 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2049 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.
2105 2106 2107 2108 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2105 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.
2134 2135 2136 2137 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2134 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.
2159 2160 2161 2162 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2159 def delete_stack(params = {}, = {}) req = build_request(:delete_stack, params) req.send_request() end |
#delete_usage_report_subscription(params = {}) ⇒ Struct
Disables usage report generation.
2172 2173 2174 2175 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2172 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.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2202 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_app_blocks(params = {}) ⇒ Types::DescribeAppBlocksResult
Retrieves a list that describes one or more app blocks.
2253 2254 2255 2256 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2253 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.
2299 2300 2301 2302 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2299 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.
2357 2358 2359 2360 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2357 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.
2410 2411 2412 2413 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2410 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.
2462 2463 2464 2465 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2462 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
2540 2541 2542 2543 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2540 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.
2610 2611 2612 2613 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2610 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.
2663 2664 2665 2666 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2663 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.
2755 2756 2757 2758 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2755 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.
2825 2826 2827 2828 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2825 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.
2888 2889 2890 2891 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2888 def describe_stacks(params = {}, = {}) req = build_request(:describe_stacks, params) req.send_request() end |
#describe_usage_report_subscriptions(params = {}) ⇒ Types::DescribeUsageReportSubscriptionsResult
Retrieves a list that describes one or more usage report subscriptions.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2930 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
2992 2993 2994 2995 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 2992 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.
3041 3042 3043 3044 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3041 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.
3073 3074 3075 3076 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3073 def disable_user(params = {}, = {}) req = build_request(:disable_user, params) req.send_request() end |
#disassociate_application_fleet(params = {}) ⇒ Struct
Disassociates the specified application from the fleet.
3099 3100 3101 3102 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3099 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.
3129 3130 3131 3132 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3129 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.
3155 3156 3157 3158 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3155 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.
3190 3191 3192 3193 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3190 def enable_user(params = {}, = {}) req = build_request(:enable_user, params) req.send_request() end |
#expire_session(params = {}) ⇒ Struct
Immediately stops the specified streaming session.
3212 3213 3214 3215 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3212 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.
3249 3250 3251 3252 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3249 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.
3286 3287 3288 3289 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3286 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.
3330 3331 3332 3333 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3330 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.
3367 3368 3369 3370 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3367 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_fleet(params = {}) ⇒ Struct
Starts the specified fleet.
3389 3390 3391 3392 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3389 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.
3451 3452 3453 3454 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3451 def start_image_builder(params = {}, = {}) req = build_request(:start_image_builder, params) req.send_request() end |
#stop_fleet(params = {}) ⇒ Struct
Stops the specified fleet.
3473 3474 3475 3476 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3473 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.
3529 3530 3531 3532 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3529 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.
3581 3582 3583 3584 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3581 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.
3617 3618 3619 3620 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3617 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResult
Updates the specified application.
3700 3701 3702 3703 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3700 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.
3748 3749 3750 3751 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3748 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.
3805 3806 3807 3808 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 3805 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
, andUsbDeviceFilterStrings
attributes.
If the fleet is in the STARTING
or STOPPED
state, you can't
update it.
4116 4117 4118 4119 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4116 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.
4150 4151 4152 4153 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4150 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.
4277 4278 4279 4280 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4277 def update_stack(params = {}, = {}) req = build_request(:update_stack, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
fleet_started | #describe_fleets | 30 | 40 |
fleet_stopped | #describe_fleets | 30 | 40 |
4388 4389 4390 4391 4392 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/client.rb', line 4388 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |