aws-sdk-workspaces 1.45.0 → 1.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01a36cdced3b1651804df88a7742535394b50d96ae58a404f13f4eca8f1d5698
-  data.tar.gz: e30a892c2b627d2aef368c3c096a973ecb10c344e0b6a624407883a6008429b7
+  metadata.gz: 19009d2f85abbd493e2f1248e471ecee29d9b6553c9a7280b567d2017ca5c194
+  data.tar.gz: '08bb6ba9d697426a849b2cf2efc69aa24627331c52e507de2262856049e8057c'
 SHA512:
-  metadata.gz: edf61f4ae0ec37860dcde375e0c42e0b08a7aec561767fc85e94aa14231de52ea34156cb62d417f12abde3a6978e64281bd6161dead80823759405c44c943a2d
-  data.tar.gz: 0a628e7a28a115e28c115de319054faf3c4362893e6da4cc027e8741dd0904a1b30a917a6d4b7e88f90bf5169c7b8d62a016842a8d526d34f02cb44a8cbdb8af
+  metadata.gz: 34091854a20e9dbb326acca6366fe04703fe14c61de774f493bbebf85ec06534541669ee88f7c324fd713b593a48c0cb8bdf01cacffbab0b3ea21d774818201c
+  data.tar.gz: 9d9c87c1558222a71d72e4e55a979ca405469235c70e7c9242af7baf78b82a99896916c09fce784560f61d4070a64beb7c7c0b7cab1df384916d2037a74d4327

data/lib/aws-sdk-workspaces.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-workspaces/customizations'
 # @!group service
 module Aws::WorkSpaces
 
-  GEM_VERSION = '1.45.0'
+  GEM_VERSION = '1.50.0'
 
 end

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

@@ -445,7 +445,28 @@ module Aws::WorkSpaces
     end
 
     # Copies the specified image from the specified Region to the current
-    # Region.
+    # Region. For more information about copying images, see [ Copy a Custom
+    # WorkSpaces Image][1].
+    #
+    # <note markdown="1"> In the China (Ningxia) Region, you can copy images only within the
+    # same Region.
+    #
+    #  In the AWS GovCloud (US-West) Region, to copy images to and from other
+    # AWS Regions, contact AWS Support.
+    #
+    #  </note>
+    #
+    # Before copying a shared image, be sure to verify that it has been
+    # shared from the correct AWS account. To determine if an image has been
+    # shared and to see the AWS account ID that owns an image, use the
+    # [DescribeWorkSpaceImages][2] and
+    # [DescribeWorkspaceImagePermissions][3] API operations.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html
+    # [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html
+    # [3]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html
     #
     # @option params [required, String] :name
     #   The name of the image.
@@ -616,9 +637,7 @@ module Aws::WorkSpaces
     #   IP access control groups, and connection aliases.
     #
     # @option params [required, Array<Types::Tag>] :tags
-    #   The tags. Each WorkSpaces resource can have a maximum of 50 tags. If
-    #   you want to add new tags to a set of existing tags, you must submit
-    #   all of the existing tags along with the new ones.
+    #   The tags. Each WorkSpaces resource can have a maximum of 50 tags.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -860,6 +879,25 @@ module Aws::WorkSpaces
     # WorkSpaces are registered to this directory, you must remove them
     # before you can deregister the directory.
     #
+    # <note markdown="1"> Simple AD and AD Connector are made available to you free of charge to
+    # use with WorkSpaces. If there are no WorkSpaces being used with your
+    # Simple AD or AD Connector directory for 30 consecutive days, this
+    # directory will be automatically deregistered for use with Amazon
+    # WorkSpaces, and you will be charged for this directory as per the [AWS
+    # Directory Services pricing terms][1].
+    #
+    #  To delete empty directories, see [ Delete the Directory for Your
+    # WorkSpaces][2]. If you delete your Simple AD or AD Connector
+    # directory, you can always create a new one when you want to start
+    # using WorkSpaces again.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: http://aws.amazon.com/directoryservice/pricing/
+    # [2]: https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html
+    #
     # @option params [required, String] :directory_id
     #   The identifier of the directory. If any WorkSpaces are registered to
     #   this directory, you must remove them before you deregister the
@@ -1628,9 +1666,15 @@ module Aws::WorkSpaces
     #   The identifier of the EC2 image.
     #
     # @option params [required, String] :ingestion_process
-    #   The ingestion process to be used when importing the image. For
-    #   non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro),
-    #   specify `BYOL_REGULAR`.
+    #   The ingestion process to be used when importing the image, depending
+    #   on which protocol you want to use for your BYOL Workspace image,
+    #   either PCoIP or WorkSpaces Streaming Protocol (WSP). To use WSP,
+    #   specify a value that ends in `_WSP`. To use PCoIP, specify a value
+    #   that does not end in `_WSP`.
+    #
+    #   For non-GPU-enabled bundles (bundles other than Graphics or
+    #   GraphicsPro), specify `BYOL_REGULAR` or `BYOL_REGULAR_WSP`, depending
+    #   on the protocol.
     #
     # @option params [required, String] :image_name
     #   The name of the WorkSpace image.
@@ -1664,7 +1708,7 @@ module Aws::WorkSpaces
     #
     #   resp = client.import_workspace_image({
     #     ec2_image_id: "Ec2ImageId", # required
-    #     ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO
+    #     ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO, BYOL_REGULAR_WSP
     #     image_name: "WorkspaceImageName", # required
     #     image_description: "WorkspaceImageDescription", # required
     #     tags: [
@@ -1693,6 +1737,10 @@ module Aws::WorkSpaces
     # that you can use for the network management interface when you enable
     # Bring Your Own License (BYOL).
     #
+    # This operation can be run only by AWS accounts that are enabled for
+    # BYOL. If your account isn't enabled for BYOL, you'll receive an
+    # `AccessDeniedException` error.
+    #
     # 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
@@ -2340,12 +2388,37 @@ module Aws::WorkSpaces
     #
     # Terminating a WorkSpace is a permanent action and cannot be undone.
     # The user's data is destroyed. If you need to archive any user data,
-    # contact Amazon Web Services before terminating the WorkSpace.
+    # contact AWS Support before terminating the WorkSpace.
     #
     # You can terminate a WorkSpace that is in any state except `SUSPENDED`.
     #
     # This operation is asynchronous and returns before the WorkSpaces have
-    # been completely terminated.
+    # been completely terminated. After a WorkSpace is terminated, the
+    # `TERMINATED` state is returned only briefly before the WorkSpace
+    # directory metadata is cleaned up, so this state is rarely returned. To
+    # confirm that a WorkSpace is terminated, check for the WorkSpace ID by
+    # using [ DescribeWorkSpaces][1]. If the WorkSpace ID isn't returned,
+    # then the WorkSpace has been successfully terminated.
+    #
+    # <note markdown="1"> Simple AD and AD Connector are made available to you free of charge to
+    # use with WorkSpaces. If there are no WorkSpaces being used with your
+    # Simple AD or AD Connector directory for 30 consecutive days, this
+    # directory will be automatically deregistered for use with Amazon
+    # WorkSpaces, and you will be charged for this directory as per the [AWS
+    # Directory Services pricing terms][2].
+    #
+    #  To delete empty directories, see [ Delete the Directory for Your
+    # WorkSpaces][3]. If you delete your Simple AD or AD Connector
+    # directory, you can always create a new one when you want to start
+    # using WorkSpaces again.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
+    # [2]: http://aws.amazon.com/directoryservice/pricing/
+    # [3]: https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html
     #
     # @option params [required, Array<Types::TerminateRequest>] :terminate_workspace_requests
     #   The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
@@ -2467,11 +2540,25 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
-    # Shares or unshares an image with one account by specifying whether
-    # that account has permission to copy the image. If the copy image
-    # permission is granted, the image is shared with that account. If the
-    # copy image permission is revoked, the image is unshared with the
-    # account.
+    # Shares or unshares an image with one account in the same AWS Region by
+    # specifying whether that account has permission to copy the image. If
+    # the copy image permission is granted, the image is shared with that
+    # account. If the copy image permission is revoked, the image is
+    # unshared with the account.
+    #
+    # After an image has been shared, the recipient account can copy the
+    # image to other AWS Regions as needed.
+    #
+    # <note markdown="1"> In the China (Ningxia) Region, you can copy images only within the
+    # same Region.
+    #
+    #  In the AWS GovCloud (US-West) Region, to copy images to and from other
+    # AWS Regions, contact AWS Support.
+    #
+    #  </note>
+    #
+    # For more information about sharing images, see [ Share or Unshare a
+    # Custom WorkSpaces Image][1].
     #
     # <note markdown="1"> * To delete an image that has been shared, you must unshare the image
     #   before you delete it.
@@ -2483,6 +2570,10 @@ module Aws::WorkSpaces
     #
     #  </note>
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html
+    #
     # @option params [required, String] :image_id
     #   The identifier of the image.
     #
@@ -2493,6 +2584,9 @@ module Aws::WorkSpaces
     # @option params [required, String] :shared_account_id
     #   The identifier of the AWS account to share or unshare the image with.
     #
+    #   Before sharing the image, confirm that you are sharing to the correct
+    #   AWS account ID.
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -2525,7 +2619,7 @@ module Aws::WorkSpaces
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workspaces'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.50.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -529,9 +529,7 @@ module Aws::WorkSpaces
     #   @return [String]
     #
     # @!attribute [rw] tags
-    #   The tags. Each WorkSpaces resource can have a maximum of 50 tags. If
-    #   you want to add new tags to a set of existing tags, you must submit
-    #   all of the existing tags along with the new ones.
+    #   The tags. Each WorkSpaces resource can have a maximum of 50 tags.
     #   @return [Array<Types::Tag>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsRequest AWS API Documentation
@@ -1592,7 +1590,12 @@ module Aws::WorkSpaces
     end
 
     # Describes the AWS accounts that have been granted permission to use a
-    # shared image.
+    # shared image. For more information about sharing images, see [ Share
+    # or Unshare a Custom WorkSpaces Image][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html
     #
     # @!attribute [rw] shared_account_id
     #   The identifier of the AWS account that an image has been shared
@@ -1612,7 +1615,7 @@ module Aws::WorkSpaces
     #
     #       {
     #         ec2_image_id: "Ec2ImageId", # required
-    #         ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO
+    #         ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO, BYOL_REGULAR_WSP
     #         image_name: "WorkspaceImageName", # required
     #         image_description: "WorkspaceImageDescription", # required
     #         tags: [
@@ -1629,9 +1632,15 @@ module Aws::WorkSpaces
     #   @return [String]
     #
     # @!attribute [rw] ingestion_process
-    #   The ingestion process to be used when importing the image. For
-    #   non-GPU-enabled bundles (bundles other than Graphics or
-    #   GraphicsPro), specify `BYOL_REGULAR`.
+    #   The ingestion process to be used when importing the image, depending
+    #   on which protocol you want to use for your BYOL Workspace image,
+    #   either PCoIP or WorkSpaces Streaming Protocol (WSP). To use WSP,
+    #   specify a value that ends in `_WSP`. To use PCoIP, specify a value
+    #   that does not end in `_WSP`.
+    #
+    #   For non-GPU-enabled bundles (bundles other than Graphics or
+    #   GraphicsPro), specify `BYOL_REGULAR` or `BYOL_REGULAR_WSP`,
+    #   depending on the protocol.
     #   @return [String]
     #
     # @!attribute [rw] image_name
@@ -2879,6 +2888,9 @@ module Aws::WorkSpaces
     # @!attribute [rw] shared_account_id
     #   The identifier of the AWS account to share or unshare the image
     #   with.
+    #
+    #   Before sharing the image, confirm that you are sharing to the
+    #   correct AWS account ID.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermissionRequest AWS API Documentation
@@ -2930,6 +2942,19 @@ module Aws::WorkSpaces
     #
     # @!attribute [rw] state
     #   The operational state of the WorkSpace.
+    #
+    #   <note markdown="1"> After a WorkSpace is terminated, the `TERMINATED` state is returned
+    #   only briefly before the WorkSpace directory metadata is cleaned up,
+    #   so this state is rarely returned. To confirm that a WorkSpace is
+    #   terminated, check for the WorkSpace ID by using [
+    #   DescribeWorkSpaces][1]. If the WorkSpace ID isn't returned, then
+    #   the WorkSpace has been successfully terminated.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
     #   @return [String]
     #
     # @!attribute [rw] bundle_id
@@ -3325,6 +3350,16 @@ module Aws::WorkSpaces
     #
     # @!attribute [rw] state
     #   The state of the directory's registration with Amazon WorkSpaces.
+    #   After a directory is deregistered, the `DEREGISTERED` state is
+    #   returned very briefly before the directory metadata is cleaned up,
+    #   so this state is rarely returned. To confirm that a directory is
+    #   deregistered, check for the directory ID by using [
+    #   DescribeWorkspaceDirectories][1]. If the directory ID isn't
+    #   returned, then the directory has been successfully deregistered.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html
     #   @return [String]
     #
     # @!attribute [rw] workspace_creation_properties

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-workspaces
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.50.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.112.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.112.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement