aws-sdk-workspaces 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3f7c2d0618666c13662ac3c5e6c12aaca61b5d2
-  data.tar.gz: 29ca390de6ab52e4c6b3f96e8bc3f55b9560c52f
+  metadata.gz: b95f7c41b906a5a13dc4bd6a037eada15550d54c
+  data.tar.gz: 7d4fd7e2ce88b84c1f92a063f628704a94182dad
 SHA512:
-  metadata.gz: 9efe2bbe51fccf992e235ee77ec42e5d2d707cddb57abb152c0d403e917a3c199c1769efac42285afaa1a378bd923e997cb8e4e4dda50ae2445a643825a66ef6
-  data.tar.gz: 4e0ea61355e7e134ef4f34c1346ac87e2cbf75457e70b461650565fbae0de112639302e9afac1b06cafead468dd86f6d8f3b09e789e4930e50f7b5bddc951103
+  metadata.gz: 7f75bd60691d3ec93e303748c4bacf8ab5050f0375bd3e71f1a6a5b43d370b3e1ae7b6d47cb8654b3be8f00e53bf71b364773e161ee03ab0971151f06248fa0e
+  data.tar.gz: 6669786ff226b018352847d37ca00fc145916fb2591fa37b919c7551b7d629759235462e8e274f3fa6488ec505a0bae03dfb51caec0482b698f5ced1446fc72d

data/lib/aws-sdk-workspaces.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-workspaces/customizations'
 # @service
 module Aws::WorkSpaces
 
-  GEM_VERSION = '1.8.0'
+  GEM_VERSION = '1.9.0'
 
 end

data/lib/aws-sdk-workspaces/client.rb

@@ -15,6 +15,7 @@ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
 require 'aws-sdk-core/plugins/retry_errors.rb'
 require 'aws-sdk-core/plugins/global_configuration.rb'
 require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
 require 'aws-sdk-core/plugins/response_paging.rb'
 require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
@@ -45,6 +46,7 @@ module Aws::WorkSpaces
     add_plugin(Aws::Plugins::RetryErrors)
     add_plugin(Aws::Plugins::GlobalConfiguration)
     add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::EndpointDiscovery)
     add_plugin(Aws::Plugins::ResponsePaging)
     add_plugin(Aws::Plugins::StubResponses)
     add_plugin(Aws::Plugins::IdempotencyToken)
@@ -98,6 +100,10 @@ module Aws::WorkSpaces
     #
     #   @option options [String] :access_key_id
     #
+    #   @option options [Boolean] :active_endpoint_cache (false)
+    #     When set to `true`, a thread polling for endpoints will be running in
+    #     the background every 60 secs (default). Defaults to `false`.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -123,6 +129,21 @@ module Aws::WorkSpaces
     #     option. You should only configure an `:endpoint` when connecting
     #     to test endpoints. This should be avalid HTTP(S) URI.
     #
+    #   @option options [Integer] :endpoint_cache_max_entries (1000)
+    #     Used for the maximum size limit of the LRU cache storing endpoints data
+    #     for endpoint discovery enabled operations. Defaults to 1000.
+    #
+    #   @option options [Integer] :endpoint_cache_max_threads (10)
+    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+    #
+    #   @option options [Integer] :endpoint_cache_poll_interval (60)
+    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
+    #     Use this option to config the time interval in seconds for making
+    #     requests fetching endpoints information. Defaults to 60 sec.
+    #
+    #   @option options [Boolean] :endpoint_discovery (false)
+    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
     #
@@ -192,10 +213,10 @@ module Aws::WorkSpaces
     # directory.
     #
     # @option params [required, String] :directory_id
-    #   The ID of the directory.
+    #   The identifier of the directory.
     #
     # @option params [required, Array<String>] :group_ids
-    #   The IDs of one or more IP access control groups.
+    #   The identifiers of one or more IP access control groups.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -221,7 +242,7 @@ module Aws::WorkSpaces
     # CIDR address ranges specified in the rules.
     #
     # @option params [required, String] :group_id
-    #   The ID of the group.
+    #   The identifier of the group.
     #
     # @option params [required, Array<Types::IpRuleItem>] :user_rules
     #   The rules to add to the group.
@@ -307,7 +328,8 @@ module Aws::WorkSpaces
     # Creates the specified tags for the specified WorkSpace.
     #
     # @option params [required, String] :resource_id
-    #   The ID of the WorkSpace. To find this ID, use DescribeWorkspaces.
+    #   The identifier of the WorkSpace. To find this ID, use
+    #   DescribeWorkspaces.
     #
     # @option params [required, Array<Types::Tag>] :tags
     #   The tags. Each WorkSpace can have a maximum of 50 tags.
@@ -433,7 +455,7 @@ module Aws::WorkSpaces
     # directory.
     #
     # @option params [required, String] :group_id
-    #   The ID of the IP access control group.
+    #   The identifier of the IP access control group.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -455,7 +477,8 @@ module Aws::WorkSpaces
     # Deletes the specified tags from the specified WorkSpace.
     #
     # @option params [required, String] :resource_id
-    #   The ID of the WorkSpace. To find this ID, use DescribeWorkspaces.
+    #   The identifier of the WorkSpace. To find this ID, use
+    #   DescribeWorkspaces.
     #
     # @option params [required, Array<String>] :tag_keys
     #   The tag keys.
@@ -478,14 +501,97 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Deletes the specified image from your account. To delete an image, you
+    # must first delete any bundles that are associated with the image.
+    #
+    # @option params [required, String] :image_id
+    #   The identifier of the image.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_workspace_image({
+    #     image_id: "WorkspaceImageId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteWorkspaceImage AWS API Documentation
+    #
+    # @overload delete_workspace_image(params = {})
+    # @param [Hash] params ({})
+    def delete_workspace_image(params = {}, options = {})
+      req = build_request(:delete_workspace_image, params)
+      req.send_request(options)
+    end
+
+    # Retrieves a list that describes the configuration of bring your own
+    # license (BYOL) for the specified account.
+    #
+    # @return [Types::DescribeAccountResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeAccountResult#dedicated_tenancy_support #dedicated_tenancy_support} => String
+    #   * {Types::DescribeAccountResult#dedicated_tenancy_management_cidr_range #dedicated_tenancy_management_cidr_range} => String
+    #
+    # @example Response structure
+    #
+    #   resp.dedicated_tenancy_support #=> String, one of "ENABLED", "DISABLED"
+    #   resp.dedicated_tenancy_management_cidr_range #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeAccount AWS API Documentation
+    #
+    # @overload describe_account(params = {})
+    # @param [Hash] params ({})
+    def describe_account(params = {}, options = {})
+      req = build_request(:describe_account, params)
+      req.send_request(options)
+    end
+
+    # Retrieves a list that describes modifications to the configuration of
+    # bring your own license (BYOL) for the specified account.
+    #
+    # @option params [String] :next_token
+    #   If you received a `NextToken` from a previous call that was paginated,
+    #   provide this token to receive the next set of results.
+    #
+    # @return [Types::DescribeAccountModificationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeAccountModificationsResult#account_modifications #account_modifications} => Array&lt;Types::AccountModification&gt;
+    #   * {Types::DescribeAccountModificationsResult#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_account_modifications({
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.account_modifications #=> Array
+    #   resp.account_modifications[0].modification_state #=> String, one of "PENDING", "COMPLETED", "FAILED"
+    #   resp.account_modifications[0].dedicated_tenancy_support #=> String, one of "ENABLED", "DISABLED"
+    #   resp.account_modifications[0].dedicated_tenancy_management_cidr_range #=> String
+    #   resp.account_modifications[0].start_time #=> Time
+    #   resp.account_modifications[0].error_code #=> String
+    #   resp.account_modifications[0].error_message #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeAccountModifications AWS API Documentation
+    #
+    # @overload describe_account_modifications(params = {})
+    # @param [Hash] params ({})
+    def describe_account_modifications(params = {}, options = {})
+      req = build_request(:describe_account_modifications, params)
+      req.send_request(options)
+    end
+
     # Describes one or more of your IP access control groups.
     #
     # @option params [Array<String>] :group_ids
-    #   The IDs of one or more IP access control groups.
+    #   The identifiers of one or more IP access control groups.
     #
     # @option params [String] :next_token
-    #   The token for the next set of results. (You received this token from a
-    #   previous call.)
+    #   If you received a `NextToken` from a previous call that was paginated,
+    #   provide this token to receive the next set of results.
     #
     # @option params [Integer] :max_results
     #   The maximum number of items to return.
@@ -526,7 +632,8 @@ module Aws::WorkSpaces
     # Describes the specified tags for the specified WorkSpace.
     #
     # @option params [required, String] :resource_id
-    #   The ID of the WorkSpace. To find this ID, use DescribeWorkspaces.
+    #   The identifier of the WorkSpace. To find this ID, use
+    #   DescribeWorkspaces.
     #
     # @return [Types::DescribeTagsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -553,17 +660,17 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
-    # Describes the available WorkSpace bundles.
+    # Retrieves a list that describes the available WorkSpace bundles.
     #
     # You can filter the results using either bundle ID or owner, but not
     # both.
     #
     # @option params [Array<String>] :bundle_ids
-    #   The IDs of the bundles. This parameter cannot be combined with any
-    #   other filter.
+    #   The identifiers of the bundles. You cannot combine this parameter with
+    #   any other filter.
     #
     # @option params [String] :owner
-    #   The owner of the bundles. This parameter cannot be combined with any
+    #   The owner of the bundles. You cannot combine this parameter with any
     #   other filter.
     #
     #   Specify `AMAZON` to describe the bundles provided by AWS or null to
@@ -615,8 +722,8 @@ module Aws::WorkSpaces
     #   directories are retrieved.
     #
     # @option params [String] :next_token
-    #   The token for the next set of results. (You received this token from a
-    #   previous call.)
+    #   If you received a `NextToken` from a previous call that was paginated,
+    #   provide this token to receive the next set of results.
     #
     # @return [Types::DescribeWorkspaceDirectoriesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -664,39 +771,88 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Retrieves a list that describes one or more specified images, if the
+    # image identifiers are provided. Otherwise, all images in the account
+    # are described.
+    #
+    # @option params [Array<String>] :image_ids
+    #   The identifier of the image.
+    #
+    # @option params [String] :next_token
+    #   If you received a `NextToken` from a previous call that was paginated,
+    #   provide this token to receive the next set of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of items to return.
+    #
+    # @return [Types::DescribeWorkspaceImagesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeWorkspaceImagesResult#images #images} => Array&lt;Types::WorkspaceImage&gt;
+    #   * {Types::DescribeWorkspaceImagesResult#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_workspace_images({
+    #     image_ids: ["WorkspaceImageId"],
+    #     next_token: "PaginationToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.images #=> Array
+    #   resp.images[0].image_id #=> String
+    #   resp.images[0].name #=> String
+    #   resp.images[0].description #=> String
+    #   resp.images[0].operating_system.type #=> String, one of "WINDOWS", "LINUX"
+    #   resp.images[0].state #=> String, one of "AVAILABLE", "PENDING", "ERROR"
+    #   resp.images[0].required_tenancy #=> String, one of "DEFAULT", "DEDICATED"
+    #   resp.images[0].error_code #=> String
+    #   resp.images[0].error_message #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImages AWS API Documentation
+    #
+    # @overload describe_workspace_images(params = {})
+    # @param [Hash] params ({})
+    def describe_workspace_images(params = {}, options = {})
+      req = build_request(:describe_workspace_images, params)
+      req.send_request(options)
+    end
+
     # Describes the specified WorkSpaces.
     #
-    # You can filter the results using bundle ID, directory ID, or owner,
-    # but you can specify only one filter at a time.
+    # You can filter the results by using the bundle identifier, directory
+    # identifier, or owner, but you can specify only one filter at a time.
     #
     # @option params [Array<String>] :workspace_ids
-    #   The IDs of the WorkSpaces. This parameter cannot be combined with any
-    #   other filter.
+    #   The identifiers of the WorkSpaces. You cannot combine this parameter
+    #   with any other filter.
     #
     #   Because the CreateWorkspaces operation is asynchronous, the identifier
     #   it returns is not immediately available. If you immediately call
     #   DescribeWorkspaces with this identifier, no information is returned.
     #
     # @option params [String] :directory_id
-    #   The ID of the directory. In addition, you can optionally specify a
-    #   specific directory user (see `UserName`). This parameter cannot be
-    #   combined with any other filter.
+    #   The identifier of the directory. In addition, you can optionally
+    #   specify a specific directory user (see `UserName`). You cannot combine
+    #   this parameter with any other filter.
     #
     # @option params [String] :user_name
     #   The name of the directory user. You must specify this parameter with
     #   `DirectoryId`.
     #
     # @option params [String] :bundle_id
-    #   The ID of the bundle. All WorkSpaces that are created from this bundle
-    #   are retrieved. This parameter cannot be combined with any other
-    #   filter.
+    #   The identifier of the bundle. All WorkSpaces that are created from
+    #   this bundle are retrieved. You cannot combine this parameter with any
+    #   other filter.
     #
     # @option params [Integer] :limit
     #   The maximum number of items to return.
     #
     # @option params [String] :next_token
-    #   The token for the next set of results. (You received this token from a
-    #   previous call.)
+    #   If you received a `NextToken` from a previous call that was paginated,
+    #   provide this token to receive the next set of results.
     #
     # @return [Types::DescribeWorkspacesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -756,8 +912,8 @@ module Aws::WorkSpaces
     #   WorkSpaces.
     #
     # @option params [String] :next_token
-    #   The token for the next set of results. (You received this token from a
-    #   previous call.)
+    #   If you received a `NextToken` from a previous call that was paginated,
+    #   provide this token to receive the next set of results.
     #
     # @return [Types::DescribeWorkspacesConnectionStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -793,10 +949,10 @@ module Aws::WorkSpaces
     # directory.
     #
     # @option params [required, String] :directory_id
-    #   The ID of the directory.
+    #   The identifier of the directory.
     #
     # @option params [required, Array<String>] :group_ids
