Package software.amazon.awssdk.services.verifiedpermissions.model

Class BatchIsAuthorizedWithTokenRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.verifiedpermissions.model.VerifiedPermissionsRequest

software.amazon.awssdk.services.verifiedpermissions.model.BatchIsAuthorizedWithTokenRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchIsAuthorizedWithTokenRequest.Builder,BatchIsAuthorizedWithTokenRequest>

@Generated("software.amazon.awssdk:codegen")
public final class BatchIsAuthorizedWithTokenRequest
extends VerifiedPermissionsRequest
implements ToCopyableBuilder<BatchIsAuthorizedWithTokenRequest.Builder,BatchIsAuthorizedWithTokenRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchIsAuthorizedWithTokenRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	Specifies an access token for the principal that you want to authorize in each request.
static BatchIsAuthorizedWithTokenRequest.Builder	builder()
EntitiesDefinition	entities()	Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRequests()	For responses, this returns true if the service returned a value for the Requests property.
String	identityToken()	Specifies an identity (ID) token for the principal that you want to authorize in each request.
String	policyStoreId()	Specifies the ID of the policy store.
List<BatchIsAuthorizedWithTokenInputItem>	requests()	An array of up to 30 requests that you want Verified Permissions to evaluate.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchIsAuthorizedWithTokenRequest.Builder>	serializableBuilderClass()
BatchIsAuthorizedWithTokenRequest.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

policyStoreId

public final String policyStoreId()

Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

Returns:

Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

identityToken

public final String identityToken()

Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

Returns:

Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

accessToken

public final String accessToken()

Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

Returns:

Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

entities

public final EntitiesDefinition entities()

Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.

You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

• The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

• For action entities, you can include only their Identifier and EntityType.

Returns:

Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.

You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

• The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

• For action entities, you can include only their Identifier and EntityType.

hasRequests

public final boolean hasRequests()

For responses, this returns true if the service returned a value for the Requests 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.

requests

public final List<BatchIsAuthorizedWithTokenInputItem> requests()

An array of up to 30 requests that you want Verified Permissions to evaluate.

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 hasRequests() method.

Returns:

An array of up to 30 requests that you want Verified Permissions to evaluate.

toBuilder

public BatchIsAuthorizedWithTokenRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchIsAuthorizedWithTokenRequest.Builder,BatchIsAuthorizedWithTokenRequest>

Specified by:

toBuilder in class VerifiedPermissionsRequest

builder

public static BatchIsAuthorizedWithTokenRequest.Builder builder()

serializableBuilderClass

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