s3control: AWS S3 Control

In paws.storage: 'Amazon Web Services' Storage Services

AWS S3 Control

Description

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

Usage

s3control(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

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

create_access_point	Creates an access point and associates it with the specified bucket
create_access_point_for_object_lambda	Creates an Object Lambda Access Point
create_bucket	This action creates an Amazon S3 on Outposts bucket
create_job	You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects
create_multi_region_access_point	Creates a Multi-Region Access Point and associates it with the specified buckets
delete_access_point	Deletes the specified access point
delete_access_point_for_object_lambda	Deletes the specified Object Lambda Access Point
delete_access_point_policy	Deletes the access point policy for the specified access point
delete_access_point_policy_for_object_lambda	Removes the resource policy for an Object Lambda Access Point
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	Deletes a Multi-Region Access Point
delete_public_access_block	Removes the PublicAccessBlock configuration for an Amazon Web Services account
delete_storage_lens_configuration	Deletes the Amazon S3 Storage Lens configuration
delete_storage_lens_configuration_tagging	Deletes the Amazon S3 Storage Lens configuration tags
describe_job	Retrieves the configuration parameters and status for a Batch Operations job
describe_multi_region_access_point_operation	Retrieves the status of an asynchronous request to manage a Multi-Region Access Point
get_access_point	Returns configuration information about the specified access point
get_access_point_configuration_for_object_lambda	Returns configuration for an Object Lambda Access Point
get_access_point_for_object_lambda	Returns configuration information about the specified Object Lambda Access Point
get_access_point_policy	Returns the access point policy associated with the specified access point
get_access_point_policy_for_object_lambda	Returns the resource policy for an Object Lambda Access Point
get_access_point_policy_status	Indicates whether the specified access point currently has a policy that allows public access
get_access_point_policy_status_for_object_lambda	Returns the status of the resource policy associated with an Object Lambda Access Point
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_job_tagging	Returns the tags on an S3 Batch Operations job
get_multi_region_access_point	Returns configuration information about the specified Multi-Region Access Point
get_multi_region_access_point_policy	Returns the access control policy of the specified Multi-Region Access Point
get_multi_region_access_point_policy_status	Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access
get_multi_region_access_point_routes	Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive
get_public_access_block	Retrieves the PublicAccessBlock configuration for an Amazon Web Services account
get_storage_lens_configuration	Gets the Amazon S3 Storage Lens configuration
get_storage_lens_configuration_tagging	Gets the tags of Amazon S3 Storage Lens configuration
list_access_points	Returns a list of the access points that are owned by the current account that's associated with the specified bucket
list_access_points_for_object_lambda	Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call
list_jobs	Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request
list_multi_region_access_points	Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account
list_regional_buckets	Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request
list_storage_lens_configurations	Gets a list of Amazon S3 Storage Lens configurations
put_access_point_configuration_for_object_lambda	Replaces configuration for an Object Lambda Access Point
put_access_point_policy	Associates an access policy with the specified access point
put_access_point_policy_for_object_lambda	Creates or replaces resource policy for an Object Lambda Access Point
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	Associates an access control policy with the specified Multi-Region Access Point
put_public_access_block	Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account
put_storage_lens_configuration	Puts an Amazon S3 Storage Lens configuration
put_storage_lens_configuration_tagging	Put or replace tags on an existing Amazon S3 Storage Lens configuration
submit_multi_region_access_point_routes	Submits an updated route configuration for a Multi-Region Access Point
update_job_priority	Updates an existing S3 Batch Operations job's priority
update_job_status	Updates the status for the specified job

Examples

## Not run: 
svc <- s3control()
svc$create_access_point(
  Foo = 123
)

## End(Not run)

paws.storage documentation built on Sept. 12, 2023, 1:23 a.m.