-    #   The IDs of one or more IP access control groups.
+    #   The identifiers of one or more IP access control groups.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -816,10 +972,134 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Imports the specified Windows 7 or Windows 10 bring your own license
+    # (BYOL) image into Amazon WorkSpaces. The image must be an already
+    # licensed EC2 image that is in your AWS account, and you must own the
+    # image.
+    #
+    # @option params [required, String] :ec2_image_id
+    #   The identifier of the EC2 image.
+    #
+    # @option params [required, String] :ingestion_process
+    #   The ingestion process to be used when importing the image.
+    #
+    # @option params [required, String] :image_name
+    #   The name of the WorkSpace image.
+    #
+    # @option params [required, String] :image_description
+    #   The description of the WorkSpace image.
+    #
+    # @return [Types::ImportWorkspaceImageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ImportWorkspaceImageResult#image_id #image_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.import_workspace_image({
+    #     ec2_image_id: "Ec2ImageId", # required
+    #     ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO
+    #     image_name: "WorkspaceImageName", # required
+    #     image_description: "WorkspaceImageDescription", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.image_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImage AWS API Documentation
+    #
+    # @overload import_workspace_image(params = {})
+    # @param [Hash] params ({})
+    def import_workspace_image(params = {}, options = {})
+      req = build_request(:import_workspace_image, params)
+      req.send_request(options)
+    end
+
+    # Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks,
+    # that you can use for the network management interface when you enable
+    # bring your own license (BYOL).
+    #
+    # The management network interface is connected to a secure Amazon
+    # WorkSpaces management network. It is used for interactive streaming of
+    # the WorkSpace desktop to Amazon WorkSpaces clients, and to allow
+    # Amazon WorkSpaces to manage the WorkSpace.
+    #
+    # @option params [required, String] :management_cidr_range_constraint
+    #   The IP address range to search. Specify an IP address range that is
+    #   compatible with your network and in CIDR notation (that is, specify
+    #   the range as an IPv4 CIDR block).
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of items to return.
+    #
+    # @option params [String] :next_token
+    #   If you received a `NextToken` from a previous call that was paginated,
+    #   provide this token to receive the next set of results.
+    #
+    # @return [Types::ListAvailableManagementCidrRangesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListAvailableManagementCidrRangesResult#management_cidr_ranges #management_cidr_ranges} => Array&lt;String&gt;
+    #   * {Types::ListAvailableManagementCidrRangesResult#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_available_management_cidr_ranges({
+    #     management_cidr_range_constraint: "ManagementCidrRangeConstraint", # required
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.management_cidr_ranges #=> Array
+    #   resp.management_cidr_ranges[0] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRanges AWS API Documentation
+    #
+    # @overload list_available_management_cidr_ranges(params = {})
+    # @param [Hash] params ({})
+    def list_available_management_cidr_ranges(params = {}, options = {})
+      req = build_request(:list_available_management_cidr_ranges, params)
+      req.send_request(options)
+    end
+
+    # Modifies the configuration of bring your own license (BYOL) for the
+    # specified account.
+    #
+    # @option params [String] :dedicated_tenancy_support
+    #   The status of BYOL.
+    #
+    # @option params [String] :dedicated_tenancy_management_cidr_range
+    #   The IP address range, specified as an IPv4 CIDR block, for the
+    #   management network interface. Specify an IP address range that is
+    #   compatible with your network and in CIDR notation (that is, specify
+    #   the range as an IPv4 CIDR block). The CIDR block size must be /16 (for
+    #   example, 203.0.113.25/16). It must also be specified as available by
+    #   the `ListAvailableManagementCidrRanges` operation.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.modify_account({
+    #     dedicated_tenancy_support: "ENABLED", # accepts ENABLED
+    #     dedicated_tenancy_management_cidr_range: "DedicatedTenancyManagementCidrRange",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyAccount AWS API Documentation
+    #
+    # @overload modify_account(params = {})
+    # @param [Hash] params ({})
+    def modify_account(params = {}, options = {})
+      req = build_request(:modify_account, params)
+      req.send_request(options)
+    end
+
     # Modifies the specified WorkSpace properties.
     #
     # @option params [required, String] :workspace_id
-    #   The ID of the WorkSpace.
+    #   The identifier of the WorkSpace.
     #
     # @option params [required, Types::WorkspaceProperties] :workspace_properties
     #   The properties of the WorkSpace.
@@ -857,7 +1137,7 @@ module Aws::WorkSpaces
     # `ADMIN_MAINTENANCE` state.
     #
     # @option params [required, String] :workspace_id
-    #   The ID of the WorkSpace.
+    #   The identifier of the WorkSpace.
     #
     # @option params [required, String] :workspace_state
     #   The WorkSpace state.
@@ -973,7 +1253,7 @@ module Aws::WorkSpaces
     # Removes one or more rules from the specified IP access control group.
     #
     # @option params [required, String] :group_id
-    #   The ID of the group.
+    #   The identifier of the group.
     #
     # @option params [required, Array<String>] :user_rules
     #   The rules to remove from the group.
@@ -1120,7 +1400,7 @@ module Aws::WorkSpaces
     # with the specified rules.
     #
     # @option params [required, String] :group_id
-    #   The ID of the group.
+    #   The identifier of the group.
     #
     # @option params [required, Array<Types::IpRuleItem>] :user_rules
     #   One or more rules.
@@ -1161,7 +1441,7 @@ module Aws::WorkSpaces
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workspaces'
-      context[:gem_version] = '1.8.0'
+      context[:gem_version] = '1.9.0'
       Seahorse::Client::Request.new(handlers, context)
     end