aws-sdk-workspacesweb 1.28.0 → 1.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -40,11 +40,20 @@ module Aws::WorkSpacesWeb
40
40
  context[:auth_scheme] =
41
41
  Aws::Endpoints.resolve_auth_scheme(context, endpoint)
42
42
 
43
- @handler.call(context)
43
+ with_metrics(context) { @handler.call(context) }
44
44
  end
45
45
 
46
46
  private
47
47
 
48
+ def with_metrics(context, &block)
49
+ metrics = []
50
+ metrics << 'ENDPOINT_OVERRIDE' unless context.config.regional_endpoint
51
+ if context[:auth_scheme] && context[:auth_scheme]['name'] == 'sigv4a'
52
+ metrics << 'SIGV4A_SIGNING'
53
+ end
54
+ Aws::Plugins::UserAgent.metric(*metrics, &block)
55
+ end
56
+
48
57
  def apply_endpoint_headers(context, headers)
49
58
  headers.each do |key, values|
50
59
  value = values
@@ -114,6 +123,8 @@ module Aws::WorkSpacesWeb
114
123
  Aws::WorkSpacesWeb::Endpoints::DisassociateUserAccessLoggingSettings.build(context)
115
124
  when :disassociate_user_settings
116
125
  Aws::WorkSpacesWeb::Endpoints::DisassociateUserSettings.build(context)
126
+ when :expire_session
127
+ Aws::WorkSpacesWeb::Endpoints::ExpireSession.build(context)
117
128
  when :get_browser_settings
118
129
  Aws::WorkSpacesWeb::Endpoints::GetBrowserSettings.build(context)
119
130
  when :get_identity_provider
@@ -126,6 +137,8 @@ module Aws::WorkSpacesWeb
126
137
  Aws::WorkSpacesWeb::Endpoints::GetPortal.build(context)
127
138
  when :get_portal_service_provider_metadata
128
139
  Aws::WorkSpacesWeb::Endpoints::GetPortalServiceProviderMetadata.build(context)
140
+ when :get_session
141
+ Aws::WorkSpacesWeb::Endpoints::GetSession.build(context)
129
142
  when :get_trust_store
130
143
  Aws::WorkSpacesWeb::Endpoints::GetTrustStore.build(context)
131
144
  when :get_trust_store_certificate
@@ -144,6 +157,8 @@ module Aws::WorkSpacesWeb
144
157
  Aws::WorkSpacesWeb::Endpoints::ListNetworkSettings.build(context)
145
158
  when :list_portals
146
159
  Aws::WorkSpacesWeb::Endpoints::ListPortals.build(context)
160
+ when :list_sessions
161
+ Aws::WorkSpacesWeb::Endpoints::ListSessions.build(context)
147
162
  when :list_tags_for_resource
148
163
  Aws::WorkSpacesWeb::Endpoints::ListTagsForResource.build(context)
149
164
  when :list_trust_store_certificates
@@ -749,10 +749,9 @@ module Aws::WorkSpacesWeb
749
749
  # provider.
750
750
  #
751
751
  # `IAM Identity Center` web portals are authenticated through IAM
752
- # Identity Center (successor to Single Sign-On). Identity sources
753
- # (including external identity provider integration), plus user and
754
- # group access to your web portal, can be configured in the IAM
755
- # Identity Center.
752
+ # Identity Center. Identity sources (including external identity
753
+ # provider integration), plus user and group access to your web
754
+ # portal, can be configured in the IAM Identity Center.
756
755
  # @return [String]
757
756
  #
758
757
  # @!attribute [rw] client_token
@@ -1246,6 +1245,27 @@ module Aws::WorkSpacesWeb
1246
1245
  #
1247
1246
  class DisassociateUserSettingsResponse < Aws::EmptyStructure; end
1248
1247
 
1248
+ # @!attribute [rw] portal_id
1249
+ # The ID of the web portal for the session.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] session_id
1253
+ # The ID of the session to expire.
1254
+ # @return [String]
1255
+ #
1256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ExpireSessionRequest AWS API Documentation
1257
+ #
1258
+ class ExpireSessionRequest < Struct.new(
1259
+ :portal_id,
1260
+ :session_id)
1261
+ SENSITIVE = []
1262
+ include Aws::Structure
1263
+ end
1264
+
1265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ExpireSessionResponse AWS API Documentation
1266
+ #
1267
+ class ExpireSessionResponse < Aws::EmptyStructure; end
1268
+
1249
1269
  # @!attribute [rw] browser_settings_arn
1250
1270
  # The ARN of the browser settings.
1251
1271
  # @return [String]
@@ -1395,6 +1415,35 @@ module Aws::WorkSpacesWeb
1395
1415
  include Aws::Structure
1396
1416
  end
1397
1417
 
1418
+ # @!attribute [rw] portal_id
1419
+ # The ID of the web portal for the session.
1420
+ # @return [String]
1421
+ #
1422
+ # @!attribute [rw] session_id
1423
+ # The ID of the session.
1424
+ # @return [String]
1425
+ #
1426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetSessionRequest AWS API Documentation
1427
+ #
1428
+ class GetSessionRequest < Struct.new(
1429
+ :portal_id,
1430
+ :session_id)
1431
+ SENSITIVE = []
1432
+ include Aws::Structure
1433
+ end
1434
+
1435
+ # @!attribute [rw] session
1436
+ # The sessions in a list.
1437
+ # @return [Types::Session]
1438
+ #
1439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetSessionResponse AWS API Documentation
1440
+ #
1441
+ class GetSessionResponse < Struct.new(
1442
+ :session)
1443
+ SENSITIVE = []
1444
+ include Aws::Structure
1445
+ end
1446
+
1398
1447
  # @!attribute [rw] thumbprint
1399
1448
  # The thumbprint of the trust store certificate.
1400
1449
  # @return [String]
@@ -1925,6 +1974,67 @@ module Aws::WorkSpacesWeb
1925
1974
  include Aws::Structure
1926
1975
  end
1927
1976
 
1977
+ # @!attribute [rw] max_results
1978
+ # The maximum number of results to be included in the next page.
1979
+ # @return [Integer]
1980
+ #
1981
+ # @!attribute [rw] next_token
1982
+ # The pagination token used to retrieve the next page of results for
1983
+ # this operation.
1984
+ # @return [String]
1985
+ #
1986
+ # @!attribute [rw] portal_id
1987
+ # The ID of the web portal for the sessions.
1988
+ # @return [String]
1989
+ #
1990
+ # @!attribute [rw] session_id
1991
+ # The ID of the session.
1992
+ # @return [String]
1993
+ #
1994
+ # @!attribute [rw] sort_by
1995
+ # The method in which the returned sessions should be sorted.
1996
+ # @return [String]
1997
+ #
1998
+ # @!attribute [rw] status
1999
+ # The status of the session.
2000
+ # @return [String]
2001
+ #
2002
+ # @!attribute [rw] username
2003
+ # The username of the session.
2004
+ # @return [String]
2005
+ #
2006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListSessionsRequest AWS API Documentation
2007
+ #
2008
+ class ListSessionsRequest < Struct.new(
2009
+ :max_results,
2010
+ :next_token,
2011
+ :portal_id,
2012
+ :session_id,
2013
+ :sort_by,
2014
+ :status,
2015
+ :username)
2016
+ SENSITIVE = [:username]
2017
+ include Aws::Structure
2018
+ end
2019
+
2020
+ # @!attribute [rw] next_token
2021
+ # The pagination token used to retrieve the next page of results for
2022
+ # this operation.
2023
+ # @return [String]
2024
+ #
2025
+ # @!attribute [rw] sessions
2026
+ # The sessions in a list.
2027
+ # @return [Array<Types::SessionSummary>]
2028
+ #
2029
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListSessionsResponse AWS API Documentation
2030
+ #
2031
+ class ListSessionsResponse < Struct.new(
2032
+ :next_token,
2033
+ :sessions)
2034
+ SENSITIVE = []
2035
+ include Aws::Structure
2036
+ end
2037
+
1928
2038
  # @!attribute [rw] resource_arn
1929
2039
  # The ARN of the resource.
1930
2040
  # @return [String]
@@ -2179,10 +2289,9 @@ module Aws::WorkSpacesWeb
2179
2289
  # provider.
2180
2290
  #
2181
2291
  # `IAM Identity Center` web portals are authenticated through IAM
2182
- # Identity Center (successor to Single Sign-On). Identity sources
2183
- # (including external identity provider integration), plus user and
2184
- # group access to your web portal, can be configured in the IAM
2185
- # Identity Center.
2292
+ # Identity Center. Identity sources (including external identity
2293
+ # provider integration), plus user and group access to your web
2294
+ # portal, can be configured in the IAM Identity Center.
2186
2295
  # @return [String]
2187
2296
  #
2188
2297
  # @!attribute [rw] browser_settings_arn
@@ -2297,10 +2406,9 @@ module Aws::WorkSpacesWeb
2297
2406
  # provider.
2298
2407
  #
2299
2408
  # `IAM Identity Center` web portals are authenticated through IAM
2300
- # Identity Center (successor to Single Sign-On). Identity sources
2301
- # (including external identity provider integration), plus user and
2302
- # group access to your web portal, can be configured in the IAM
2303
- # Identity Center.
2409
+ # Identity Center. Identity sources (including external identity
2410
+ # provider integration), plus user and group access to your web
2411
+ # portal, can be configured in the IAM Identity Center.
2304
2412
  # @return [String]
2305
2413
  #
2306
2414
  # @!attribute [rw] browser_settings_arn
@@ -2446,6 +2554,89 @@ module Aws::WorkSpacesWeb
2446
2554
  include Aws::Structure
2447
2555
  end
2448
2556
 
2557
+ # Information about a secure browser session.
2558
+ #
2559
+ # @!attribute [rw] client_ip_addresses
2560
+ # The IP address of the client.
2561
+ # @return [Array<String>]
2562
+ #
2563
+ # @!attribute [rw] end_time
2564
+ # The end time of the session.
2565
+ # @return [Time]
2566
+ #
2567
+ # @!attribute [rw] portal_arn
2568
+ # The ARN of the web portal.
2569
+ # @return [String]
2570
+ #
2571
+ # @!attribute [rw] session_id
2572
+ # The ID of the session.
2573
+ # @return [String]
2574
+ #
2575
+ # @!attribute [rw] start_time
2576
+ # The start time of the session.
2577
+ # @return [Time]
2578
+ #
2579
+ # @!attribute [rw] status
2580
+ # The status of the session.
2581
+ # @return [String]
2582
+ #
2583
+ # @!attribute [rw] username
2584
+ # The username of the session.
2585
+ # @return [String]
2586
+ #
2587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/Session AWS API Documentation
2588
+ #
2589
+ class Session < Struct.new(
2590
+ :client_ip_addresses,
2591
+ :end_time,
2592
+ :portal_arn,
2593
+ :session_id,
2594
+ :start_time,
2595
+ :status,
2596
+ :username)
2597
+ SENSITIVE = [:client_ip_addresses, :username]
2598
+ include Aws::Structure
2599
+ end
2600
+
2601
+ # Summary information about a secure browser session.
2602
+ #
2603
+ # @!attribute [rw] end_time
2604
+ # The end time of the session.
2605
+ # @return [Time]
2606
+ #
2607
+ # @!attribute [rw] portal_arn
2608
+ # The ARN of the web portal.
2609
+ # @return [String]
2610
+ #
2611
+ # @!attribute [rw] session_id
2612
+ # The ID of the session.
2613
+ # @return [String]
2614
+ #
2615
+ # @!attribute [rw] start_time
2616
+ # The start time of the session.
2617
+ # @return [Time]
2618
+ #
2619
+ # @!attribute [rw] status
2620
+ # The status of the session.
2621
+ # @return [String]
2622
+ #
2623
+ # @!attribute [rw] username
2624
+ # The username of the session.
2625
+ # @return [String]
2626
+ #
2627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/SessionSummary AWS API Documentation
2628
+ #
2629
+ class SessionSummary < Struct.new(
2630
+ :end_time,
2631
+ :portal_arn,
2632
+ :session_id,
2633
+ :start_time,
2634
+ :status,
2635
+ :username)
2636
+ SENSITIVE = [:username]
2637
+ include Aws::Structure
2638
+ end
2639
+
2449
2640
  # The tag.
