Class: Aws::S3Control::Types::ListAccessGrantsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3Control::Types::ListAccessGrantsRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3control/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#account_id ⇒ String
The Amazon Web Services account ID of the S3 Access Grants instance.
-
#application_arn ⇒ String
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
-
#grant_scope ⇒ String
The S3 path of the data to which you are granting access.
-
#grantee_identifier ⇒ String
The unique identifer of the ‘Grantee`.
-
#grantee_type ⇒ String
The type of the grantee to which access has been granted.
-
#max_results ⇒ Integer
The maximum number of access grants that you would like returned in the ‘List Access Grants` response.
-
#next_token ⇒ String
A pagination token to request the next page of results.
-
#permission ⇒ String
The type of permission granted to your S3 data, which can be set to one of the following values:.
Instance Attribute Details
#account_id ⇒ String
The Amazon Web Services account ID of the S3 Access Grants instance.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |
#application_arn ⇒ String
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.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |
#grant_scope ⇒ String
The S3 path of the data to which you are granting access. It is the result of appending the ‘Subprefix` to the location scope.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |
#grantee_identifier ⇒ String
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.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |
#grantee_type ⇒ String
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.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
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.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
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.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |
#permission ⇒ String
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.
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/aws-sdk-s3control/types.rb', line 4797 class ListAccessGrantsRequest < Struct.new( :account_id, :next_token, :max_results, :grantee_type, :grantee_identifier, :permission, :grant_scope, :application_arn) SENSITIVE = [] include Aws::Structure end |