aws-sdk-workspaces 1.71.0 → 1.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 250a357bcddb89710d7544d0bf729d75a7da0d5f3bee68e0607ea7ea2e6f14a8
-  data.tar.gz: d99d78683667cfc5013683b507cab6d8074a7cf26c12d7098f039e3c9341a9db
+  metadata.gz: 2c91c7db4285863209bd00670cc0fd06d75166350bfb09ff4fc2c541f7e060b3
+  data.tar.gz: 4844ade3c37b6fbaf184a5268bdabb2fb2dea0cec1dcaf44f9c44a0f9fe6d4b2
 SHA512:
-  metadata.gz: 4b01fe5fe35b8b882bfadd8c67c2ee481b78e44284fcbe0e00cb689bfd9daf379eb9a509d955c978664fd25b7dc690113db6649b48288ee3092a58b45b478849
-  data.tar.gz: a519b09ce7aa758563fb065c4cce78a0175ae94205f11696307773627a3dee061ed5a53f2cf58e54af6bc6666a4e87a17cf98662edff010dc86f445382c003e9
+  metadata.gz: 2a7b0339c0538fa6ac5533054e4e2496807c11b51ead7aed9e55c62895fbcae5c8ba858e2f7af291c062f5bb5e9f83049d8876ca3201ff2fe9fecbb984876954
+  data.tar.gz: c94915077d8b24ae8086291a670967de543c63d0bbdb8393bd39ba3052a7f0d50de10d825275eaf49f3fa1c7f2ef7520f95a1f794d94c513e123ce036b54936e

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.72.0 (2022-08-01)
+------------------
+
+* Feature - This release introduces ModifySamlProperties, a new API that allows control of SAML properties associated with a WorkSpaces directory. The DescribeWorkspaceDirectories API will now additionally return SAML properties in its responses.
+
 1.71.0 (2022-07-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.71.0
+1.72.0

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

@@ -1817,6 +1817,9 @@ module Aws::WorkSpaces
     #   resp.directories[0].selfservice_permissions.change_compute_type #=> String, one of "ENABLED", "DISABLED"
     #   resp.directories[0].selfservice_permissions.switch_running_mode #=> String, one of "ENABLED", "DISABLED"
     #   resp.directories[0].selfservice_permissions.rebuild_workspace #=> String, one of "ENABLED", "DISABLED"
+    #   resp.directories[0].saml_properties.status #=> String, one of "DISABLED", "ENABLED", "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK"
+    #   resp.directories[0].saml_properties.user_access_url #=> String
+    #   resp.directories[0].saml_properties.relay_state_parameter_name #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories AWS API Documentation
@@ -2561,6 +2564,51 @@ module Aws::WorkSpaces
       req.send_request(options)
     end
 
+    # Modifies multiple properties related to SAML 2.0 authentication,
+    # including the enablement status, user access URL, and relay state
+    # parameter name that are used for configuring federation with an SAML
+    # 2.0 identity provider.
+    #
+    # @option params [required, String] :resource_id
+    #   The directory identifier for which you want to configure SAML
+    #   properties.
+    #
+    # @option params [Types::SamlProperties] :saml_properties
+    #   The properties for configuring SAML 2.0 authentication.
+    #
+    # @option params [Array<String>] :properties_to_delete
+    #   The SAML properties to delete as part of your request.
+    #
+    #   Specify one of the following options:
+    #
+    #   * `SAML_PROPERTIES_USER_ACCESS_URL` to delete the user access URL.
+    #
+    #   * `SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME` to delete the relay
+    #     state parameter name.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.modify_saml_properties({
+    #     resource_id: "DirectoryId", # required
+    #     saml_properties: {
+    #       status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
+    #       user_access_url: "SamlUserAccessUrl",
+    #       relay_state_parameter_name: "NonEmptyString",
+    #     },
+    #     properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties AWS API Documentation
+    #
+    # @overload modify_saml_properties(params = {})
+    # @param [Hash] params ({})
+    def modify_saml_properties(params = {}, options = {})
+      req = build_request(:modify_saml_properties, params)
+      req.send_request(options)
+    end
+
     # Modifies the self-service WorkSpace management capabilities for your
     # users. For more information, see [Enable Self-Service WorkSpace
     # Management Capabilities for Your Users][1].
@@ -3357,7 +3405,7 @@ module Aws::WorkSpaces
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workspaces'
-      context[:gem_version] = '1.71.0'
+      context[:gem_version] = '1.72.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -91,6 +91,8 @@ module Aws::WorkSpaces
     DefaultLogo = Shapes::BlobShape.new(name: 'DefaultLogo')
     DefaultOu = Shapes::StringShape.new(name: 'DefaultOu')
     DefaultWorkspaceCreationProperties = Shapes::StructureShape.new(name: 'DefaultWorkspaceCreationProperties')
+    DeletableSamlPropertiesList = Shapes::ListShape.new(name: 'DeletableSamlPropertiesList')
+    DeletableSamlProperty = Shapes::StringShape.new(name: 'DeletableSamlProperty')
     DeleteClientBrandingRequest = Shapes::StructureShape.new(name: 'DeleteClientBrandingRequest')
     DeleteClientBrandingResult = Shapes::StructureShape.new(name: 'DeleteClientBrandingResult')
     DeleteConnectClientAddInRequest = Shapes::StructureShape.new(name: 'DeleteConnectClientAddInRequest')
@@ -201,6 +203,8 @@ module Aws::WorkSpaces
     ModifyAccountResult = Shapes::StructureShape.new(name: 'ModifyAccountResult')
     ModifyClientPropertiesRequest = Shapes::StructureShape.new(name: 'ModifyClientPropertiesRequest')
     ModifyClientPropertiesResult = Shapes::StructureShape.new(name: 'ModifyClientPropertiesResult')
+    ModifySamlPropertiesRequest = Shapes::StructureShape.new(name: 'ModifySamlPropertiesRequest')
+    ModifySamlPropertiesResult = Shapes::StructureShape.new(name: 'ModifySamlPropertiesResult')
     ModifySelfservicePermissionsRequest = Shapes::StructureShape.new(name: 'ModifySelfservicePermissionsRequest')
     ModifySelfservicePermissionsResult = Shapes::StructureShape.new(name: 'ModifySelfservicePermissionsResult')
     ModifyWorkspaceAccessPropertiesRequest = Shapes::StructureShape.new(name: 'ModifyWorkspaceAccessPropertiesRequest')
@@ -245,6 +249,9 @@ module Aws::WorkSpaces
     RootVolumeSizeGib = Shapes::IntegerShape.new(name: 'RootVolumeSizeGib')
     RunningMode = Shapes::StringShape.new(name: 'RunningMode')
     RunningModeAutoStopTimeoutInMinutes = Shapes::IntegerShape.new(name: 'RunningModeAutoStopTimeoutInMinutes')
+    SamlProperties = Shapes::StructureShape.new(name: 'SamlProperties')
+    SamlStatusEnum = Shapes::StringShape.new(name: 'SamlStatusEnum')
+    SamlUserAccessUrl = Shapes::StringShape.new(name: 'SamlUserAccessUrl')
     SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
     SelfservicePermissions = Shapes::StructureShape.new(name: 'SelfservicePermissions')
     Snapshot = Shapes::StructureShape.new(name: 'Snapshot')
@@ -515,6 +522,8 @@ module Aws::WorkSpaces
     DefaultWorkspaceCreationProperties.add_member(:enable_maintenance_mode, Shapes::ShapeRef.new(shape: BooleanObject, location_name: "EnableMaintenanceMode"))
     DefaultWorkspaceCreationProperties.struct_class = Types::DefaultWorkspaceCreationProperties
 
+    DeletableSamlPropertiesList.member = Shapes::ShapeRef.new(shape: DeletableSamlProperty)
+
     DeleteClientBrandingRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
     DeleteClientBrandingRequest.add_member(:platforms, Shapes::ShapeRef.new(shape: ClientDeviceTypeList, required: true, location_name: "Platforms"))
     DeleteClientBrandingRequest.struct_class = Types::DeleteClientBrandingRequest
@@ -841,6 +850,13 @@ module Aws::WorkSpaces
 
     ModifyClientPropertiesResult.struct_class = Types::ModifyClientPropertiesResult
 
+    ModifySamlPropertiesRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
+    ModifySamlPropertiesRequest.add_member(:saml_properties, Shapes::ShapeRef.new(shape: SamlProperties, location_name: "SamlProperties"))
+    ModifySamlPropertiesRequest.add_member(:properties_to_delete, Shapes::ShapeRef.new(shape: DeletableSamlPropertiesList, location_name: "PropertiesToDelete"))
+    ModifySamlPropertiesRequest.struct_class = Types::ModifySamlPropertiesRequest
+
+    ModifySamlPropertiesResult.struct_class = Types::ModifySamlPropertiesResult
+
     ModifySelfservicePermissionsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
     ModifySelfservicePermissionsRequest.add_member(:selfservice_permissions, Shapes::ShapeRef.new(shape: SelfservicePermissions, required: true, location_name: "SelfservicePermissions"))
     ModifySelfservicePermissionsRequest.struct_class = Types::ModifySelfservicePermissionsRequest
@@ -949,6 +965,11 @@ module Aws::WorkSpaces
     RootStorage.add_member(:capacity, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Capacity"))
     RootStorage.struct_class = Types::RootStorage
 
+    SamlProperties.add_member(:status, Shapes::ShapeRef.new(shape: SamlStatusEnum, location_name: "Status"))
+    SamlProperties.add_member(:user_access_url, Shapes::ShapeRef.new(shape: SamlUserAccessUrl, location_name: "UserAccessUrl"))
+    SamlProperties.add_member(:relay_state_parameter_name, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "RelayStateParameterName"))
+    SamlProperties.struct_class = Types::SamlProperties
+
     SelfservicePermissions.add_member(:restart_workspace, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "RestartWorkspace"))
     SelfservicePermissions.add_member(:increase_volume_size, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "IncreaseVolumeSize"))
     SelfservicePermissions.add_member(:change_compute_type, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "ChangeComputeType"))
@@ -1121,6 +1142,7 @@ module Aws::WorkSpaces
     WorkspaceDirectory.add_member(:workspace_access_properties, Shapes::ShapeRef.new(shape: WorkspaceAccessProperties, location_name: "WorkspaceAccessProperties"))
     WorkspaceDirectory.add_member(:tenancy, Shapes::ShapeRef.new(shape: Tenancy, location_name: "Tenancy"))
     WorkspaceDirectory.add_member(:selfservice_permissions, Shapes::ShapeRef.new(shape: SelfservicePermissions, location_name: "SelfservicePermissions"))
+    WorkspaceDirectory.add_member(:saml_properties, Shapes::ShapeRef.new(shape: SamlProperties, location_name: "SamlProperties"))
     WorkspaceDirectory.struct_class = Types::WorkspaceDirectory
 
     WorkspaceIdList.member = Shapes::ShapeRef.new(shape: WorkspaceId)
@@ -1723,6 +1745,18 @@ module Aws::WorkSpaces
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
       end)
 
+      api.add_operation(:modify_saml_properties, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ModifySamlProperties"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ModifySamlPropertiesRequest)
+        o.output = Shapes::ShapeRef.new(shape: ModifySamlPropertiesResult)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValuesException)
+        o.errors << Shapes::ShapeRef.new(shape: OperationNotSupportedException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:modify_selfservice_permissions, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ModifySelfservicePermissions"
         o.http_method = "POST"

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

@@ -2936,6 +2936,53 @@ module Aws::WorkSpaces
     #
     class ModifyClientPropertiesResult < Aws::EmptyStructure; end
 
+    # @note When making an API call, you may pass ModifySamlPropertiesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_id: "DirectoryId", # required
+    #         saml_properties: {
+    #           status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
+    #           user_access_url: "SamlUserAccessUrl",
+    #           relay_state_parameter_name: "NonEmptyString",
+    #         },
+    #         properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
+    #       }
+    #
+    # @!attribute [rw] resource_id
+    #   The directory identifier for which you want to configure SAML
+    #   properties.
+    #   @return [String]
+    #
+    # @!attribute [rw] saml_properties
+    #   The properties for configuring SAML 2.0 authentication.
+    #   @return [Types::SamlProperties]
+    #
+    # @!attribute [rw] properties_to_delete
+    #   The SAML properties to delete as part of your request.
+    #
+    #   Specify one of the following options:
+    #
+    #   * `SAML_PROPERTIES_USER_ACCESS_URL` to delete the user access URL.
+    #
+    #   * `SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME` to delete the relay
+    #     state parameter name.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlPropertiesRequest AWS API Documentation
+    #
+    class ModifySamlPropertiesRequest < Struct.new(
+      :resource_id,
+      :saml_properties,
+      :properties_to_delete)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlPropertiesResult AWS API Documentation
+    #
+    class ModifySamlPropertiesResult < Aws::EmptyStructure; end
+
     # @note When making an API call, you may pass ModifySelfservicePermissionsRequest
     #   data as a hash:
     #
@@ -3515,6 +3562,68 @@ module Aws::WorkSpaces
       include Aws::Structure
     end
 
+    # Describes the enablement status, user access URL, and relay state
+    # parameter name that are used for configuring federation with an SAML
+    # 2.0 identity provider.
+    #
+    # @note When making an API call, you may pass SamlProperties
+    #   data as a hash:
+    #
+    #       {
+    #         status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
+    #         user_access_url: "SamlUserAccessUrl",
+    #         relay_state_parameter_name: "NonEmptyString",
+    #       }
+    #
+    # @!attribute [rw] status
+    #   Indicates the status of SAML 2.0 authentication. These statuses
+    #   include the following.
+    #
+    #   * If the setting is `DISABLED`, end users will be directed to login
+    #     with their directory credentials.
+    #
+    #   * If the setting is `ENABLED`, end users will be directed to login
+    #     via the user access URL. Users attempting to connect to WorkSpaces
+    #     from a client application that does not support SAML 2.0
+    #     authentication will not be able to connect.
+    #
+    #   * If the setting is `ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK`, end
+    #     users will be directed to login via the user access URL on
+    #     supported client applications, but will not prevent clients that
+    #     do not support SAML 2.0 authentication from connecting as if SAML
+    #     2.0 authentication was disabled.
+    #   @return [String]
+    #
+    # @!attribute [rw] user_access_url
+    #   The SAML 2.0 identity provider (IdP) user access URL is the URL a
+    #   user would navigate to in their web browser in order to federate
+    #   from the IdP and directly access the application, without any SAML
+    #   2.0 service provider (SP) bindings.
+    #   @return [String]
+    #
+    # @!attribute [rw] relay_state_parameter_name
+    #   The relay state parameter name supported by the SAML 2.0 identity
+    #   provider (IdP). When the end user is redirected to the user access
+    #   URL from the WorkSpaces client application, this relay state
+    #   parameter name is appended as a query parameter to the URL along
+    #   with the relay state endpoint to return the user to the client
+    #   application session.
+    #
+    #   To use SAML 2.0 authentication with WorkSpaces, the IdP must support
+    #   IdP-initiated deep linking for the relay state URL. Consult your IdP
+    #   documentation for more information.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/SamlProperties AWS API Documentation
+    #
+    class SamlProperties < Struct.new(
+      :status,
+      :user_access_url,
+      :relay_state_parameter_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Describes the self-service permissions for a directory. For more
     # information, see [Enable Self-Service WorkSpace Management
     # Capabilities for Your Users][1].
@@ -4510,6 +4619,12 @@ module Aws::WorkSpaces
     #   directory.
     #   @return [Types::SelfservicePermissions]
     #
+    # @!attribute [rw] saml_properties
+    #   Describes the enablement status, user access URL, and relay state
+    #   parameter name that are used for configuring federation with an SAML
+    #   2.0 identity provider.
+    #   @return [Types::SamlProperties]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation
     #
     class WorkspaceDirectory < Struct.new(
@@ -4528,7 +4643,8 @@ module Aws::WorkSpaces
       :ip_group_ids,
       :workspace_access_properties,
       :tenancy,
-      :selfservice_permissions)
+      :selfservice_permissions,
+      :saml_properties)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-workspaces.rb

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

metadata

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