aws-sdk-quicksight 1.45.0 → 1.46.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 31c924f1a8acdfefaa939af38a788ac6d8f7681ffd64aceea2dc6da45d3afc68
4
- data.tar.gz: f4bbe757b8d97ca4c4776adc9cc03aa48e8382324e3ef60bd2d078bcc0fef7bc
3
+ metadata.gz: 2be150ea9471cfd5d32d2da94cbf13e346e25f9f3d7a99c0884bc36b077c1724
4
+ data.tar.gz: dab48b91b9be9fe537729f94fd64cdb732ddac4d3f084f28b0d028fa962617f4
5
5
  SHA512:
6
- metadata.gz: ab4442ca5d26a112813cb0633cb78ffa10f028be3fd36313667349a42a46713a6395805f1edc236f9f99f6b60d8bc20217ec86658d0b9a957da2757fd05dede9
7
- data.tar.gz: d6dd6294892907fcc5c87df77d51c0fba08f8dc0634625e7ceba39bf97d3578ab366e141613f390d8bb1e5763c52e45262a36f3208dc852a40b45edef25c8a79
6
+ metadata.gz: 076e5226c693f3dcc2035ecd83947def6cf2f508ebc90a85b42adf8904a2b86e4247e4ec363404069ddcd6cbac451e11dffe20f82d69101acbfeeb8055d4c95e
7
+ data.tar.gz: 7a001432cb9bcacd248b8906b229b7871a89b4ecdb630f63f27d9e565fe7b889001166d650c5e100c75ff6172758e01d5352b53892dbf30c8c67b233701b4130
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.46.0 (2021-05-24)
5
+ ------------------
6
+
7
+ * Feature - Add new parameters on RegisterUser and UpdateUser APIs to assign or update external ID associated to QuickSight users federated through web identity.
8
+
4
9
  1.45.0 (2021-05-20)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.45.0
1
+ 1.46.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-quicksight/customizations'
48
48
  # @!group service
49
49
  module Aws::QuickSight
50
50
 
51
- GEM_VERSION = '1.45.0'
51
+ GEM_VERSION = '1.46.0'
52
52
 
53
53
  end
@@ -3845,6 +3845,9 @@ module Aws::QuickSight
3845
3845
  # resp.user.active #=> Boolean
3846
3846
  # resp.user.principal_id #=> String
3847
3847
  # resp.user.custom_permissions_name #=> String
3848
+ # resp.user.external_login_federation_provider_type #=> String
3849
+ # resp.user.external_login_federation_provider_url #=> String
3850
+ # resp.user.external_login_id #=> String
3848
3851
  # resp.request_id #=> String
3849
3852
  # resp.status #=> Integer
3850
3853
  #
@@ -5244,6 +5247,9 @@ module Aws::QuickSight
5244
5247
  # resp.user_list[0].active #=> Boolean
5245
5248
  # resp.user_list[0].principal_id #=> String
5246
5249
  # resp.user_list[0].custom_permissions_name #=> String
5250
+ # resp.user_list[0].external_login_federation_provider_type #=> String
5251
+ # resp.user_list[0].external_login_federation_provider_url #=> String
5252
+ # resp.user_list[0].external_login_id #=> String
5247
5253
  # resp.next_token #=> String
5248
5254
  # resp.request_id #=> String
5249
5255
  # resp.status #=> Integer
@@ -5349,6 +5355,31 @@ module Aws::QuickSight
5349
5355
  # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
5350
5356
  # (SSO).
5351
5357
  #
5358
+ # @option params [String] :external_login_federation_provider_type
5359
+ # The type of supported external login provider that provides identity
5360
+ # to let a user federate into Amazon QuickSight with an associated AWS
5361
+ # Identity and Access Management (IAM) role. The type of supported
5362
+ # external login provider can be one of the following.
5363
+ #
5364
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
5365
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
5366
+ # type, don’t use the "CustomFederationProviderUrl" parameter which
5367
+ # is only needed when the external provider is custom.
5368
+ #
5369
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
5370
+ # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
5371
+ # to provide the custom OIDC provider URL.
5372
+ #
5373
+ # @option params [String] :custom_federation_provider_url
5374
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
5375
+ # identity to let a user federate into QuickSight with an associated AWS
5376
+ # Identity and Access Management (IAM) role. This parameter should only
5377
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
5378
+ # `CUSTOM_OIDC`.
5379
+ #
5380
+ # @option params [String] :external_login_id
5381
+ # The identity ID for a user in the external login provider.
5382
+ #
5352
5383
  # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5353
5384
  #
5354
5385
  # * {Types::RegisterUserResponse#user #user} => Types::User
@@ -5368,6 +5399,9 @@ module Aws::QuickSight
5368
5399
  # namespace: "Namespace", # required
5369
5400
  # user_name: "UserName",
5370
5401
  # custom_permissions_name: "RoleName",
5402
+ # external_login_federation_provider_type: "String",
5403
+ # custom_federation_provider_url: "String",
5404
+ # external_login_id: "String",
5371
5405
  # })
5372
5406
  #
5373
5407
  # @example Response structure
@@ -5380,6 +5414,9 @@ module Aws::QuickSight
5380
5414
  # resp.user.active #=> Boolean
5381
5415
  # resp.user.principal_id #=> String
5382
5416
  # resp.user.custom_permissions_name #=> String
5417
+ # resp.user.external_login_federation_provider_type #=> String
5418
+ # resp.user.external_login_federation_provider_url #=> String
5419
+ # resp.user.external_login_id #=> String
5383
5420
  # resp.user_invitation_url #=> String
5384
5421
  # resp.request_id #=> String
5385
5422
  # resp.status #=> Integer
@@ -7394,6 +7431,35 @@ module Aws::QuickSight
7394
7431
  # This parameter defaults to NULL and it doesn't accept any other
7395
7432
  # value.
7396
7433
  #
7434
+ # @option params [String] :external_login_federation_provider_type
7435
+ # The type of supported external login provider that provides identity
7436
+ # to let a user federate into QuickSight with an associated AWS Identity
7437
+ # and Access Management (IAM) role. The type of supported external login
7438
+ # provider can be one of the following.
7439
+ #
7440
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
7441
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
7442
+ # type, don’t use the "CustomFederationProviderUrl" parameter which
7443
+ # is only needed when the external provider is custom.
7444
+ #
7445
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
7446
+ # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
7447
+ # to provide the custom OIDC provider URL.
7448
+ #
7449
+ # * `NONE`\: This clears all the previously saved external login
7450
+ # information for a user. Use ` DescribeUser ` API to check the
7451
+ # external login information.
7452
+ #
7453
+ # @option params [String] :custom_federation_provider_url
7454
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
7455
+ # identity to let a user federate into QuickSight with an associated AWS
7456
+ # Identity and Access Management (IAM) role. This parameter should only
7457
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
7458
+ # `CUSTOM_OIDC`.
7459
+ #
7460
+ # @option params [String] :external_login_id
7461
+ # The identity ID for a user in the external login provider.
7462
+ #
7397
7463
  # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7398
7464
  #
7399
7465
  # * {Types::UpdateUserResponse#user #user} => Types::User
@@ -7410,6 +7476,9 @@ module Aws::QuickSight
7410
7476
  # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
7411
7477
  # custom_permissions_name: "RoleName",
7412
7478
  # unapply_custom_permissions: false,
7479
+ # external_login_federation_provider_type: "String",
7480
+ # custom_federation_provider_url: "String",
7481
+ # external_login_id: "String",
7413
7482
  # })
7414
7483
  #
7415
7484
  # @example Response structure
@@ -7422,6 +7491,9 @@ module Aws::QuickSight
7422
7491
  # resp.user.active #=> Boolean
7423
7492
  # resp.user.principal_id #=> String
7424
7493
  # resp.user.custom_permissions_name #=> String
7494
+ # resp.user.external_login_federation_provider_type #=> String
7495
+ # resp.user.external_login_federation_provider_url #=> String
7496
+ # resp.user.external_login_id #=> String
7425
7497
  # resp.request_id #=> String
7426
7498
  # resp.status #=> Integer
7427
7499
  #
@@ -7447,7 +7519,7 @@ module Aws::QuickSight
7447
7519
  params: params,
7448
7520
  config: config)
7449
7521
  context[:gem_name] = 'aws-sdk-quicksight'
7450
- context[:gem_version] = '1.45.0'
7522
+ context[:gem_version] = '1.46.0'
7451
7523
  Seahorse::Client::Request.new(handlers, context)
7452
7524
  end
7453
7525
 
@@ -1987,6 +1987,9 @@ module Aws::QuickSight
1987
1987
  RegisterUserRequest.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, required: true, location: "uri", location_name: "Namespace"))
1988
1988
  RegisterUserRequest.add_member(:user_name, Shapes::ShapeRef.new(shape: UserName, location_name: "UserName"))
1989
1989
  RegisterUserRequest.add_member(:custom_permissions_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "CustomPermissionsName"))
1990
+ RegisterUserRequest.add_member(:external_login_federation_provider_type, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderType"))
1991
+ RegisterUserRequest.add_member(:custom_federation_provider_url, Shapes::ShapeRef.new(shape: String, location_name: "CustomFederationProviderUrl"))
1992
+ RegisterUserRequest.add_member(:external_login_id, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginId"))
1990
1993
  RegisterUserRequest.struct_class = Types::RegisterUserRequest
1991
1994
 
1992
1995
  RegisterUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
@@ -2596,6 +2599,9 @@ module Aws::QuickSight
2596
2599
  UpdateUserRequest.add_member(:role, Shapes::ShapeRef.new(shape: UserRole, required: true, location_name: "Role"))
2597
2600
  UpdateUserRequest.add_member(:custom_permissions_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "CustomPermissionsName"))
2598
2601
  UpdateUserRequest.add_member(:unapply_custom_permissions, Shapes::ShapeRef.new(shape: Boolean, location_name: "UnapplyCustomPermissions"))
2602
+ UpdateUserRequest.add_member(:external_login_federation_provider_type, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderType"))
2603
+ UpdateUserRequest.add_member(:custom_federation_provider_url, Shapes::ShapeRef.new(shape: String, location_name: "CustomFederationProviderUrl"))
2604
+ UpdateUserRequest.add_member(:external_login_id, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginId"))
2599
2605
  UpdateUserRequest.struct_class = Types::UpdateUserRequest
2600
2606
 
2601
2607
  UpdateUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
@@ -2618,6 +2624,9 @@ module Aws::QuickSight
2618
2624
  User.add_member(:active, Shapes::ShapeRef.new(shape: Boolean, location_name: "Active"))
2619
2625
  User.add_member(:principal_id, Shapes::ShapeRef.new(shape: String, location_name: "PrincipalId"))
2620
2626
  User.add_member(:custom_permissions_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "CustomPermissionsName"))
2627
+ User.add_member(:external_login_federation_provider_type, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderType"))
2628
+ User.add_member(:external_login_federation_provider_url, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderUrl"))
2629
+ User.add_member(:external_login_id, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginId"))
2621
2630
  User.struct_class = Types::User
2622
2631
 
2623
2632
  UserList.member = Shapes::ShapeRef.new(shape: User)
@@ -8856,6 +8856,9 @@ module Aws::QuickSight
8856
8856
  # namespace: "Namespace", # required
8857
8857
  # user_name: "UserName",
8858
8858
  # custom_permissions_name: "RoleName",
8859
+ # external_login_federation_provider_type: "String",
8860
+ # custom_federation_provider_url: "String",
8861
+ # external_login_id: "String",
8859
8862
  # }
8860
8863
  #
8861
8864
  # @!attribute [rw] identity_type
@@ -8959,6 +8962,35 @@ module Aws::QuickSight
8959
8962
  # (SSO).
8960
8963
  # @return [String]
8961
8964
  #
8965
+ # @!attribute [rw] external_login_federation_provider_type
8966
+ # The type of supported external login provider that provides identity
8967
+ # to let a user federate into Amazon QuickSight with an associated AWS
8968
+ # Identity and Access Management (IAM) role. The type of supported
8969
+ # external login provider can be one of the following.
8970
+ #
8971
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
8972
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO`
8973
+ # provider type, don’t use the "CustomFederationProviderUrl"
8974
+ # parameter which is only needed when the external provider is
8975
+ # custom.
8976
+ #
8977
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
8978
+ # choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
8979
+ # parameter to provide the custom OIDC provider URL.
8980
+ # @return [String]
8981
+ #
8982
+ # @!attribute [rw] custom_federation_provider_url
8983
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
8984
+ # identity to let a user federate into QuickSight with an associated
8985
+ # AWS Identity and Access Management (IAM) role. This parameter should
8986
+ # only be used when `ExternalLoginFederationProviderType` parameter is
8987
+ # set to `CUSTOM_OIDC`.
8988
+ # @return [String]
8989
+ #
8990
+ # @!attribute [rw] external_login_id
8991
+ # The identity ID for a user in the external login provider.
8992
+ # @return [String]
8993
+ #
8962
8994
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
8963
8995
  #
8964
8996
  class RegisterUserRequest < Struct.new(
@@ -8970,7 +9002,10 @@ module Aws::QuickSight
8970
9002
  :aws_account_id,
8971
9003
  :namespace,
8972
9004
  :user_name,
8973
- :custom_permissions_name)
9005
+ :custom_permissions_name,
9006
+ :external_login_federation_provider_type,
9007
+ :custom_federation_provider_url,
9008
+ :external_login_id)
8974
9009
  SENSITIVE = []
8975
9010
  include Aws::Structure
8976
9011
  end
@@ -13011,6 +13046,9 @@ module Aws::QuickSight
13011
13046
  # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
13012
13047
  # custom_permissions_name: "RoleName",
13013
13048
  # unapply_custom_permissions: false,
13049
+ # external_login_federation_provider_type: "String",
13050
+ # custom_federation_provider_url: "String",
13051
+ # external_login_id: "String",
13014
13052
  # }
13015
13053
  #
13016
13054
  # @!attribute [rw] user_name
@@ -13085,6 +13123,39 @@ module Aws::QuickSight
13085
13123
  # value.
13086
13124
  # @return [Boolean]
13087
13125
  #
13126
+ # @!attribute [rw] external_login_federation_provider_type
13127
+ # The type of supported external login provider that provides identity
13128
+ # to let a user federate into QuickSight with an associated AWS
13129
+ # Identity and Access Management (IAM) role. The type of supported
13130
+ # external login provider can be one of the following.
13131
+ #
13132
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
13133
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO`
13134
+ # provider type, don’t use the "CustomFederationProviderUrl"
13135
+ # parameter which is only needed when the external provider is
13136
+ # custom.
13137
+ #
13138
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
13139
+ # choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
13140
+ # parameter to provide the custom OIDC provider URL.
13141
+ #
13142
+ # * `NONE`\: This clears all the previously saved external login
13143
+ # information for a user. Use ` DescribeUser ` API to check the
13144
+ # external login information.
13145
+ # @return [String]
13146
+ #
13147
+ # @!attribute [rw] custom_federation_provider_url
13148
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
13149
+ # identity to let a user federate into QuickSight with an associated
13150
+ # AWS Identity and Access Management (IAM) role. This parameter should
13151
+ # only be used when `ExternalLoginFederationProviderType` parameter is
13152
+ # set to `CUSTOM_OIDC`.
13153
+ # @return [String]
13154
+ #
13155
+ # @!attribute [rw] external_login_id
13156
+ # The identity ID for a user in the external login provider.
13157
+ # @return [String]
13158
+ #
13088
13159
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
13089
13160
  #
13090
13161
  class UpdateUserRequest < Struct.new(
@@ -13094,7 +13165,10 @@ module Aws::QuickSight
13094
13165
  :email,
13095
13166
  :role,
13096
13167
  :custom_permissions_name,
13097
- :unapply_custom_permissions)
13168
+ :unapply_custom_permissions,
13169
+ :external_login_federation_provider_type,
13170
+ :custom_federation_provider_url,
13171
+ :external_login_id)
13098
13172
  SENSITIVE = []
13099
13173
  include Aws::Structure
13100
13174
  end
@@ -13218,6 +13292,25 @@ module Aws::QuickSight
13218
13292
  # The custom permissions profile associated with this user.
13219
13293
  # @return [String]
13220
13294
  #
13295
+ # @!attribute [rw] external_login_federation_provider_type
13296
+ # The type of supported external login provider that provides identity
13297
+ # to let the user federate into Amazon QuickSight with an associated
13298
+ # IAM role. The type can be one of the following.
13299
+ #
13300
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
13301
+ # cognito-identity.amazonaws.com.
13302
+ #
13303
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider.
13304
+ # @return [String]
13305
+ #
13306
+ # @!attribute [rw] external_login_federation_provider_url
13307
+ # The URL of the external login provider.
13308
+ # @return [String]
13309
+ #
13310
+ # @!attribute [rw] external_login_id
13311
+ # The identity ID for the user in the external login provider.
13312
+ # @return [String]
13313
+ #
13221
13314
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
13222
13315
  #
13223
13316
  class User < Struct.new(
@@ -13228,7 +13321,10 @@ module Aws::QuickSight
13228
13321
  :identity_type,
13229
13322
  :active,
13230
13323
  :principal_id,
13231
- :custom_permissions_name)
13324
+ :custom_permissions_name,
13325
+ :external_login_federation_provider_type,
13326
+ :external_login_federation_provider_url,
13327
+ :external_login_id)
13232
13328
  SENSITIVE = []
13233
13329
  include Aws::Structure
13234
13330
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-quicksight
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.45.0
4
+ version: 1.46.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: 2021-05-20 00:00:00.000000000 Z
11
+ date: 2021-05-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core