java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3control.model.S3ControlRequest
    - - software.amazon.awssdk.services.s3control.model.ListAccessGrantsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListAccessGrantsRequest.Builder,ListAccessGrantsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListAccessGrantsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accountId()`	The ID of the Amazon Web Services account that is making this request.
`String`	`applicationArn()`	The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
`static ListAccessGrantsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`granteeIdentifier()`	The unique identifer of the `Grantee`.
`GranteeType`	`granteeType()`	The type of the grantee to which access has been granted.
`String`	`granteeTypeAsString()`	The type of the grantee to which access has been granted.
`String`	`grantScope()`	The S3 path of the data to which you are granting access.
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of access grants that you would like returned in the `List Access Grants` response.
`String`	`nextToken()`	A pagination token to request the next page of results.
`Permission`	`permission()`	The type of permission granted to your S3 data, which can be set to one of the following values:
`String`	`permissionAsString()`	The type of permission granted to your S3 data, which can be set to one of the following values:
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListAccessGrantsRequest.Builder>`	`serializableBuilderClass()`
`ListAccessGrantsRequest.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
  - accountId
```
public final String accountId()
```
    The ID of the Amazon Web Services account that is making this request.
    
    Returns:
    
    The ID of the Amazon Web Services account that is making this request.
  - nextToken
```
public final String nextToken()
```
    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.
    
    Returns:
    
    A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.
    
    Returns:
    
    The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.
  - granteeType
```
public final GranteeType granteeType()
```
    The type of the grantee to which access has been granted. It can be one of the following values:
    
    IAM - An IAM user or role.
    
    DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    If the service returns an enum value that is not available in the current SDK version, granteeType will return GranteeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granteeTypeAsString().
    Returns:
    
    The type of the grantee to which access has been granted. It can be one of the following values:
    
    IAM - An IAM user or role.
    
    DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    See Also:
    
    GranteeType
  - granteeTypeAsString
```
public final String granteeTypeAsString()
```
    The type of the grantee to which access has been granted. It can be one of the following values:
    
    IAM - An IAM user or role.
    
    DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    If the service returns an enum value that is not available in the current SDK version, granteeType will return GranteeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granteeTypeAsString().
    Returns:
    
    The type of the grantee to which access has been granted. It can be one of the following values:
    
    IAM - An IAM user or role.
    
    DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
    
    See Also:
    
    GranteeType
  - granteeIdentifier
```
public final String granteeIdentifier()
```
    The unique identifer of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.
    
    Returns:
    
    The unique identifer of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.
  - permission
```
public final Permission permission()
```
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().
    Returns:
    
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    See Also:
    
    Permission
  - permissionAsString
```
public final String permissionAsString()
```
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().
    Returns:
    
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    See Also:
    
    Permission
  - grantScope
```
public final String grantScope()
```
    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
    
    Returns:
    
    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
  - applicationArn
```
public final String applicationArn()
```
    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
  - toBuilder
```
public ListAccessGrantsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListAccessGrantsRequest.Builder,ListAccessGrantsRequest>
    
    Specified by:
    
    toBuilder in class S3ControlRequest
  - builder
```
public static ListAccessGrantsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListAccessGrantsRequest.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

Class ListAccessGrantsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

accountId

nextToken

maxResults

granteeType

granteeTypeAsString

granteeIdentifier

permission

permissionAsString

grantScope

applicationArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields