aws-sdk-workspaces 1.41.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f87d8c6c133b109ecd2620b41fb2cb2d9541e78ceaada1e05996fdc473ee4f
-  data.tar.gz: d4a0e50a962fce0f46d77a879eeea83c838dea576476f0ebe4039d555e05ab77
+  metadata.gz: 33d004bd652fa5fddfb8950584338d671459a13af1f686e8232b78c9b7e2ed47
+  data.tar.gz: b2501acd76d42e3239f6b1ccbb4fb5bfcb27fd403ed719690f4bc77e032eeb70
 SHA512:
-  metadata.gz: 70f71cf6fafc14c0d3ba46446f86bfa1a66e7bc6faebd8fb3a7df5c90680feb257907876d0636b503b4bd4bdb7cd7c9e167c8e6d448e9f32ea129262c6dbaba0
-  data.tar.gz: 0c2c935962b96cc1ec24abb7178ec5ebad8b3f36d5d0a5681989b0322c681f19761087d9609ce1ddcaa27f371138425ed6193f0baef7e00bcd9fad0aff5436e2
+  metadata.gz: 111ed9a418efdf3d9fd8d3c7738848fb41caf06804a2b191ae314f9da8697acbf64d2c4e467e840e1a6ad15a4690e02129c0a71c343389ab2ce282e891bea2ac
+  data.tar.gz: 681a2471f9a2f83da58bf9eea4a26d030a48097cf8d3f101e9c436106229aed2e8fb39e8306843042d6bebf69fe5648b4d15ab5f597408597451a0fd3b10ade6

data/lib/aws-sdk-workspaces.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -27,7 +28,7 @@ require_relative 'aws-sdk-workspaces/customizations'
 # structure.
 #
 #     work_spaces = Aws::WorkSpaces::Client.new
-#     resp = work_spaces.associate_ip_groups(params)
+#     resp = work_spaces.associate_connection_alias(params)
 #
 # See {Client} for more information.
 #
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-workspaces/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::WorkSpaces
 
-  GEM_VERSION = '1.41.0'
+  GEM_VERSION = '1.46.0'
 
 end

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

@@ -85,13 +85,28 @@ module Aws::WorkSpaces
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::WorkSpaces
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -322,6 +337,52 @@ module Aws::WorkSpaces
 
     # @!group API Operations
 
+    # Associates the specified connection alias with the specified directory
+    # to enable cross-Region redirection. For more information, see [
+    # Cross-Region Redirection for Amazon WorkSpaces][1].
+    #
+    # <note markdown="1"> Before performing this operation, call [ DescribeConnectionAliases][2]
+    # to make sure that the current state of the connection alias is
+    # `CREATED`.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
+    # [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
+    #
+    # @option params [required, String] :alias_id
+    #   The identifier of the connection alias.
+    #
+    # @option params [required, String] :resource_id
+    #   The identifier of the directory to associate the connection alias
+    #   with.
+    #
+    # @return [Types::AssociateConnectionAliasResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::AssociateConnectionAliasResult#connection_identifier #connection_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.associate_connection_alias({
+    #     alias_id: "ConnectionAliasId", # required
+    #     resource_id: "NonEmptyString", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.connection_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateConnectionAlias AWS API Documentation
+    #
+    # @overload associate_connection_alias(params = {})
+    # @param [Hash] params ({})
+    def associate_connection_alias(params = {}, options = {})
+      req = build_request(:associate_connection_alias, params)
+      req.send_request(options)
+    end
+
     # Associates the specified IP access control group with the specified
     # directory.
     #
@@ -433,6 +494,56 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Creates the specified connection alias for use with cross-Region
+    # redirection. For more information, see [ Cross-Region Redirection for
+    # Amazon WorkSpaces][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
+    #
+    # @option params [required, String] :connection_string
+    #   A connection string in the form of a fully qualified domain name
+    #   (FQDN), such as `www.example.com`.
+    #
+    #   After you create a connection string, it is always associated to your
+    #   AWS account. You cannot recreate the same connection string with a
+    #   different account, even if you delete all instances of it from the
+    #   original account. The connection string is globally reserved for your
+    #   account.
+    #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags to associate with the connection alias.
+    #
+    # @return [Types::CreateConnectionAliasResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateConnectionAliasResult#alias_id #alias_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_connection_alias({
+    #     connection_string: "ConnectionString", # required
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue",
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.alias_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectionAlias AWS API Documentation
+    #
+    # @overload create_connection_alias(params = {})
+    # @param [Hash] params ({})
+    def create_connection_alias(params = {}, options = {})
+      req = build_request(:create_connection_alias, params)
+      req.send_request(options)
+    end
+
     # Creates an IP access control group.
     #
     # An IP access control group provides you with the ability to control
@@ -502,7 +613,7 @@ module Aws::WorkSpaces
     # @option params [required, String] :resource_id
     #   The identifier of the WorkSpaces resource. The supported resource
     #   types are WorkSpaces, registered directories, images, custom bundles,
-    #   and IP access control groups.
+    #   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
@@ -624,6 +735,49 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Deletes the specified connection alias. For more information, see [
+    # Cross-Region Redirection for Amazon WorkSpaces][1].
+    #
+    # **If you will no longer be using a fully qualified domain name (FQDN)
+    # as the registration code for your WorkSpaces users, you must take
+    # certain precautions to prevent potential security issues.** For more
+    # information, see [ Security Considerations if You Stop Using
+    # Cross-Region Redirection][2].
+    #
+    # <note markdown="1"> To delete a connection alias that has been shared, the shared account
+    # must first disassociate the connection alias from any directories it
+    # has been associated with. Then you must unshare the connection alias
+    # from the account it has been shared with. You can delete a connection
+    # alias only after it is no longer shared with any accounts or
+    # associated with any directories.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
+    # [2]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations
+    #
+    # @option params [required, String] :alias_id
+    #   The identifier of the connection alias to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_connection_alias({
+    #     alias_id: "ConnectionAliasId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectionAlias AWS API Documentation
+    #
+    # @overload delete_connection_alias(params = {})
+    # @param [Hash] params ({})
+    def delete_connection_alias(params = {}, options = {})
+      req = build_request(:delete_connection_alias, params)
+      req.send_request(options)
+    end
+
     # Deletes the specified IP access control group.
     #
     # You cannot delete an IP access control group that is associated with a
@@ -654,7 +808,7 @@ module Aws::WorkSpaces
     # @option params [required, String] :resource_id
     #   The identifier of the WorkSpaces resource. The supported resource
     #   types are WorkSpaces, registered directories, images, custom bundles,
-    #   and IP access control groups.
+    #   IP access control groups, and connection aliases.
     #
     # @option params [required, Array<String>] :tag_keys
     #   The tag keys.
@@ -820,6 +974,114 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Describes the permissions that the owner of a connection alias has
+    # granted to another AWS account for the specified connection alias. For
+    # more information, see [ Cross-Region Redirection for Amazon
+    # WorkSpaces][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
+    #
+    # @option params [required, String] :alias_id
+    #   The identifier of the connection alias.
+    #
+    # @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 results to return.
+    #
+    # @return [Types::DescribeConnectionAliasPermissionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeConnectionAliasPermissionsResult#alias_id #alias_id} => String
+    #   * {Types::DescribeConnectionAliasPermissionsResult#connection_alias_permissions #connection_alias_permissions} => Array&lt;Types::ConnectionAliasPermission&gt;
+    #   * {Types::DescribeConnectionAliasPermissionsResult#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_connection_alias_permissions({
+    #     alias_id: "ConnectionAliasId", # required
+    #     next_token: "PaginationToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.alias_id #=> String
+    #   resp.connection_alias_permissions #=> Array
+    #   resp.connection_alias_permissions[0].shared_account_id #=> String
+    #   resp.connection_alias_permissions[0].allow_association #=> Boolean
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions AWS API Documentation
+    #
+    # @overload describe_connection_alias_permissions(params = {})
+    # @param [Hash] params ({})
+    def describe_connection_alias_permissions(params = {}, options = {})
+      req = build_request(:describe_connection_alias_permissions, params)
+      req.send_request(options)
+    end
+
+    # Retrieves a list that describes the connection aliases used for
+    # cross-Region redirection. For more information, see [ Cross-Region
+    # Redirection for Amazon WorkSpaces][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
+    #
+    # @option params [Array<String>] :alias_ids
+    #   The identifiers of the connection aliases to describe.
+    #
+    # @option params [String] :resource_id
+    #   The identifier of the directory associated with the connection alias.
+    #
+    # @option params [Integer] :limit
+    #   The maximum number of connection aliases 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::DescribeConnectionAliasesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeConnectionAliasesResult#connection_aliases #connection_aliases} => Array&lt;Types::ConnectionAlias&gt;
+    #   * {Types::DescribeConnectionAliasesResult#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_connection_aliases({
+    #     alias_ids: ["ConnectionAliasId"],
+    #     resource_id: "NonEmptyString",
+    #     limit: 1,
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.connection_aliases #=> Array
+    #   resp.connection_aliases[0].connection_string #=> String
+    #   resp.connection_aliases[0].alias_id #=> String
+    #   resp.connection_aliases[0].state #=> String, one of "CREATING", "CREATED", "DELETING"
+    #   resp.connection_aliases[0].owner_account_id #=> String
+    #   resp.connection_aliases[0].associations #=> Array
+    #   resp.connection_aliases[0].associations[0].association_status #=> String, one of "NOT_ASSOCIATED", "ASSOCIATED_WITH_OWNER_ACCOUNT", "ASSOCIATED_WITH_SHARED_ACCOUNT", "PENDING_ASSOCIATION", "PENDING_DISASSOCIATION"
+    #   resp.connection_aliases[0].associations[0].associated_account_id #=> String
+    #   resp.connection_aliases[0].associations[0].resource_id #=> String
+    #   resp.connection_aliases[0].associations[0].connection_identifier #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases AWS API Documentation
+    #
+    # @overload describe_connection_aliases(params = {})
+    # @param [Hash] params ({})
+    def describe_connection_aliases(params = {}, options = {})
+      req = build_request(:describe_connection_aliases, params)
+      req.send_request(options)
+    end
+
     # Describes one or more of your IP access control groups.
     #
     # @option params [Array<String>] :group_ids
@@ -870,7 +1132,7 @@ module Aws::WorkSpaces
     # @option params [required, String] :resource_id
     #   The identifier of the WorkSpaces resource. The supported resource
     #   types are WorkSpaces, registered directories, images, custom bundles,
-    #   and IP access control groups.
+    #   IP access control groups, and connection aliases.
     #
     # @return [Types::DescribeTagsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1289,6 +1551,42 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Disassociates a connection alias from a directory. Disassociating a
+    # connection alias disables cross-Region redirection between two
+    # directories in different AWS Regions. For more information, see [
+    # Cross-Region Redirection for Amazon WorkSpaces][1].
+    #
+    # <note markdown="1"> Before performing this operation, call [ DescribeConnectionAliases][2]
+    # to make sure that the current state of the connection alias is
+    # `CREATED`.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
+    # [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
+    #
+    # @option params [required, String] :alias_id
+    #   The identifier of the connection alias to disassociate.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.disassociate_connection_alias({
+    #     alias_id: "ConnectionAliasId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias AWS API Documentation
+    #
+    # @overload disassociate_connection_alias(params = {})
+    # @param [Hash] params ({})
+    def disassociate_connection_alias(params = {}, options = {})
+      req = build_request(:disassociate_connection_alias, params)
+      req.send_request(options)
+    end
+
     # Disassociates the specified IP access control group from the specified
     # directory.
     #
@@ -1316,16 +1614,23 @@ 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.
+    # Imports the specified Windows 10 Bring Your Own License (BYOL) image
+    # into Amazon WorkSpaces. The image must be an already licensed Amazon
+    # EC2 image that is in your AWS account, and you must own the image. For
+    # more information about creating BYOL images, see [ Bring Your Own
+    # Windows Desktop Licenses][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
     #
     # @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.
+    #   The ingestion process to be used when importing the image. For
+    #   non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro),
+    #   specify `BYOL_REGULAR`.
     #
     # @option params [required, String] :image_name
     #   The name of the WorkSpace image.
@@ -1336,6 +1641,21 @@ module Aws::WorkSpaces
     # @option params [Array<Types::Tag>] :tags
     #   The tags. Each WorkSpaces resource can have a maximum of 50 tags.
     #
+    # @option params [Array<String>] :applications
+    #   If specified, the version of Microsoft Office to subscribe to. Valid
+    #   only for Windows 10 BYOL images. For more information about
+    #   subscribing to Office for BYOL images, see [ Bring Your Own Windows
+    #   Desktop Licenses][1].
+    #
+    #   <note markdown="1"> Although this parameter is an array, only one item is allowed at this
+    #   time.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
+    #
     # @return [Types::ImportWorkspaceImageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ImportWorkspaceImageResult#image_id #image_id} => String
@@ -1353,6 +1673,7 @@ module Aws::WorkSpaces
     #         value: "TagValue",
     #       },
     #     ],
+    #     applications: ["Microsoft_Office_2016"], # accepts Microsoft_Office_2016, Microsoft_Office_2019
     #   })
     #
     # @example Response structure
@@ -1621,6 +1942,7 @@ module Aws::WorkSpaces
     #   resp = client.modify_workspace_creation_properties({
     #     resource_id: "DirectoryId", # required
     #     workspace_creation_properties: { # required
+    #       enable_work_docs: false,
     #       enable_internet_access: false,
     #       default_ou: "DefaultOu",
     #       custom_security_group_id: "SecurityGroupId",
@@ -2058,6 +2380,61 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Shares or unshares a connection alias with one account by specifying
+    # whether that account has permission to associate the connection alias
+    # with a directory. If the association permission is granted, the
+    # connection alias is shared with that account. If the association
+    # permission is revoked, the connection alias is unshared with the
+    # account. For more information, see [ Cross-Region Redirection for
+    # Amazon WorkSpaces][1].
+    #
+    # <note markdown="1"> * Before performing this operation, call [
+    #   DescribeConnectionAliases][2] to make sure that the current state of
+    #   the connection alias is `CREATED`.
+    #
+    # * To delete a connection alias that has been shared, the shared
+    #   account must first disassociate the connection alias from any
+    #   directories it has been associated with. Then you must unshare the
+    #   connection alias from the account it has been shared with. You can
+    #   delete a connection alias only after it is no longer shared with any
+    #   accounts or associated with any directories.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
+    # [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
+    #
+    # @option params [required, String] :alias_id
+    #   The identifier of the connection alias that you want to update
+    #   permissions for.
+    #
+    # @option params [required, Types::ConnectionAliasPermission] :connection_alias_permission
+    #   Indicates whether to share or unshare the connection alias with the
+    #   specified AWS account.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_connection_alias_permission({
+    #     alias_id: "ConnectionAliasId", # required
+    #     connection_alias_permission: { # required
+    #       shared_account_id: "AwsAccount", # required
+    #       allow_association: false, # required
+    #     },
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission AWS API Documentation
+    #
+    # @overload update_connection_alias_permission(params = {})
+    # @param [Hash] params ({})
+    def update_connection_alias_permission(params = {}, options = {})
+      req = build_request(:update_connection_alias_permission, params)
+      req.send_request(options)
+    end
+
     # Replaces the current rules of the specified IP access control group
     # with the specified rules.
     #
@@ -2148,7 +2525,7 @@ module Aws::WorkSpaces
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workspaces'
-      context[:gem_version] = '1.41.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end