Client
s3control | R Documentation |
AWS S3 Control¶
Description¶
Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
Value¶
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've
assigned to the client. The available operations are listed in the
Operations section.
Service syntax¶
svc <- s3control(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
- Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance
- create_access_grant
- Creates an access grant that gives a grantee access to your S3 data
- create_access_grants_instance
- Creates an S3 Access Grants instance, which serves as a logical grouping for access grants
- create_access_grants_location
- The S3 data location that you would like to register in your S3 Access Grants instance
- create_access_point
- This operation is not supported by directory buckets
- create_access_point_for_object_lambda
- This operation is not supported by directory buckets
- create_bucket
- This action creates an Amazon S3 on Outposts bucket
- create_job
- This operation creates an S3 Batch Operations job
- create_multi_region_access_point
- This operation is not supported by directory buckets
- create_storage_lens_group
- Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID
- delete_access_grant
- Deletes the access grant from the S3 Access Grants instance
- delete_access_grants_instance
- Deletes your S3 Access Grants instance
- Deletes the resource policy of the S3 Access Grants instance
- delete_access_grants_location
- Deregisters a location from your S3 Access Grants instance
- delete_access_point
- This operation is not supported by directory buckets
- delete_access_point_for_object_lambda
- This operation is not supported by directory buckets
- delete_access_point_policy
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- delete_bucket
- This action deletes an Amazon S3 on Outposts bucket
- delete_bucket_lifecycle_configuration
- This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration
- delete_bucket_policy
- This action deletes an Amazon S3 on Outposts bucket policy
- delete_bucket_replication
- This operation deletes an Amazon S3 on Outposts bucket's replication configuration
- delete_bucket_tagging
- This action deletes an Amazon S3 on Outposts bucket's tags
- delete_job_tagging
- Removes the entire tag set from the specified S3 Batch Operations job
- delete_multi_region_access_point
- This operation is not supported by directory buckets
- delete_public_access_block
- This operation is not supported by directory buckets
- delete_storage_lens_configuration
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- delete_storage_lens_group
- Deletes an existing S3 Storage Lens group
- describe_job
- Retrieves the configuration parameters and status for a Batch Operations job
- This operation is not supported by directory buckets
- Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance
- get_access_grant
- Get the details of an access grant from your S3 Access Grants instance
- get_access_grants_instance
- Retrieves the S3 Access Grants instance for a Region in your account
- get_access_grants_instance_for_prefix
- Retrieve the S3 Access Grants instance that contains a particular prefix
- Returns the resource policy of the S3 Access Grants instance
- get_access_grants_location
- Retrieves the details of a particular location registered in your S3 Access Grants instance
- get_access_point
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- get_access_point_for_object_lambda
- This operation is not supported by directory buckets
- get_access_point_policy
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- get_access_point_policy_status
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- get_bucket
- Gets an Amazon S3 on Outposts bucket
- get_bucket_lifecycle_configuration
- This action gets an Amazon S3 on Outposts bucket's lifecycle configuration
- get_bucket_policy
- This action gets a bucket policy for an Amazon S3 on Outposts bucket
- get_bucket_replication
- This operation gets an Amazon S3 on Outposts bucket's replication configuration
- get_bucket_tagging
- This action gets an Amazon S3 on Outposts bucket's tags
- get_bucket_versioning
- This operation returns the versioning state for S3 on Outposts buckets only
- get_data_access
- Returns a temporary access credential from S3 Access Grants to the grantee or client application
- get_job_tagging
- Returns the tags on an S3 Batch Operations job
- get_multi_region_access_point
- This operation is not supported by directory buckets
- get_multi_region_access_point_policy
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- get_multi_region_access_point_routes
- This operation is not supported by directory buckets
- get_public_access_block
- This operation is not supported by directory buckets
- get_storage_lens_configuration
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- get_storage_lens_group
- Retrieves the Storage Lens group configuration details
- list_access_grants
- Returns the list of access grants in your S3 Access Grants instance
- list_access_grants_instances
- Returns a list of S3 Access Grants instances
- list_access_grants_locations
- Returns a list of the locations registered in your S3 Access Grants instance
- list_access_points
- This operation is not supported by directory buckets
- list_access_points_for_object_lambda
- This operation is not supported by directory buckets
- list_jobs
- Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request
- list_multi_region_access_points
- This operation is not supported by directory buckets
- list_regional_buckets
- This operation is not supported by directory buckets
- list_storage_lens_configurations
- This operation is not supported by directory buckets
- list_storage_lens_groups
- Lists all the Storage Lens groups in the specified home Region
- list_tags_for_resource
- This operation allows you to list all the Amazon Web Services resource tags for a specified resource
- Updates the resource policy of the S3 Access Grants instance
- This operation is not supported by directory buckets
- put_access_point_policy
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- put_bucket_lifecycle_configuration
- This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket
- put_bucket_policy
- This action puts a bucket policy to an Amazon S3 on Outposts bucket
- put_bucket_replication
- This action creates an Amazon S3 on Outposts bucket's replication configuration
- put_bucket_tagging
- This action puts tags on an Amazon S3 on Outposts bucket
- put_bucket_versioning
- This operation sets the versioning state for S3 on Outposts buckets only
- put_job_tagging
- Sets the supplied tag-set on an S3 Batch Operations job
- put_multi_region_access_point_policy
- This operation is not supported by directory buckets
- put_public_access_block
- This operation is not supported by directory buckets
- put_storage_lens_configuration
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- This operation is not supported by directory buckets
- tag_resource
- Creates a new Amazon Web Services resource tag or updates an existing resource tag
- untag_resource
- This operation removes the specified Amazon Web Services resource tags from an S3 resource
- update_access_grants_location
- Updates the IAM role of a registered location in your S3 Access Grants instance
- update_job_priority
- Updates an existing S3 Batch Operations job's priority
- update_job_status
- Updates the status for the specified job
- update_storage_lens_group
- Updates the existing Storage Lens group
Examples¶
## Not run:
svc <- s3control()
svc$associate_access_grants_identity_center(
Foo = 123
)
## End(Not run)