com.amazonaws.services.s3control.model

Class ListAccessGrantsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3control.model.ListAccessGrantsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListAccessGrantsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListAccessGrantsRequest()

Method Summary

Modifier and Type	Method and Description
ListAccessGrantsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountId() The ID of the Amazon Web Services account that is making this request.
String	getApplicationArn() The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
String	getGranteeIdentifier() The unique identifer of the Grantee.
String	getGranteeType() The type of the grantee to which access has been granted.
String	getGrantScope() The S3 path of the data to which you are granting access.
Integer	getMaxResults() The maximum number of access grants that you would like returned in the List Access Grants response.
String	getNextToken() A pagination token to request the next page of results.
String	getPermission() The type of permission granted to your S3 data, which can be set to one of the following values:
int	hashCode()
void	setAccountId(String accountId) The ID of the Amazon Web Services account that is making this request.
void	setApplicationArn(String applicationArn) The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
void	setGranteeIdentifier(String granteeIdentifier) The unique identifer of the Grantee.
void	setGranteeType(String granteeType) The type of the grantee to which access has been granted.
void	setGrantScope(String grantScope) The S3 path of the data to which you are granting access.
void	setMaxResults(Integer maxResults) The maximum number of access grants that you would like returned in the List Access Grants response.
void	setNextToken(String nextToken) A pagination token to request the next page of results.
void	setPermission(String permission) The type of permission granted to your S3 data, which can be set to one of the following values:
String	toString() Returns a string representation of this object.
ListAccessGrantsRequest	withAccountId(String accountId) The ID of the Amazon Web Services account that is making this request.
ListAccessGrantsRequest	withApplicationArn(String applicationArn) The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
ListAccessGrantsRequest	withGranteeIdentifier(String granteeIdentifier) The unique identifer of the Grantee.
ListAccessGrantsRequest	withGranteeType(GranteeType granteeType) The type of the grantee to which access has been granted.
ListAccessGrantsRequest	withGranteeType(String granteeType) The type of the grantee to which access has been granted.
ListAccessGrantsRequest	withGrantScope(String grantScope) The S3 path of the data to which you are granting access.
ListAccessGrantsRequest	withMaxResults(Integer maxResults) The maximum number of access grants that you would like returned in the List Access Grants response.
ListAccessGrantsRequest	withNextToken(String nextToken) A pagination token to request the next page of results.
ListAccessGrantsRequest	withPermission(Permission permission) The type of permission granted to your S3 data, which can be set to one of the following values:
ListAccessGrantsRequest	withPermission(String permission) The type of permission granted to your S3 data, which can be set to one of the following values:

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListAccessGrantsRequest

public ListAccessGrantsRequest()

Method Detail

setAccountId

public void setAccountId(String accountId)

The ID of the Amazon Web Services account that is making this request.

Parameters:

accountId - The ID of the Amazon Web Services account that is making this request.

getAccountId

public String getAccountId()

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.

withAccountId

public ListAccessGrantsRequest withAccountId(String accountId)

The ID of the Amazon Web Services account that is making this request.

Parameters:

accountId - The ID of the Amazon Web Services account that is making this request.

Returns:

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

setNextToken

public void setNextToken(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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

withNextToken

public ListAccessGrantsRequest withNextToken(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.

Parameters:

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:

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

setMaxResults

public void setMaxResults(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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public ListAccessGrantsRequest withMaxResults(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.

Parameters:

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:

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

setGranteeType

public void setGranteeType(String 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.

Parameters:

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.

See Also:

GranteeType

getGranteeType

public String getGranteeType()

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.

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

withGranteeType

public ListAccessGrantsRequest withGranteeType(String 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.

Parameters:

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.

Returns:

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

See Also:

GranteeType

withGranteeType

public ListAccessGrantsRequest withGranteeType(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.

Parameters:

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.

Returns:

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

See Also:

GranteeType

setGranteeIdentifier

public void setGranteeIdentifier(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.

Parameters:

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.

getGranteeIdentifier

public String getGranteeIdentifier()

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.

withGranteeIdentifier

public ListAccessGrantsRequest withGranteeIdentifier(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.

Parameters:

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:

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

setPermission

public void setPermission(String 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.

Parameters:

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.

See Also:

Permission

getPermission

public String getPermission()

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.

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

withPermission

public ListAccessGrantsRequest withPermission(String 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.

Parameters:

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.

Returns:

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

See Also:

Permission

withPermission

public ListAccessGrantsRequest withPermission(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.

Parameters:

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.

Returns:

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

See Also:

Permission

setGrantScope

public void setGrantScope(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.

Parameters:

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.

getGrantScope

public String getGrantScope()

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.

withGrantScope

public ListAccessGrantsRequest withGrantScope(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.

Parameters:

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:

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

setApplicationArn

public void setApplicationArn(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.

Parameters:

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.

getApplicationArn

public String getApplicationArn()

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.

withApplicationArn

public ListAccessGrantsRequest withApplicationArn(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.

Parameters:

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:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListAccessGrantsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()