Class: Aws::QuickSight::Types::UpdateResourcePermissionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The ID of the Amazon Web Services account whose service role configuration you want to update.

Returns:

  • (String)


52833
52834
52835
52836
52837
52838
52839
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 52833

class UpdateResourcePermissionsRequest < Struct.new(
  :aws_account_id,
  :role_type,
  :customer_managed_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#customer_managed_role_arn ⇒ String

The ARN of the customer-managed role that you want Amazon Quick Sight to use. To use this operation, you must have the iam:PassRole permission for the role.

Configure the role as follows:

  • The role must belong to the Amazon Web Services account specified by AwsAccountId.

  • Configure the role trust policy to allow the Amazon Quick Sight service principal to call sts:AssumeRole.

  • Attach a permissions policy that allows access to the resources that you want Amazon Quick Sight to use.

  • To use features that rely on session tags, configure the role trust policy to allow the Amazon Quick Sight service principal to call sts:TagSession.

If the role doesn't exist or its trust policy doesn't allow sts:AssumeRole, the request returns an AccessDeniedException.

When you call this operation, Amazon Quick Sight attempts to assume the role with session tags and records whether the attempt succeeds. If you later add or remove sts:TagSession from the trust policy, call this operation again with the same role ARN to refresh the stored capability.

Returns:

  • (String)


52833
52834
52835
52836
52837
52838
52839
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 52833

class UpdateResourcePermissionsRequest < Struct.new(
  :aws_account_id,
  :role_type,
  :customer_managed_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_type ⇒ String

The type of service role that you want Amazon Quick Sight to use. The only supported value for this operation is CUSTOMER_MANAGED. Requests that specify QUICKSIGHT_MANAGED are rejected.

Returns:

  • (String)


52833
52834
52835
52836
52837
52838
52839
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 52833

class UpdateResourcePermissionsRequest < Struct.new(
  :aws_account_id,
  :role_type,
  :customer_managed_role_arn)
  SENSITIVE = []
  include Aws::Structure
end