2450
2641
  #
2451
2642
  # @!attribute [rw] key
@@ -2897,10 +3088,9 @@ module Aws::WorkSpacesWeb
2897
3088
  # provider.
2898
3089
  #
2899
3090
  # `IAM Identity Center` web portals are authenticated through IAM
2900
- # Identity Center (successor to Single Sign-On). Identity sources
2901
- # (including external identity provider integration), plus user and
2902
- # group access to your web portal, can be configured in the IAM
2903
- # Identity Center.
3091
+ # Identity Center. Identity sources (including external identity
3092
+ # provider integration), plus user and group access to your web
3093
+ # portal, can be configured in the IAM Identity Center.
2904
3094
  # @return [String]
2905
3095
  #
2906
3096
  # @!attribute [rw] display_name
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-workspacesweb/customizations'
52
52
  # @!group service
53
53
  module Aws::WorkSpacesWeb
54
54
 
55
- GEM_VERSION = '1.28.0'
55
+ GEM_VERSION = '1.30.0'
56
56
 
57
57
  end
data/sig/client.rbs CHANGED
@@ -455,6 +455,16 @@ module Aws
455
455
  ) -> _DisassociateUserSettingsResponseSuccess
456
456
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateUserSettingsResponseSuccess
457
457
 
458
+ interface _ExpireSessionResponseSuccess
459
+ include ::Seahorse::Client::_ResponseSuccess[Types::ExpireSessionResponse]
460
+ end
461
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkSpacesWeb/Client.html#expire_session-instance_method
462
+ def expire_session: (
463
+ portal_id: ::String,
464
+ session_id: ::String
465
+ ) -> _ExpireSessionResponseSuccess
466
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ExpireSessionResponseSuccess
467
+
458
468
  interface _GetBrowserSettingsResponseSuccess
459
469
  include ::Seahorse::Client::_ResponseSuccess[Types::GetBrowserSettingsResponse]
460
470
  def browser_settings: () -> Types::BrowserSettings
@@ -516,6 +526,17 @@ module Aws
516
526
  ) -> _GetPortalServiceProviderMetadataResponseSuccess
517
527
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPortalServiceProviderMetadataResponseSuccess
518
528
 
529
+ interface _GetSessionResponseSuccess
530
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetSessionResponse]
531
+ def session: () -> Types::Session
532
+ end
533
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkSpacesWeb/Client.html#get_session-instance_method
534
+ def get_session: (
535
+ portal_id: ::String,
536
+ session_id: ::String
537
+ ) -> _GetSessionResponseSuccess
538
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSessionResponseSuccess
539
+
519
540
  interface _GetTrustStoreResponseSuccess
520
541
  include ::Seahorse::Client::_ResponseSuccess[Types::GetTrustStoreResponse]
521
542
  def trust_store: () -> Types::TrustStore
@@ -619,6 +640,23 @@ module Aws
619
640
  ) -> _ListPortalsResponseSuccess
620
641
  | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPortalsResponseSuccess
621
642
 
643
+ interface _ListSessionsResponseSuccess
644
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListSessionsResponse]
645
+ def next_token: () -> ::String
646
+ def sessions: () -> ::Array[Types::SessionSummary]
647
+ end
648
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkSpacesWeb/Client.html#list_sessions-instance_method
649
+ def list_sessions: (
650
+ ?max_results: ::Integer,
651
+ ?next_token: ::String,
652
+ portal_id: ::String,
653
+ ?session_id: ::String,
654
+ ?sort_by: ("StartTimeAscending" | "StartTimeDescending"),
655
+ ?status: ("Active" | "Terminated"),
656
+ ?username: ::String
657
+ ) -> _ListSessionsResponseSuccess
658
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSessionsResponseSuccess
659
+
622
660
  interface _ListTagsForResourceResponseSuccess
623
661
  include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
624
662
  def tags: () -> ::Array[Types::Tag]
data/sig/types.rbs CHANGED
@@ -373,6 +373,15 @@ module Aws::WorkSpacesWeb
373
373
  class DisassociateUserSettingsResponse < Aws::EmptyStructure
374
374
  end
375
375
 
376
+ class ExpireSessionRequest
377
+ attr_accessor portal_id: ::String
378
+ attr_accessor session_id: ::String
379
+ SENSITIVE: []
380
+ end
381
+
382
+ class ExpireSessionResponse < Aws::EmptyStructure
383
+ end
384
+
376
385
  class GetBrowserSettingsRequest
377
386
  attr_accessor browser_settings_arn: ::String
378
387
  SENSITIVE: []
@@ -434,6 +443,17 @@ module Aws::WorkSpacesWeb
434
443
  SENSITIVE: []
435
444
  end
436
445
 
446
+ class GetSessionRequest
447
+ attr_accessor portal_id: ::String
448
+ attr_accessor session_id: ::String
449
+ SENSITIVE: []
450
+ end
451
+
452
+ class GetSessionResponse
453
+ attr_accessor session: Types::Session
454
+ SENSITIVE: []
455
+ end
456
+
437
457
  class GetTrustStoreCertificateRequest
438
458
  attr_accessor thumbprint: ::String
439
459
  attr_accessor trust_store_arn: ::String
@@ -584,6 +604,23 @@ module Aws::WorkSpacesWeb
584
604
  SENSITIVE: []
585
605
  end
586
606
 
607
+ class ListSessionsRequest
608
+ attr_accessor max_results: ::Integer
609
+ attr_accessor next_token: ::String
610
+ attr_accessor portal_id: ::String
611
+ attr_accessor session_id: ::String
612
+ attr_accessor sort_by: ("StartTimeAscending" | "StartTimeDescending")
613
+ attr_accessor status: ("Active" | "Terminated")
614
+ attr_accessor username: ::String
615
+ SENSITIVE: [:username]
616
+ end
617
+
618
+ class ListSessionsResponse
619
+ attr_accessor next_token: ::String
620
+ attr_accessor sessions: ::Array[Types::SessionSummary]
621
+ SENSITIVE: []
622
+ end
623
+
587
624
  class ListTagsForResourceRequest
588
625
  attr_accessor resource_arn: ::String
589
626
  SENSITIVE: []
@@ -718,6 +755,27 @@ module Aws::WorkSpacesWeb
718
755
  SENSITIVE: []
719
756
  end
720
757
 
758
+ class Session
759
+ attr_accessor client_ip_addresses: ::Array[::String]
760
+ attr_accessor end_time: ::Time
761
+ attr_accessor portal_arn: ::String
762
+ attr_accessor session_id: ::String
763
+ attr_accessor start_time: ::Time
764
+ attr_accessor status: ("Active" | "Terminated")
765
+ attr_accessor username: ::String
766
+ SENSITIVE: [:username]
767
+ end
768
+
769
+ class SessionSummary
770
+ attr_accessor end_time: ::Time
771
+ attr_accessor portal_arn: ::String
772
+ attr_accessor session_id: ::String
773
+ attr_accessor start_time: ::Time
774
+ attr_accessor status: ("Active" | "Terminated")
775
+ attr_accessor username: ::String
776
+ SENSITIVE: [:username]
777
+ end
778
+
721
779
  class Tag
722
780
  attr_accessor key: ::String
723
781
  attr_accessor value: ::String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-workspacesweb
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.28.0
4
+ version: 1.30.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-09-10 00:00:00.000000000 Z
11
+ date: 2024-09-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.203.0
22
+ version: 3.205.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,21 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.203.0
32
+ version: 3.205.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
36
36
  requirements:
37
37
  - - "~>"
38
38
  - !ruby/object:Gem::Version
39
- version: '1.1'
39
+ version: '1.5'
40
40
  type: :runtime
41
41
  prerelease: false
42
42
  version_requirements: !ruby/object:Gem::Requirement
43
43
  requirements:
44
44
  - - "~>"
45
45
  - !ruby/object:Gem::Version
46
- version: '1.1'
46
+ version: '1.5'
47
47
  description: Official AWS Ruby gem for Amazon WorkSpaces Web. This gem is part of
48
48
  the AWS SDK for Ruby.
49
49
  email: