/AWS1/CL_S3C=>CREATEACCESSGRANT()
¶
About CreateAccessGrant¶
Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.
- Permissions
-
You must have the
s3:CreateAccessGrant
permission to use this operation. - Additional Permissions
-
For any directory identity -
sso:DescribeInstance
andsso:DescribeApplication
For directory users -
identitystore:DescribeUser
For directory groups -
identitystore:DescribeGroup
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_ACCOUNTID
TYPE /AWS1/S3CACCOUNTID
/AWS1/S3CACCOUNTID
¶
The ID of the Amazon Web Services account that is making this request.
IV_ACCESSGRANTSLOCATIONID
TYPE /AWS1/S3CACCESSGRANTSLOCID
/AWS1/S3CACCESSGRANTSLOCID
¶
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.If you are passing the
default
location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in theSubprefix
field.
IO_GRANTEE
TYPE REF TO /AWS1/CL_S3CGRANTEE
/AWS1/CL_S3CGRANTEE
¶
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 Web Services 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.
IV_PERMISSION
TYPE /AWS1/S3CPERMISSION
/AWS1/S3CPERMISSION
¶
The type of access that you are granting 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.
Optional arguments:¶
IO_ACCESSGRANTSLOCATIONCONF
TYPE REF TO /AWS1/CL_S3CACCGRANTSLOCCONF
/AWS1/CL_S3CACCGRANTSLOCCONF
¶
The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the
S3SubPrefix
field. The grant scope is the result of appending the subprefix to the location scope of the registered location.
IV_APPLICATIONARN
TYPE /AWS1/S3CIDCENTERAPPLICATION00
/AWS1/S3CIDCENTERAPPLICATION00
¶
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.
IV_S3PREFIXTYPE
TYPE /AWS1/S3CS3PREFIXTYPE
/AWS1/S3CS3PREFIXTYPE
¶
The type of
S3SubPrefix
. The only possible value isObject
. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.
IT_TAGS
TYPE /AWS1/CL_S3CTAG=>TT_TAGLIST
TT_TAGLIST
¶
The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.