Class UpdateResourcePermissionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.quicksight.model.QuickSightRequest
software.amazon.awssdk.services.quicksight.model.UpdateResourcePermissionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateResourcePermissionsRequest.Builder,UpdateResourcePermissionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateResourcePermissionsRequest extends QuickSightRequest implements ToCopyableBuilder<UpdateResourcePermissionsRequest.Builder,UpdateResourcePermissionsRequest>

  • Method Details

    • awsAccountId

      public final String awsAccountId()

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

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

    • roleType

      public final ServiceRoleType roleType()

      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.

      If the service returns an enum value that is not available in the current SDK version, roleType will return ServiceRoleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleTypeAsString().

      Returns:
      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.
      See Also:

    • roleTypeAsString

      public final String roleTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, roleType will return ServiceRoleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleTypeAsString().

      Returns:
      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.
      See Also:

    • customerManagedRoleArn

      public final String customerManagedRoleArn()

      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:
      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.

    • toBuilder

      public UpdateResourcePermissionsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateResourcePermissionsRequest.Builder,UpdateResourcePermissionsRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateResourcePermissionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateResourcePermissionsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.