software.amazon.awssdk.services.quicksight.model

Class UpdateIamPolicyAssignmentRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateIamPolicyAssignmentRequest.Builder,UpdateIamPolicyAssignmentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateIamPolicyAssignmentRequest
extends QuickSightRequest
implements ToCopyableBuilder<UpdateIamPolicyAssignmentRequest.Builder,UpdateIamPolicyAssignmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateIamPolicyAssignmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assignmentName() The name of the assignment, also called a rule.
AssignmentStatus	assignmentStatus() The status of the assignment.
String	assignmentStatusAsString() The status of the assignment.
String	awsAccountId() The ID of the Amazon Web Services account that contains the IAM policy assignment.
static UpdateIamPolicyAssignmentRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdentities() For responses, this returns true if the service returned a value for the Identities property.
Map<String,List<String>>	identities() The Amazon QuickSight users, groups, or both that you want to assign the policy to.
String	namespace() The namespace of the assignment.
String	policyArn() The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateIamPolicyAssignmentRequest.Builder>	serializableBuilderClass()
UpdateIamPolicyAssignmentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

awsAccountId

public final String awsAccountId()

The ID of the Amazon Web Services account that contains the IAM policy assignment.

Returns:

The ID of the Amazon Web Services account that contains the IAM policy assignment.

assignmentName

public final String assignmentName()

The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

Returns:

The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.

namespace

public final String namespace()

The namespace of the assignment.

Returns:

The namespace of the assignment.

assignmentStatus

public final AssignmentStatus assignmentStatus()

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

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

Returns:

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

See Also:

AssignmentStatus

assignmentStatusAsString

public final String assignmentStatusAsString()

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

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

Returns:

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

See Also:

AssignmentStatus

policyArn

public final String policyArn()

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

Returns:

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

hasIdentities

public final boolean hasIdentities()

For responses, this returns true if the service returned a value for the Identities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

identities

public final Map<String,List<String>> identities()

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIdentities() method.

Returns:

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

toBuilder

public UpdateIamPolicyAssignmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIamPolicyAssignmentRequest.Builder,UpdateIamPolicyAssignmentRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static UpdateIamPolicyAssignmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateIamPolicyAssignmentRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo