aws-sdk-workspacesweb 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54fc0ae897c2eebb926f8ca0f6b69a3e3f33b09e3139f93a538cf6c79de28bef
-  data.tar.gz: 8e7cd3de12440dc6177f7ab7613d286610a13b958e8ac6fca0ea327a17d3eec5
+  metadata.gz: 6021725633ca1ae7c1dc0358fe31b6a965eaec819fdf053a0d83bc9c48133b5d
+  data.tar.gz: a799380337e166bf117ae751848eca7539f78df05376c663a20d5f5b1a1e294e
 SHA512:
-  metadata.gz: '060158e29996b3ad005442d98cade613a1d45cd509a3fca66c96e67b8d34d50aeb9ae5cac558cf2b1be7c22320f7cfc563da7c44a989732f6fa0e1dbd76a24b4'
-  data.tar.gz: e5b1ad2935253be926260e636db59042acf66d0e5f5dd3fa20fa759a8f6091c425b7639111775b76be62b2b2b1ed253e3ef622606b685ad6076345479128e076
+  metadata.gz: 7085df3083c3c0fd45626d4e6c8a5920fdb151448405812b166d61694abec15638875d89c983e285135bf8237c482d1c5de0ca99131108015df1be43f71e57c8
+  data.tar.gz: f57117619ab604960798114f78e8b0f86b4e82e33a66950d95e63f07d94bb27952fbcc044e6c21ecceabe14121a56df44030fbee30638105f21dc53469e1988d

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.5.0 (2022-10-19)
+------------------
+
+* Feature - WorkSpaces Web now supports user access logging for recording session start, stop, and URL navigation.
+
+1.4.0 (2022-05-16)
+------------------
+
+* Feature - Amazon WorkSpaces Web now supports Administrator timeout control
+
 1.3.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.5.0

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

@@ -453,6 +453,40 @@ module Aws::WorkSpacesWeb
       req.send_request(options)
     end
 
+    # Associates a user access logging settings resource with a web portal.
+    #
+    # @option params [required, String] :portal_arn
+    #   The ARN of the web portal.
+    #
+    # @option params [required, String] :user_access_logging_settings_arn
+    #   The ARN of the user access logging settings.
+    #
+    # @return [Types::AssociateUserAccessLoggingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::AssociateUserAccessLoggingSettingsResponse#portal_arn #portal_arn} => String
+    #   * {Types::AssociateUserAccessLoggingSettingsResponse#user_access_logging_settings_arn #user_access_logging_settings_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.associate_user_access_logging_settings({
+    #     portal_arn: "ARN", # required
+    #     user_access_logging_settings_arn: "ARN", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.portal_arn #=> String
+    #   resp.user_access_logging_settings_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateUserAccessLoggingSettings AWS API Documentation
+    #
+    # @overload associate_user_access_logging_settings(params = {})
+    # @param [Hash] params ({})
+    def associate_user_access_logging_settings(params = {}, options = {})
+      req = build_request(:associate_user_access_logging_settings, params)
+      req.send_request(options)
+    end
+
     # Associates a user settings resource with a web portal.
     #
     # @option params [required, String] :portal_arn
@@ -631,7 +665,7 @@ module Aws::WorkSpacesWeb
     #
     #     * `MetadataFile` OR `MetadataURL`
     #
-    #     * `IDPSignout` *optional*
+    #     * `IDPSignout` (boolean) *optional*
     #
     # @option params [required, String] :identity_provider_name
     #   The identity provider name.
@@ -857,6 +891,59 @@ module Aws::WorkSpacesWeb
       req.send_request(options)
     end
 
+    # Creates a user access logging settings resource that can be associated
+    # with a web portal.
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request. Idempotency ensures that an API request
+    #   completes only once. With an idempotent request, if the original
+    #   request completes successfully, subsequent retries with the same
+    #   client token returns the result from the original successful request.
+    #
+    #   If you do not specify a client token, one is automatically generated
+    #   by the AWS SDK.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [required, String] :kinesis_stream_arn
+    #   The ARN of the Kinesis stream.
+    #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags to add to the user settings resource. A tag is a key-value
+    #   pair.
+    #
+    # @return [Types::CreateUserAccessLoggingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateUserAccessLoggingSettingsResponse#user_access_logging_settings_arn #user_access_logging_settings_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_user_access_logging_settings({
+    #     client_token: "ClientToken",
+    #     kinesis_stream_arn: "KinesisStreamArn", # required
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.user_access_logging_settings_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateUserAccessLoggingSettings AWS API Documentation
+    #
+    # @overload create_user_access_logging_settings(params = {})
+    # @param [Hash] params ({})
+    def create_user_access_logging_settings(params = {}, options = {})
+      req = build_request(:create_user_access_logging_settings, params)
+      req.send_request(options)
+    end
+
     # Creates a user settings resource that can be associated with a web
     # portal. Once associated with a web portal, user settings control how
     # users can transfer data between a streaming session and the their
@@ -879,10 +966,19 @@ module Aws::WorkSpacesWeb
     #   Specifies whether the user can copy text from the streaming session to
     #   the local device.
     #
+    # @option params [Integer] :disconnect_timeout_in_minutes
+    #   The amount of time that a streaming session remains active after users
+    #   disconnect.
+    #
     # @option params [required, String] :download_allowed
     #   Specifies whether the user can download files from the streaming
     #   session to the local device.
     #
+    # @option params [Integer] :idle_disconnect_timeout_in_minutes
+    #   The amount of time that users can be idle (inactive) before they are
+    #   disconnected from their streaming session and the disconnect timeout
+    #   interval begins.
+    #
     # @option params [required, String] :paste_allowed
     #   Specifies whether the user can paste text from the local device to the
     #   streaming session.
@@ -907,7 +1003,9 @@ module Aws::WorkSpacesWeb
     #   resp = client.create_user_settings({
     #     client_token: "ClientToken",
     #     copy_allowed: "Disabled", # required, accepts Disabled, Enabled
+    #     disconnect_timeout_in_minutes: 1,
     #     download_allowed: "Disabled", # required, accepts Disabled, Enabled
+    #     idle_disconnect_timeout_in_minutes: 1,
     #     paste_allowed: "Disabled", # required, accepts Disabled, Enabled
     #     print_allowed: "Disabled", # required, accepts Disabled, Enabled
     #     tags: [
@@ -1042,6 +1140,28 @@ module Aws::WorkSpacesWeb
       req.send_request(options)
     end
 
+    # Deletes user access logging settings.
+    #
+    # @option params [required, String] :user_access_logging_settings_arn
+    #   The ARN of the user access logging settings.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_user_access_logging_settings({
+    #     user_access_logging_settings_arn: "ARN", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteUserAccessLoggingSettings AWS API Documentation
+    #
+    # @overload delete_user_access_logging_settings(params = {})
+    # @param [Hash] params ({})
+    def delete_user_access_logging_settings(params = {}, options = {})
+      req = build_request(:delete_user_access_logging_settings, params)
+      req.send_request(options)
+    end
+
     # Deletes user settings.
     #
     # @option params [required, String] :user_settings_arn
@@ -1130,6 +1250,28 @@ module Aws::WorkSpacesWeb
       req.send_request(options)
     end
 
+    # Disassociates user access logging settings from a web portal.
+    #
+    # @option params [required, String] :portal_arn
+    #   The ARN of the web portal.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.disassociate_user_access_logging_settings({
+    #     portal_arn: "ARN", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateUserAccessLoggingSettings AWS API Documentation
+    #
+    # @overload disassociate_user_access_logging_settings(params = {})
+    # @param [Hash] params ({})
+    def disassociate_user_access_logging_settings(params = {}, options = {})
+      req = build_request(:disassociate_user_access_logging_settings, params)
+      req.send_request(options)
+    end
+
     # Disassociates user settings from a web portal.
     #
     # @option params [required, String] :portal_arn
@@ -1278,6 +1420,7 @@ module Aws::WorkSpacesWeb
     #   resp.portal.renderer_type #=> String, one of "AppStream"
     #   resp.portal.status_reason #=> String
     #   resp.portal.trust_store_arn #=> String
+    #   resp.portal.user_access_logging_settings_arn #=> String
     #   resp.portal.user_settings_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetPortal AWS API Documentation
@@ -1388,6 +1531,37 @@ module Aws::WorkSpacesWeb
       req.send_request(options)
     end
 
+    # Gets user access logging settings.
+    #
+    # @option params [required, String] :user_access_logging_settings_arn
+    #   The ARN of the user access logging settings.
+    #
+    # @return [Types::GetUserAccessLoggingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetUserAccessLoggingSettingsResponse#user_access_logging_settings #user_access_logging_settings} => Types::UserAccessLoggingSettings
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_user_access_logging_settings({
+    #     user_access_logging_settings_arn: "ARN", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.user_access_logging_settings.associated_portal_arns #=> Array
+    #   resp.user_access_logging_settings.associated_portal_arns[0] #=> String
+    #   resp.user_access_logging_settings.kinesis_stream_arn #=> String
+    #   resp.user_access_logging_settings.user_access_logging_settings_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetUserAccessLoggingSettings AWS API Documentation
+    #
+    # @overload get_user_access_logging_settings(params = {})
+    # @param [Hash] params ({})
+    def get_user_access_logging_settings(params = {}, options = {})
+      req = build_request(:get_user_access_logging_settings, params)
+      req.send_request(options)
+    end
+
     # Gets user settings.
     #
     # @option params [required, String] :user_settings_arn
@@ -1408,7 +1582,9 @@ module Aws::WorkSpacesWeb
     #   resp.user_settings.associated_portal_arns #=> Array
     #   resp.user_settings.associated_portal_arns[0] #=> String
     #   resp.user_settings.copy_allowed #=> String, one of "Disabled", "Enabled"
+    #   resp.user_settings.disconnect_timeout_in_minutes #=> Integer
     #   resp.user_settings.download_allowed #=> String, one of "Disabled", "Enabled"
+    #   resp.user_settings.idle_disconnect_timeout_in_minutes #=> Integer
     #   resp.user_settings.paste_allowed #=> String, one of "Disabled", "Enabled"
     #   resp.user_settings.print_allowed #=> String, one of "Disabled", "Enabled"
     #   resp.user_settings.upload_allowed #=> String, one of "Disabled", "Enabled"
@@ -1581,6 +1757,7 @@ module Aws::WorkSpacesWeb
     #   resp.portals[0].portal_status #=> String, one of "Incomplete", "Pending", "Active"
     #   resp.portals[0].renderer_type #=> String, one of "AppStream"
     #   resp.portals[0].trust_store_arn #=> String
+    #   resp.portals[0].user_access_logging_settings_arn #=> String
     #   resp.portals[0].user_settings_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListPortals AWS API Documentation
@@ -1708,6 +1885,45 @@ module Aws::WorkSpacesWeb
       req.send_request(options)
     end
 
+    # Retrieves a list of user access logging settings.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to be included in the next page.
+    #
+    # @option params [String] :next_token
+    #   The pagination token used to retrieve the next page of results for
+    #   this operation.
+    #
+    # @return [Types::ListUserAccessLoggingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListUserAccessLoggingSettingsResponse#next_token #next_token} => String
+    #   * {Types::ListUserAccessLoggingSettingsResponse#user_access_logging_settings #user_access_logging_settings} => Array&lt;Types::UserAccessLoggingSettingsSummary&gt;
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_user_access_logging_settings({
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.user_access_logging_settings #=> Array
+    #   resp.user_access_logging_settings[0].kinesis_stream_arn #=> String
+    #   resp.user_access_logging_settings[0].user_access_logging_settings_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListUserAccessLoggingSettings AWS API Documentation
+    #
+    # @overload list_user_access_logging_settings(params = {})
+    # @param [Hash] params ({})
+    def list_user_access_logging_settings(params = {}, options = {})
+      req = build_request(:list_user_access_logging_settings, params)
+      req.send_request(options)
+    end
+
     # Retrieves a list of user settings.
     #
     # @option params [Integer] :max_results
@@ -1736,7 +1952,9 @@ module Aws::WorkSpacesWeb
     #   resp.next_token #=> String
     #   resp.user_settings #=> Array
     #   resp.user_settings[0].copy_allowed #=> String, one of "Disabled", "Enabled"
+    #   resp.user_settings[0].disconnect_timeout_in_minutes #=> Integer
     #   resp.user_settings[0].download_allowed #=> String, one of "Disabled", "Enabled"
+    #   resp.user_settings[0].idle_disconnect_timeout_in_minutes #=> Integer
     #   resp.user_settings[0].paste_allowed #=> String, one of "Disabled", "Enabled"
     #   resp.user_settings[0].print_allowed #=> String, one of "Disabled", "Enabled"
     #   resp.user_settings[0].upload_allowed #=> String, one of "Disabled", "Enabled"
@@ -1891,7 +2109,68 @@ module Aws::WorkSpacesWeb
     #   The ARN of the identity provider.
     #
     # @option params [Hash<String,String>] :identity_provider_details
-    #   The details of the identity provider.
+    #   The details of the identity provider. The following list describes the
+    #   provider detail keys for each identity provider type.
+    #
+    #   * For Google and Login with Amazon:
+    #
+    #     * `client_id`
+    #
+    #     * `client_secret`
+    #
+    #     * `authorize_scopes`
+    #
+    #   * For Facebook:
+    #
+    #     * `client_id`
+    #
+    #     * `client_secret`
+    #
+    #     * `authorize_scopes`
+    #
+    #     * `api_version`
+    #
+    #   * For Sign in with Apple:
+    #
+    #     * `client_id`
+    #
+    #     * `team_id`
+    #
+    #     * `key_id`
+    #
+    #     * `private_key`
+    #
+    #     * `authorize_scopes`
+    #
+    #   * For OIDC providers:
+    #
+    #     * `client_id`
+    #
+    #     * `client_secret`
+    #
+    #     * `attributes_request_method`
+    #
+    #     * `oidc_issuer`
+    #
+    #     * `authorize_scopes`
+    #
+    #     * `authorize_url` *if not available from discovery URL specified by
+    #       `oidc_issuer` key*
+    #
+    #     * `token_url` *if not available from discovery URL specified by
+    #       `oidc_issuer` key*
+    #
+    #     * `attributes_url` *if not available from discovery URL specified by
+    #       `oidc_issuer` key*
+    #
+    #     * `jwks_uri` *if not available from discovery URL specified by
+    #       `oidc_issuer` key*
+    #
+    #   * For SAML providers:
+    #
+    #     * `MetadataFile` OR `MetadataURL`
+    #
+    #     * `IDPSignout` (boolean) *optional*
     #
     # @option params [String] :identity_provider_name
     #   The name of the identity provider.
@@ -2029,6 +2308,7 @@ module Aws::WorkSpacesWeb
     #   resp.portal.renderer_type #=> String, one of "AppStream"
     #   resp.portal.status_reason #=> String
     #   resp.portal.trust_store_arn #=> String
+    #   resp.portal.user_access_logging_settings_arn #=> String
     #   resp.portal.user_settings_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdatePortal AWS API Documentation
@@ -2090,6 +2370,55 @@ module Aws::WorkSpacesWeb
       req.send_request(options)
     end
 
+    # Updates the user access logging settings.
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request. Idempotency ensures that an API request
+    #   completes only once. With an idempotent request, if the original
+    #   request completes successfully, subsequent retries with the same
+    #   client token return the result from the original successful request.
+    #
+    #   If you do not specify a client token, one is automatically generated
+    #   by the AWS SDK.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [String] :kinesis_stream_arn
+    #   The ARN of the Kinesis stream.
+    #
+    # @option params [required, String] :user_access_logging_settings_arn
+    #   The ARN of the user access logging settings.
+    #
+    # @return [Types::UpdateUserAccessLoggingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateUserAccessLoggingSettingsResponse#user_access_logging_settings #user_access_logging_settings} => Types::UserAccessLoggingSettings
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_user_access_logging_settings({
+    #     client_token: "ClientToken",
+    #     kinesis_stream_arn: "KinesisStreamArn",
+    #     user_access_logging_settings_arn: "ARN", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.user_access_logging_settings.associated_portal_arns #=> Array
+    #   resp.user_access_logging_settings.associated_portal_arns[0] #=> String
+    #   resp.user_access_logging_settings.kinesis_stream_arn #=> String
+    #   resp.user_access_logging_settings.user_access_logging_settings_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserAccessLoggingSettings AWS API Documentation
+    #
+    # @overload update_user_access_logging_settings(params = {})
+    # @param [Hash] params ({})
+    def update_user_access_logging_settings(params = {}, options = {})
+      req = build_request(:update_user_access_logging_settings, params)
+      req.send_request(options)
+    end
+
     # Updates the user settings.
     #
     # @option params [String] :client_token
@@ -2109,10 +2438,19 @@ module Aws::WorkSpacesWeb
     #   Specifies whether the user can copy text from the streaming session to
     #   the local device.
     #
+    # @option params [Integer] :disconnect_timeout_in_minutes
+    #   The amount of time that a streaming session remains active after users
+    #   disconnect.
+    #
     # @option params [String] :download_allowed
     #   Specifies whether the user can download files from the streaming
     #   session to the local device.
     #
+    # @option params [Integer] :idle_disconnect_timeout_in_minutes
+    #   The amount of time that users can be idle (inactive) before they are
+    #   disconnected from their streaming session and the disconnect timeout
+    #   interval begins.
+    #
     # @option params [String] :paste_allowed
     #   Specifies whether the user can paste text from the local device to the
     #   streaming session.
@@ -2136,7 +2474,9 @@ module Aws::WorkSpacesWeb
     #   resp = client.update_user_settings({
     #     client_token: "ClientToken",
     #     copy_allowed: "Disabled", # accepts Disabled, Enabled
+    #     disconnect_timeout_in_minutes: 1,
     #     download_allowed: "Disabled", # accepts Disabled, Enabled
+    #     idle_disconnect_timeout_in_minutes: 1,
     #     paste_allowed: "Disabled", # accepts Disabled, Enabled
     #     print_allowed: "Disabled", # accepts Disabled, Enabled
     #     upload_allowed: "Disabled", # accepts Disabled, Enabled
@@ -2148,7 +2488,9 @@ module Aws::WorkSpacesWeb
     #   resp.user_settings.associated_portal_arns #=> Array
     #   resp.user_settings.associated_portal_arns[0] #=> String
     #   resp.user_settings.copy_allowed #=> String, one of "Disabled", "Enabled"
+    #   resp.user_settings.disconnect_timeout_in_minutes #=> Integer
     #   resp.user_settings.download_allowed #=> String, one of "Disabled", "Enabled"
+    #   resp.user_settings.idle_disconnect_timeout_in_minutes #=> Integer
     #   resp.user_settings.paste_allowed #=> String, one of "Disabled", "Enabled"
     #   resp.user_settings.print_allowed #=> String, one of "Disabled", "Enabled"
     #   resp.user_settings.upload_allowed #=> String, one of "Disabled", "Enabled"
@@ -2176,7 +2518,7 @@ module Aws::WorkSpacesWeb
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workspacesweb'
-      context[:gem_version] = '1.3.0'
+      context[:gem_version] = '1.5.0'
       Seahorse::Client::Request.new(handlers, context)
     end