aws-sdk-workspacesweb 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4cb340962f44341a8886ea1d80ab17d2f23824d5ae5bf199ca236cc095d40b7
-  data.tar.gz: 026df9cbf913a580d4ed87df3304aa243b2d7cd4aea92c0588649fe901a4dbc9
+  metadata.gz: d869431699bf377f242b80ad851391f5d4825b294f35dbfbfc7bf99c11c5935f
+  data.tar.gz: dc39b876ba901f02bb9ce1e3b63637682e16fd76255f005e54af83c02d21b9fe
 SHA512:
-  metadata.gz: 3d353472e29826076d3b544728083c0869d4cc999d1cf0272f9127026b71f88e45e26a66cabb3ea02804c5950e556c4022c65c59adc9a3d5dcbce38db4f11984
-  data.tar.gz: a473103691133ba322602a5d7f0c14dde56ae921ec511ff4d0e025bede331d613e2da0cf7c61a27c7117fb38deb287a5152f2bafe0613fd6e00b378e64c9bcc0
+  metadata.gz: 3cf3e43108a4cc5a5a8b85d6becfefdfcc56f4f8958dc42b63ce02f6f45b701cfb19a9f2247375209889c1b9c9c0fb043f7371f27a918de48f5c5df184dd6e77
+  data.tar.gz: 2a41476ff87cc4a3327dc7ff7d82eb3725635479b52ec5dc2d9d475409d912b0ee24e5ffb1a48728540d23f137d51f39c58e59eada89e399b7a67965416e5494

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.6.0 (2022-10-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+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)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.6.0

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

@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/checksum_algorithm.rb'
 require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/recursion_detection.rb'
-require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/sign.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:workspacesweb)
@@ -79,8 +79,9 @@ module Aws::WorkSpacesWeb
     add_plugin(Aws::Plugins::ChecksumAlgorithm)
     add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::RecursionDetection)
-    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Sign)
     add_plugin(Aws::Plugins::Protocols::RestJson)
+    add_plugin(Aws::WorkSpacesWeb::Plugins::Endpoints)
 
     # @overload initialize(options)
     #   @param [Hash] options
@@ -287,6 +288,19 @@ module Aws::WorkSpacesWeb
     #     ** Please note ** When response stubbing is enabled, no HTTP
     #     requests are made, and retries are disabled.
     #
+    #   @option options [Aws::TokenProvider] :token_provider
+    #     A Bearer Token Provider. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
+    #       tokens.
+    #
+    #     * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
+    #     will be used to search for tokens configured for your profile in shared configuration files.
+    #
     #   @option options [Boolean] :use_dualstack_endpoint
     #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
     #     will be used if available.
@@ -300,6 +314,9 @@ module Aws::WorkSpacesWeb
     #     When `true`, request parameters are validated before
     #     sending the request.
     #
+    #   @option options [Aws::WorkSpacesWeb::EndpointProvider] :endpoint_provider
+    #     The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::WorkSpacesWeb::EndpointParameters`
+    #
     #   @option options [URI::HTTP,String] :http_proxy A proxy to send
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
@@ -453,6 +470,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
@@ -857,6 +908,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
@@ -1053,6 +1157,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
@@ -1141,6 +1267,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
@@ -1289,6 +1437,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
@@ -1399,6 +1548,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
@@ -1594,6 +1774,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
@@ -1721,6 +1902,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
@@ -2105,6 +2325,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
@@ -2166,6 +2387,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
@@ -2265,7 +2535,7 @@ module Aws::WorkSpacesWeb
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workspacesweb'
-      context[:gem_version] = '1.4.0'
+      context[:gem_version] = '1.6.0'
       Seahorse::Client::Request.new(handlers, context)
     end