Interface GetIdentityContextRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetIdentityContextRequest.Builder,GetIdentityContextRequest>, QuickSightRequest.Builder, SdkBuilder<GetIdentityContextRequest.Builder,GetIdentityContextRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetIdentityContextRequest
@Mutable @NotThreadSafe public static interface GetIdentityContextRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GetIdentityContextRequest.Builder,GetIdentityContextRequest>

  • Method Details

    • awsAccountId

      GetIdentityContextRequest.Builder awsAccountId(String awsAccountId)

      The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.

      Parameters:
      awsAccountId - The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userIdentifier

      GetIdentityContextRequest.Builder userIdentifier(UserIdentifier userIdentifier)

      The identifier for the user whose identity context you want to retrieve.

      Parameters:
      userIdentifier - The identifier for the user whose identity context you want to retrieve.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userIdentifier

      default GetIdentityContextRequest.Builder userIdentifier(Consumer<UserIdentifier.Builder> userIdentifier)

      The identifier for the user whose identity context you want to retrieve.

      This is a convenience method that creates an instance of the UserIdentifier.Builder avoiding the need to create one manually via UserIdentifier.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userIdentifier(UserIdentifier).

      Parameters:
      userIdentifier - a consumer that will call methods on UserIdentifier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • namespace

      GetIdentityContextRequest.Builder namespace(String namespace)

      The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.

      Parameters:
      namespace - The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionExpiresAt

      GetIdentityContextRequest.Builder sessionExpiresAt(Instant sessionExpiresAt)

      The timestamp at which the session will expire.

      Parameters:
      sessionExpiresAt - The timestamp at which the session will expire.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contextRegion

      GetIdentityContextRequest.Builder contextRegion(String contextRegion)

      The region in which the context is to be used. Use this parameter to obtain an identity context for cross-region use.

      The specified region must meet the following conditions:

      • The region must be in the same Amazon Web Services partition as the region you are calling from. Cross-partition requests are not supported. For example, you cannot specify a region in the aws-cn partition when calling from a region in the aws partition.

      • It must be a valid Amazon QuickSight supported region.

      • The calling customer account must be enabled in the specified context region.

      • This parameter is not supported when calling from an opt-in region.

      Parameters:
      contextRegion - The region in which the context is to be used. Use this parameter to obtain an identity context for cross-region use.

      The specified region must meet the following conditions:

      • The region must be in the same Amazon Web Services partition as the region you are calling from. Cross-partition requests are not supported. For example, you cannot specify a region in the aws-cn partition when calling from a region in the aws partition.

      • It must be a valid Amazon QuickSight supported region.

      • The calling customer account must be enabled in the specified context region.

      • This parameter is not supported when calling from an opt-in region.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetIdentityContextRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetIdentityContextRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.