aws-sdk-workspaces 1.70.0 → 1.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 942beecf8fedbfb22e48e17c9dfeebe41d892d53bd1c8fd93903f94892e54e1b
-  data.tar.gz: 835b67410e67a22fe8be63b90b347fa5e933f473c7c6e72063344639536a23d1
+  metadata.gz: 250a357bcddb89710d7544d0bf729d75a7da0d5f3bee68e0607ea7ea2e6f14a8
+  data.tar.gz: d99d78683667cfc5013683b507cab6d8074a7cf26c12d7098f039e3c9341a9db
 SHA512:
-  metadata.gz: 5da73aa4c3f2e98398200524efdcaa166b69295f99905515f1ca712b40b6fbae75f6b9c0aa5ce37213d4a9c116c4f1eecda04a1af090d8b3ce556d17ba646ada
-  data.tar.gz: 9fed42245ad5c4e191b465d6781a8ced7e2a3892188304dbddb0b6c69cb7fafdb9c5ee85e2a5a9dc0c69f9a13c05e5b4606d1baaa2b2fb45bf6fe8af87fcf8e4
+  metadata.gz: 4b01fe5fe35b8b882bfadd8c67c2ee481b78e44284fcbe0e00cb689bfd9daf379eb9a509d955c978664fd25b7dc690113db6649b48288ee3092a58b45b478849
+  data.tar.gz: a519b09ce7aa758563fb065c4cce78a0175ae94205f11696307773627a3dee061ed5a53f2cf58e54af6bc6666a4e87a17cf98662edff010dc86f445382c003e9

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.71.0 (2022-07-27)
+------------------
+
+* Feature - Added CreateWorkspaceImage API to create a new WorkSpace image from an existing WorkSpace.
+
 1.70.0 (2022-07-19)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.70.0
+1.71.0

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

@@ -881,6 +881,67 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Creates a new WorkSpace image from an existing WorkSpace.
+    #
+    # @option params [required, String] :name
+    #   The name of the new WorkSpace image.
+    #
+    # @option params [required, String] :description
+    #   The description of the new WorkSpace image.
+    #
+    # @option params [required, String] :workspace_id
+    #   The identifier of the source WorkSpace
+    #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags that you want to add to the new WorkSpace image. To add tags
+    #   when you're creating the image, you must create an IAM policy that
+    #   grants your IAM user permission to use `workspaces:CreateTags`.
+    #
+    # @return [Types::CreateWorkspaceImageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateWorkspaceImageResult#image_id #image_id} => String
+    #   * {Types::CreateWorkspaceImageResult#name #name} => String
+    #   * {Types::CreateWorkspaceImageResult#description #description} => String
+    #   * {Types::CreateWorkspaceImageResult#operating_system #operating_system} => Types::OperatingSystem
+    #   * {Types::CreateWorkspaceImageResult#state #state} => String
+    #   * {Types::CreateWorkspaceImageResult#required_tenancy #required_tenancy} => String
+    #   * {Types::CreateWorkspaceImageResult#created #created} => Time
+    #   * {Types::CreateWorkspaceImageResult#owner_account_id #owner_account_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_workspace_image({
+    #     name: "WorkspaceImageName", # required
+    #     description: "WorkspaceImageDescription", # required
+    #     workspace_id: "WorkspaceId", # required
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue",
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.image_id #=> String
+    #   resp.name #=> String
+    #   resp.description #=> String
+    #   resp.operating_system.type #=> String, one of "WINDOWS", "LINUX"
+    #   resp.state #=> String, one of "AVAILABLE", "PENDING", "ERROR"
+    #   resp.required_tenancy #=> String, one of "DEFAULT", "DEDICATED"
+    #   resp.created #=> Time
+    #   resp.owner_account_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImage AWS API Documentation
+    #
+    # @overload create_workspace_image(params = {})
+    # @param [Hash] params ({})
+    def create_workspace_image(params = {}, options = {})
+      req = build_request(:create_workspace_image, params)
+      req.send_request(options)
+    end
+
     # Creates one or more WorkSpaces.
     #
     # This operation is asynchronous and returns before the WorkSpaces are
@@ -3296,7 +3357,7 @@ module Aws::WorkSpaces
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workspaces'
-      context[:gem_version] = '1.70.0'
+      context[:gem_version] = '1.71.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -77,6 +77,8 @@ module Aws::WorkSpaces
     CreateUpdatedWorkspaceImageResult = Shapes::StructureShape.new(name: 'CreateUpdatedWorkspaceImageResult')
     CreateWorkspaceBundleRequest = Shapes::StructureShape.new(name: 'CreateWorkspaceBundleRequest')
     CreateWorkspaceBundleResult = Shapes::StructureShape.new(name: 'CreateWorkspaceBundleResult')
+    CreateWorkspaceImageRequest = Shapes::StructureShape.new(name: 'CreateWorkspaceImageRequest')
+    CreateWorkspaceImageResult = Shapes::StructureShape.new(name: 'CreateWorkspaceImageResult')
     CreateWorkspacesRequest = Shapes::StructureShape.new(name: 'CreateWorkspacesRequest')
     CreateWorkspacesResult = Shapes::StructureShape.new(name: 'CreateWorkspacesResult')
     DedicatedTenancyCidrRangeList = Shapes::ListShape.new(name: 'DedicatedTenancyCidrRangeList')
@@ -466,6 +468,22 @@ module Aws::WorkSpaces
     CreateWorkspaceBundleResult.add_member(:workspace_bundle, Shapes::ShapeRef.new(shape: WorkspaceBundle, location_name: "WorkspaceBundle"))
     CreateWorkspaceBundleResult.struct_class = Types::CreateWorkspaceBundleResult
 
+    CreateWorkspaceImageRequest.add_member(:name, Shapes::ShapeRef.new(shape: WorkspaceImageName, required: true, location_name: "Name"))
+    CreateWorkspaceImageRequest.add_member(:description, Shapes::ShapeRef.new(shape: WorkspaceImageDescription, required: true, location_name: "Description"))
+    CreateWorkspaceImageRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "WorkspaceId"))
+    CreateWorkspaceImageRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
+    CreateWorkspaceImageRequest.struct_class = Types::CreateWorkspaceImageRequest
+
+    CreateWorkspaceImageResult.add_member(:image_id, Shapes::ShapeRef.new(shape: WorkspaceImageId, location_name: "ImageId"))
+    CreateWorkspaceImageResult.add_member(:name, Shapes::ShapeRef.new(shape: WorkspaceImageName, location_name: "Name"))
+    CreateWorkspaceImageResult.add_member(:description, Shapes::ShapeRef.new(shape: WorkspaceImageDescription, location_name: "Description"))
+    CreateWorkspaceImageResult.add_member(:operating_system, Shapes::ShapeRef.new(shape: OperatingSystem, location_name: "OperatingSystem"))
+    CreateWorkspaceImageResult.add_member(:state, Shapes::ShapeRef.new(shape: WorkspaceImageState, location_name: "State"))
+    CreateWorkspaceImageResult.add_member(:required_tenancy, Shapes::ShapeRef.new(shape: WorkspaceImageRequiredTenancy, location_name: "RequiredTenancy"))
+    CreateWorkspaceImageResult.add_member(:created, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Created"))
+    CreateWorkspaceImageResult.add_member(:owner_account_id, Shapes::ShapeRef.new(shape: AwsAccount, location_name: "OwnerAccountId"))
+    CreateWorkspaceImageResult.struct_class = Types::CreateWorkspaceImageResult
+
     CreateWorkspacesRequest.add_member(:workspaces, Shapes::ShapeRef.new(shape: WorkspaceRequestList, required: true, location_name: "Workspaces"))
     CreateWorkspacesRequest.struct_class = Types::CreateWorkspacesRequest
 
@@ -1310,6 +1328,21 @@ module Aws::WorkSpaces
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
       end)
 
+      api.add_operation(:create_workspace_image, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CreateWorkspaceImage"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: CreateWorkspaceImageRequest)
+        o.output = Shapes::ShapeRef.new(shape: CreateWorkspaceImageResult)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceLimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: OperationNotSupportedException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidResourceStateException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValuesException)
+      end)
+
       api.add_operation(:create_workspaces, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateWorkspaces"
         o.http_method = "POST"

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

@@ -770,6 +770,104 @@ module Aws::WorkSpaces
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateWorkspaceImageRequest
+    #   data as a hash:
+    #
+    #       {
+    #         name: "WorkspaceImageName", # required
+    #         description: "WorkspaceImageDescription", # required
+    #         workspace_id: "WorkspaceId", # required
+    #         tags: [
+    #           {
+    #             key: "TagKey", # required
+    #             value: "TagValue",
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] name
+    #   The name of the new WorkSpace image.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The description of the new WorkSpace image.
+    #   @return [String]
+    #
+    # @!attribute [rw] workspace_id
+    #   The identifier of the source WorkSpace
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   The tags that you want to add to the new WorkSpace image. To add
+    #   tags when you're creating the image, you must create an IAM policy
+    #   that grants your IAM user permission to use `workspaces:CreateTags`.
+    #   @return [Array<Types::Tag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImageRequest AWS API Documentation
+    #
+    class CreateWorkspaceImageRequest < Struct.new(
+      :name,
+      :description,
+      :workspace_id,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] image_id
+    #   The identifier of the new WorkSpace image.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the image.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The description of the image.
+    #   @return [String]
+    #
+    # @!attribute [rw] operating_system
+    #   The operating system that the image is running.
+    #   @return [Types::OperatingSystem]
+    #
+    # @!attribute [rw] state
+    #   The availability status of the image.
+    #   @return [String]
+    #
+    # @!attribute [rw] required_tenancy
+    #   Specifies whether the image is running on dedicated hardware. When
+    #   Bring Your Own License (BYOL) is enabled, this value is set to
+    #   DEDICATED. For more information, see [ Bring Your Own Windows
+    #   Desktop Images.][1]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm
+    #   @return [String]
+    #
+    # @!attribute [rw] created
+    #   The date when the image was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] owner_account_id
+    #   The identifier of the AWS account that owns the image.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImageResult AWS API Documentation
+    #
+    class CreateWorkspaceImageResult < Struct.new(
+      :image_id,
+      :name,
+      :description,
+      :operating_system,
+      :state,
+      :required_tenancy,
+      :created,
+      :owner_account_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateWorkspacesRequest
     #   data as a hash:
     #
@@ -840,7 +938,7 @@ module Aws::WorkSpaces
     # include sensitive information.
     #
     # @!attribute [rw] logo_url
-    #   The logo URL. The only image format accepted is a binary data object
+    #   The logo. The only image format accepted is a binary data object
     #   that is converted from a `.png` file.
     #   @return [String]
     #
@@ -877,7 +975,10 @@ module Aws::WorkSpaces
     # @!attribute [rw] login_message
     #   The login message. Specified as a key value pair, in which the key
     #   is a locale and the value is the localized message for that locale.
-    #   The only key supported is `en_US`.
+    #   The only key supported is `en_US`. The HTML tags supported include
+    #   the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
+    #   em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
+    #   ul`.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultClientBrandingAttributes AWS API Documentation
@@ -949,7 +1050,10 @@ module Aws::WorkSpaces
     # @!attribute [rw] login_message
     #   The login message. Specified as a key value pair, in which the key
     #   is a locale and the value is the localized message for that locale.
-    #   The only key supported is `en_US`.
+    #   The only key supported is `en_US`. The HTML tags supported include
+    #   the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
+    #   em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
+    #   ul`.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultImportClientBrandingAttributes AWS API Documentation
@@ -2490,7 +2594,10 @@ module Aws::WorkSpaces
     # @!attribute [rw] login_message
     #   The login message. Specified as a key value pair, in which the key
     #   is a locale and the value is the localized message for that locale.
-    #   The only key supported is `en_US`.
+    #   The only key supported is `en_US`. The HTML tags supported include
+    #   the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
+    #   em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
+    #   ul`.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/IosClientBrandingAttributes AWS API Documentation
@@ -2600,7 +2707,10 @@ module Aws::WorkSpaces
     # @!attribute [rw] login_message
     #   The login message. Specified as a key value pair, in which the key
     #   is a locale and the value is the localized message for that locale.
-    #   The only key supported is `en_US`.
+    #   The only key supported is `en_US`. The HTML tags supported include
+    #   the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
+    #   em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
+    #   ul`.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/IosImportClientBrandingAttributes AWS API Documentation

data/lib/aws-sdk-workspaces.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-workspaces/customizations'
 # @!group service
 module Aws::WorkSpaces
 
-  GEM_VERSION = '1.70.0'
+  GEM_VERSION = '1.71.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-workspaces
 version: !ruby/object:Gem::Version
-  version: 1.70.0
+  version: 1.71.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core