ListAccessGrantEntry
Information about the access grant.
Contents
- AccessGrantArn
-
The Amazon Resource Name (ARN) of the access grant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:access\-grants\/grant/[a-zA-Z0-9\-]+
Required: No
- AccessGrantId
-
The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9\-]+
Required: No
- AccessGrantsLocationConfiguration
-
The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
Type: AccessGrantsLocationConfiguration data type
Required: No
- AccessGrantsLocationId
-
The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID
default
to the default locations3://
and assigns an auto-generated ID to other locations that you register.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9\-]+
Required: No
- ApplicationArn
-
The Amazon Resource Name (ARN) of an Amazon 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.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 1224.
Pattern:
arn:[^:]+:sso::\d{12}:application/.*$
Required: No
- CreatedAt
-
The date and time when you created the S3 Access Grants instance.
Type: Timestamp
Required: No
- Grantee
-
The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.
Type: Grantee data type
Required: No
- 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
^.+$
Required: No
- Permission
-
The type of access 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.
Type: String
Valid Values:
READ | WRITE | READWRITE
Required: No
-
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: