List Access Grants
s3control_list_access_grants | R Documentation |
Returns the list of access grants in your S3 Access Grants instance¶
Description¶
Returns the list of access grants in your S3 Access Grants instance.
Permissions¶
You must have the s3:ListAccessGrants
permission to use this
operation.
Usage¶
s3control_list_access_grants(AccountId, NextToken, MaxResults,
GranteeType, GranteeIdentifier, Permission, GrantScope, ApplicationArn)
Arguments¶
AccountId
[required] The ID of the Amazon Web Services account that is making this request.
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.MaxResults
The maximum number of access grants that you would like returned in the
List Access Grants
response. If the results include the pagination tokenNextToken
, make another call using theNextToken
to determine if there are more results.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.
GranteeIdentifier
The unique identifer of the
Grantee
. If the grantee type isIAM
, 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 formata1b2c3d4-5678-90ab-cdef-EXAMPLE11111
. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.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.
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.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.
Value¶
A list with the following syntax:
list(
NextToken = "string",
AccessGrantsList = list(
list(
CreatedAt = as.POSIXct(
"2015-01-01"
),
AccessGrantId = "string",
AccessGrantArn = "string",
Grantee = list(
GranteeType = "DIRECTORY_USER"|"DIRECTORY_GROUP"|"IAM",
GranteeIdentifier = "string"
),
Permission = "READ"|"WRITE"|"READWRITE",
AccessGrantsLocationId = "string",
AccessGrantsLocationConfiguration = list(
S3SubPrefix = "string"
),
GrantScope = "string",
ApplicationArn = "string"
)
)
)