aws-sdk-quicksight 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c924f1a8acdfefaa939af38a788ac6d8f7681ffd64aceea2dc6da45d3afc68
-  data.tar.gz: f4bbe757b8d97ca4c4776adc9cc03aa48e8382324e3ef60bd2d078bcc0fef7bc
+  metadata.gz: 2be150ea9471cfd5d32d2da94cbf13e346e25f9f3d7a99c0884bc36b077c1724
+  data.tar.gz: dab48b91b9be9fe537729f94fd64cdb732ddac4d3f084f28b0d028fa962617f4
 SHA512:
-  metadata.gz: ab4442ca5d26a112813cb0633cb78ffa10f028be3fd36313667349a42a46713a6395805f1edc236f9f99f6b60d8bc20217ec86658d0b9a957da2757fd05dede9
-  data.tar.gz: d6dd6294892907fcc5c87df77d51c0fba08f8dc0634625e7ceba39bf97d3578ab366e141613f390d8bb1e5763c52e45262a36f3208dc852a40b45edef25c8a79
+  metadata.gz: 076e5226c693f3dcc2035ecd83947def6cf2f508ebc90a85b42adf8904a2b86e4247e4ec363404069ddcd6cbac451e11dffe20f82d69101acbfeeb8055d4c95e
+  data.tar.gz: 7a001432cb9bcacd248b8906b229b7871a89b4ecdb630f63f27d9e565fe7b889001166d650c5e100c75ff6172758e01d5352b53892dbf30c8c67b233701b4130

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.46.0 (2021-05-24)
+------------------
+
+* Feature - Add new parameters on RegisterUser and UpdateUser APIs to assign or update external ID associated to QuickSight users federated through web identity.
+
 1.45.0 (2021-05-20)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.45.0
+1.46.0

data/lib/aws-sdk-quicksight.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-quicksight/customizations'
 # @!group service
 module Aws::QuickSight
 
-  GEM_VERSION = '1.45.0'
+  GEM_VERSION = '1.46.0'
 
 end

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

@@ -3845,6 +3845,9 @@ module Aws::QuickSight
     #   resp.user.active #=> Boolean
     #   resp.user.principal_id #=> String
     #   resp.user.custom_permissions_name #=> String
+    #   resp.user.external_login_federation_provider_type #=> String
+    #   resp.user.external_login_federation_provider_url #=> String
+    #   resp.user.external_login_id #=> String
     #   resp.request_id #=> String
     #   resp.status #=> Integer
     #
@@ -5244,6 +5247,9 @@ module Aws::QuickSight
     #   resp.user_list[0].active #=> Boolean
     #   resp.user_list[0].principal_id #=> String
     #   resp.user_list[0].custom_permissions_name #=> String
+    #   resp.user_list[0].external_login_federation_provider_type #=> String
+    #   resp.user_list[0].external_login_federation_provider_url #=> String
+    #   resp.user_list[0].external_login_id #=> String
     #   resp.next_token #=> String
     #   resp.request_id #=> String
     #   resp.status #=> Integer
@@ -5349,6 +5355,31 @@ module Aws::QuickSight
     #   subscriptions that use SAML 2.0-Based Federation for Single Sign-On
     #   (SSO).
     #
+    # @option params [String] :external_login_federation_provider_type
+    #   The type of supported external login provider that provides identity
+    #   to let a user federate into Amazon QuickSight with an associated AWS
+    #   Identity and Access Management (IAM) role. The type of supported
+    #   external login provider can be one of the following.
+    #
+    #   * `COGNITO`\: Amazon Cognito. The provider URL is
+    #     cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
+    #     type, don’t use the "CustomFederationProviderUrl" parameter which
+    #     is only needed when the external provider is custom.
+    #
+    #   * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
+    #     `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
+    #     to provide the custom OIDC provider URL.
+    #
+    # @option params [String] :custom_federation_provider_url
+    #   The URL of the custom OpenID Connect (OIDC) provider that provides
+    #   identity to let a user federate into QuickSight with an associated AWS
+    #   Identity and Access Management (IAM) role. This parameter should only
+    #   be used when `ExternalLoginFederationProviderType` parameter is set to
+    #   `CUSTOM_OIDC`.
+    #
+    # @option params [String] :external_login_id
+    #   The identity ID for a user in the external login provider.
+    #
     # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::RegisterUserResponse#user #user} => Types::User
@@ -5368,6 +5399,9 @@ module Aws::QuickSight
     #     namespace: "Namespace", # required
     #     user_name: "UserName",
     #     custom_permissions_name: "RoleName",
+    #     external_login_federation_provider_type: "String",
+    #     custom_federation_provider_url: "String",
+    #     external_login_id: "String",
     #   })
     #
     # @example Response structure
@@ -5380,6 +5414,9 @@ module Aws::QuickSight
     #   resp.user.active #=> Boolean
     #   resp.user.principal_id #=> String
     #   resp.user.custom_permissions_name #=> String
+    #   resp.user.external_login_federation_provider_type #=> String
+    #   resp.user.external_login_federation_provider_url #=> String
+    #   resp.user.external_login_id #=> String
     #   resp.user_invitation_url #=> String
     #   resp.request_id #=> String
     #   resp.status #=> Integer
@@ -7394,6 +7431,35 @@ module Aws::QuickSight
     #   This parameter defaults to NULL and it doesn't accept any other
     #   value.
     #
+    # @option params [String] :external_login_federation_provider_type
+    #   The type of supported external login provider that provides identity
+    #   to let a user federate into QuickSight with an associated AWS Identity
+    #   and Access Management (IAM) role. The type of supported external login
+    #   provider can be one of the following.
+    #
+    #   * `COGNITO`\: Amazon Cognito. The provider URL is
+    #     cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
+    #     type, don’t use the "CustomFederationProviderUrl" parameter which
+    #     is only needed when the external provider is custom.
+    #
+    #   * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
+    #     `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
+    #     to provide the custom OIDC provider URL.
+    #
+    #   * `NONE`\: This clears all the previously saved external login
+    #     information for a user. Use ` DescribeUser ` API to check the
+    #     external login information.
+    #
+    # @option params [String] :custom_federation_provider_url
+    #   The URL of the custom OpenID Connect (OIDC) provider that provides
+    #   identity to let a user federate into QuickSight with an associated AWS
+    #   Identity and Access Management (IAM) role. This parameter should only
+    #   be used when `ExternalLoginFederationProviderType` parameter is set to
+    #   `CUSTOM_OIDC`.
+    #
+    # @option params [String] :external_login_id
+    #   The identity ID for a user in the external login provider.
+    #
     # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateUserResponse#user #user} => Types::User
@@ -7410,6 +7476,9 @@ module Aws::QuickSight
     #     role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
     #     custom_permissions_name: "RoleName",
     #     unapply_custom_permissions: false,
+    #     external_login_federation_provider_type: "String",
+    #     custom_federation_provider_url: "String",
+    #     external_login_id: "String",
     #   })
     #
     # @example Response structure
@@ -7422,6 +7491,9 @@ module Aws::QuickSight
     #   resp.user.active #=> Boolean
     #   resp.user.principal_id #=> String
     #   resp.user.custom_permissions_name #=> String
+    #   resp.user.external_login_federation_provider_type #=> String
+    #   resp.user.external_login_federation_provider_url #=> String
+    #   resp.user.external_login_id #=> String
     #   resp.request_id #=> String
     #   resp.status #=> Integer
     #
@@ -7447,7 +7519,7 @@ module Aws::QuickSight
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-quicksight'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -1987,6 +1987,9 @@ module Aws::QuickSight
     RegisterUserRequest.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, required: true, location: "uri", location_name: "Namespace"))
     RegisterUserRequest.add_member(:user_name, Shapes::ShapeRef.new(shape: UserName, location_name: "UserName"))
     RegisterUserRequest.add_member(:custom_permissions_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "CustomPermissionsName"))
+    RegisterUserRequest.add_member(:external_login_federation_provider_type, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderType"))
+    RegisterUserRequest.add_member(:custom_federation_provider_url, Shapes::ShapeRef.new(shape: String, location_name: "CustomFederationProviderUrl"))
+    RegisterUserRequest.add_member(:external_login_id, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginId"))
     RegisterUserRequest.struct_class = Types::RegisterUserRequest
 
     RegisterUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
@@ -2596,6 +2599,9 @@ module Aws::QuickSight
     UpdateUserRequest.add_member(:role, Shapes::ShapeRef.new(shape: UserRole, required: true, location_name: "Role"))
     UpdateUserRequest.add_member(:custom_permissions_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "CustomPermissionsName"))
     UpdateUserRequest.add_member(:unapply_custom_permissions, Shapes::ShapeRef.new(shape: Boolean, location_name: "UnapplyCustomPermissions"))
+    UpdateUserRequest.add_member(:external_login_federation_provider_type, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderType"))
+    UpdateUserRequest.add_member(:custom_federation_provider_url, Shapes::ShapeRef.new(shape: String, location_name: "CustomFederationProviderUrl"))
+    UpdateUserRequest.add_member(:external_login_id, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginId"))
     UpdateUserRequest.struct_class = Types::UpdateUserRequest
 
     UpdateUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
@@ -2618,6 +2624,9 @@ module Aws::QuickSight
     User.add_member(:active, Shapes::ShapeRef.new(shape: Boolean, location_name: "Active"))
     User.add_member(:principal_id, Shapes::ShapeRef.new(shape: String, location_name: "PrincipalId"))
     User.add_member(:custom_permissions_name, Shapes::ShapeRef.new(shape: RoleName, location_name: "CustomPermissionsName"))
+    User.add_member(:external_login_federation_provider_type, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderType"))
+    User.add_member(:external_login_federation_provider_url, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginFederationProviderUrl"))
+    User.add_member(:external_login_id, Shapes::ShapeRef.new(shape: String, location_name: "ExternalLoginId"))
     User.struct_class = Types::User
 
     UserList.member = Shapes::ShapeRef.new(shape: User)

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

@@ -8856,6 +8856,9 @@ module Aws::QuickSight
     #         namespace: "Namespace", # required
     #         user_name: "UserName",
     #         custom_permissions_name: "RoleName",
+    #         external_login_federation_provider_type: "String",
+    #         custom_federation_provider_url: "String",
+    #         external_login_id: "String",
     #       }
     #
     # @!attribute [rw] identity_type
@@ -8959,6 +8962,35 @@ module Aws::QuickSight
     #   (SSO).
     #   @return [String]
     #
+    # @!attribute [rw] external_login_federation_provider_type
+    #   The type of supported external login provider that provides identity
+    #   to let a user federate into Amazon QuickSight with an associated AWS
+    #   Identity and Access Management (IAM) role. The type of supported
+    #   external login provider can be one of the following.
+    #
+    #   * `COGNITO`\: Amazon Cognito. The provider URL is
+    #     cognito-identity.amazonaws.com. When choosing the `COGNITO`
+    #     provider type, don’t use the "CustomFederationProviderUrl"
+    #     parameter which is only needed when the external provider is
+    #     custom.
+    #
+    #   * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
+    #     choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
+    #     parameter to provide the custom OIDC provider URL.
+    #   @return [String]
+    #
+    # @!attribute [rw] custom_federation_provider_url
+    #   The URL of the custom OpenID Connect (OIDC) provider that provides
+    #   identity to let a user federate into QuickSight with an associated
+    #   AWS Identity and Access Management (IAM) role. This parameter should
+    #   only be used when `ExternalLoginFederationProviderType` parameter is
+    #   set to `CUSTOM_OIDC`.
+    #   @return [String]
+    #
+    # @!attribute [rw] external_login_id
+    #   The identity ID for a user in the external login provider.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
     #
     class RegisterUserRequest < Struct.new(
@@ -8970,7 +9002,10 @@ module Aws::QuickSight
       :aws_account_id,
       :namespace,
       :user_name,
-      :custom_permissions_name)
+      :custom_permissions_name,
+      :external_login_federation_provider_type,
+      :custom_federation_provider_url,
+      :external_login_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -13011,6 +13046,9 @@ module Aws::QuickSight
     #         role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
     #         custom_permissions_name: "RoleName",
     #         unapply_custom_permissions: false,
+    #         external_login_federation_provider_type: "String",
+    #         custom_federation_provider_url: "String",
+    #         external_login_id: "String",
     #       }
     #
     # @!attribute [rw] user_name
@@ -13085,6 +13123,39 @@ module Aws::QuickSight
     #   value.
     #   @return [Boolean]
     #
+    # @!attribute [rw] external_login_federation_provider_type
+    #   The type of supported external login provider that provides identity
+    #   to let a user federate into QuickSight with an associated AWS
+    #   Identity and Access Management (IAM) role. The type of supported
+    #   external login provider can be one of the following.
+    #
+    #   * `COGNITO`\: Amazon Cognito. The provider URL is
+    #     cognito-identity.amazonaws.com. When choosing the `COGNITO`
+    #     provider type, don’t use the "CustomFederationProviderUrl"
+    #     parameter which is only needed when the external provider is
+    #     custom.
+    #
+    #   * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
+    #     choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
+    #     parameter to provide the custom OIDC provider URL.
+    #
+    #   * `NONE`\: This clears all the previously saved external login
+    #     information for a user. Use ` DescribeUser ` API to check the
+    #     external login information.
+    #   @return [String]
+    #
+    # @!attribute [rw] custom_federation_provider_url
+    #   The URL of the custom OpenID Connect (OIDC) provider that provides
+    #   identity to let a user federate into QuickSight with an associated
+    #   AWS Identity and Access Management (IAM) role. This parameter should
+    #   only be used when `ExternalLoginFederationProviderType` parameter is
+    #   set to `CUSTOM_OIDC`.
+    #   @return [String]
+    #
+    # @!attribute [rw] external_login_id
+    #   The identity ID for a user in the external login provider.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
     #
     class UpdateUserRequest < Struct.new(
@@ -13094,7 +13165,10 @@ module Aws::QuickSight
       :email,
       :role,
       :custom_permissions_name,
-      :unapply_custom_permissions)
+      :unapply_custom_permissions,
+      :external_login_federation_provider_type,
+      :custom_federation_provider_url,
+      :external_login_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -13218,6 +13292,25 @@ module Aws::QuickSight
     #   The custom permissions profile associated with this user.
     #   @return [String]
     #
+    # @!attribute [rw] external_login_federation_provider_type
+    #   The type of supported external login provider that provides identity
+    #   to let the user federate into Amazon QuickSight with an associated
+    #   IAM role. The type can be one of the following.
+    #
+    #   * `COGNITO`\: Amazon Cognito. The provider URL is
+    #     cognito-identity.amazonaws.com.
+    #
+    #   * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider.
+    #   @return [String]
+    #
+    # @!attribute [rw] external_login_federation_provider_url
+    #   The URL of the external login provider.
+    #   @return [String]
+    #
+    # @!attribute [rw] external_login_id
+    #   The identity ID for the user in the external login provider.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
     #
     class User < Struct.new(
@@ -13228,7 +13321,10 @@ module Aws::QuickSight
       :identity_type,
       :active,
       :principal_id,
-      :custom_permissions_name)
+      :custom_permissions_name,
+      :external_login_federation_provider_type,
+      :external_login_federation_provider_url,
+      :external_login_id)
       SENSITIVE = []
       include Aws::Structure
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-quicksight
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core