Class: Aws::S3Control::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::S3Control::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb
Overview
An API client for S3Control. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::S3Control::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_access_point(params = {}) ⇒ Types::CreateAccessPointResult
Creates an access point and associates it with the specified bucket.
-
#create_access_point_for_object_lambda(params = {}) ⇒ Types::CreateAccessPointForObjectLambdaResult
Creates an Object Lambda Access Point.
-
#create_bucket(params = {}) ⇒ Types::CreateBucketResult
This action creates an Amazon S3 on Outposts bucket. -
#create_job(params = {}) ⇒ Types::CreateJobResult
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
-
#create_multi_region_access_point(params = {}) ⇒ Types::CreateMultiRegionAccessPointResult
Creates a Multi-Region Access Point and associates it with the specified buckets.
-
#delete_access_point(params = {}) ⇒ Struct
Deletes the specified access point.
-
#delete_access_point_for_object_lambda(params = {}) ⇒ Struct
Deletes the specified Object Lambda Access Point.
-
#delete_access_point_policy(params = {}) ⇒ Struct
Deletes the access point policy for the specified access point.
-
#delete_access_point_policy_for_object_lambda(params = {}) ⇒ Struct
Removes the resource policy for an Object Lambda Access Point.
-
#delete_bucket(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket. -
#delete_bucket_lifecycle_configuration(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. -
#delete_bucket_policy(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket policy. -
#delete_bucket_replication(params = {}) ⇒ Struct
This operation deletes an Amazon S3 on Outposts bucket's replication configuration. -
#delete_bucket_tagging(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket's tags. -
#delete_job_tagging(params = {}) ⇒ Struct
Removes the entire tag set from the specified S3 Batch Operations job.
-
#delete_multi_region_access_point(params = {}) ⇒ Types::DeleteMultiRegionAccessPointResult
Deletes a Multi-Region Access Point.
-
#delete_public_access_block(params = {}) ⇒ Struct
Removes the
PublicAccessBlock
configuration for an Amazon Web Services account. -
#delete_storage_lens_configuration(params = {}) ⇒ Struct
Deletes the Amazon S3 Storage Lens configuration.
-
#delete_storage_lens_configuration_tagging(params = {}) ⇒ Struct
Deletes the Amazon S3 Storage Lens configuration tags.
-
#describe_job(params = {}) ⇒ Types::DescribeJobResult
Retrieves the configuration parameters and status for a Batch Operations job.
-
#describe_multi_region_access_point_operation(params = {}) ⇒ Types::DescribeMultiRegionAccessPointOperationResult
Retrieves the status of an asynchronous request to manage a Multi-Region Access Point.
-
#get_access_point(params = {}) ⇒ Types::GetAccessPointResult
Returns configuration information about the specified access point.
-
#get_access_point_configuration_for_object_lambda(params = {}) ⇒ Types::GetAccessPointConfigurationForObjectLambdaResult
Returns configuration for an Object Lambda Access Point.
-
#get_access_point_for_object_lambda(params = {}) ⇒ Types::GetAccessPointForObjectLambdaResult
Returns configuration information about the specified Object Lambda Access Point.
-
#get_access_point_policy(params = {}) ⇒ Types::GetAccessPointPolicyResult
Returns the access point policy associated with the specified access point.
-
#get_access_point_policy_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyForObjectLambdaResult
Returns the resource policy for an Object Lambda Access Point.
-
#get_access_point_policy_status(params = {}) ⇒ Types::GetAccessPointPolicyStatusResult
Indicates whether the specified access point currently has a policy that allows public access.
-
#get_access_point_policy_status_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyStatusForObjectLambdaResult
Returns the status of the resource policy associated with an Object Lambda Access Point.
-
#get_bucket(params = {}) ⇒ Types::GetBucketResult
Gets an Amazon S3 on Outposts bucket.
-
#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationResult
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. -
#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyResult
This action gets a bucket policy for an Amazon S3 on Outposts bucket. -
#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationResult
This operation gets an Amazon S3 on Outposts bucket's replication configuration. -
#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingResult
This action gets an Amazon S3 on Outposts bucket's tags. -
#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningResult
This operation returns the versioning state for S3 on Outposts buckets only. -
#get_job_tagging(params = {}) ⇒ Types::GetJobTaggingResult
Returns the tags on an S3 Batch Operations job.
-
#get_multi_region_access_point(params = {}) ⇒ Types::GetMultiRegionAccessPointResult
Returns configuration information about the specified Multi-Region Access Point.
-
#get_multi_region_access_point_policy(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyResult
Returns the access control policy of the specified Multi-Region Access Point.
-
#get_multi_region_access_point_policy_status(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyStatusResult
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
-
#get_multi_region_access_point_routes(params = {}) ⇒ Types::GetMultiRegionAccessPointRoutesResult
Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
-
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
Retrieves the
PublicAccessBlock
configuration for an Amazon Web Services account. -
#get_storage_lens_configuration(params = {}) ⇒ Types::GetStorageLensConfigurationResult
Gets the Amazon S3 Storage Lens configuration.
-
#get_storage_lens_configuration_tagging(params = {}) ⇒ Types::GetStorageLensConfigurationTaggingResult
Gets the tags of Amazon S3 Storage Lens configuration.
-
#list_access_points(params = {}) ⇒ Types::ListAccessPointsResult
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(params = {}) ⇒ Types::ListAccessPointsForObjectLambdaResult
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResult
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(params = {}) ⇒ Types::ListMultiRegionAccessPointsResult
Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
-
#list_regional_buckets(params = {}) ⇒ Types::ListRegionalBucketsResult
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
-
#list_storage_lens_configurations(params = {}) ⇒ Types::ListStorageLensConfigurationsResult
Gets a list of Amazon S3 Storage Lens configurations.
-
#put_access_point_configuration_for_object_lambda(params = {}) ⇒ Struct
Replaces configuration for an Object Lambda Access Point.
-
#put_access_point_policy(params = {}) ⇒ Struct
Associates an access policy with the specified access point.
-
#put_access_point_policy_for_object_lambda(params = {}) ⇒ Struct
Creates or replaces resource policy for an Object Lambda Access Point.
-
#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. -
#put_bucket_policy(params = {}) ⇒ Struct
This action puts a bucket policy to an Amazon S3 on Outposts bucket. -
#put_bucket_replication(params = {}) ⇒ Struct
This action creates an Amazon S3 on Outposts bucket's replication configuration. -
#put_bucket_tagging(params = {}) ⇒ Struct
This action puts tags on an Amazon S3 on Outposts bucket. -
#put_bucket_versioning(params = {}) ⇒ Struct
This operation sets the versioning state for S3 on Outposts buckets only. -
#put_job_tagging(params = {}) ⇒ Struct
Sets the supplied tag-set on an S3 Batch Operations job.
-
#put_multi_region_access_point_policy(params = {}) ⇒ Types::PutMultiRegionAccessPointPolicyResult
Associates an access control policy with the specified Multi-Region Access Point.
-
#put_public_access_block(params = {}) ⇒ Struct
Creates or modifies the
PublicAccessBlock
configuration for an Amazon Web Services account. -
#put_storage_lens_configuration(params = {}) ⇒ Struct
Puts an Amazon S3 Storage Lens configuration.
-
#put_storage_lens_configuration_tagging(params = {}) ⇒ Struct
Put or replace tags on an existing Amazon S3 Storage Lens configuration.
-
#submit_multi_region_access_point_routes(params = {}) ⇒ Struct
Submits an updated route configuration for a Multi-Region Access Point.
-
#update_job_priority(params = {}) ⇒ Types::UpdateJobPriorityResult
Updates an existing S3 Batch Operations job's priority.
-
#update_job_status(params = {}) ⇒ Types::UpdateJobStatusResult
Updates the status for the specified job.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
397 398 399 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 397 def initialize(*args) super end |
Instance Method Details
#create_access_point(params = {}) ⇒ Types::CreateAccessPointResult
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to CreateAccessPoint
:
517 518 519 520 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 517 def create_access_point(params = {}, = {}) req = build_request(:create_access_point, params) req.send_request() end |
#create_access_point_for_object_lambda(params = {}) ⇒ Types::CreateAccessPointForObjectLambdaResult
Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to
CreateAccessPointForObjectLambda
:
590 591 592 593 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 590 def create_access_point_for_object_lambda(params = {}, = {}) req = build_request(:create_access_point_for_object_lambda, params) req.send_request() end |
#create_bucket(params = {}) ⇒ Types::CreateBucketResult
Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets support:
Tags
LifecycleConfigurations for deleting expired objects
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.
For an example of the request syntax for Amazon S3 on Outposts that
uses the S3 on Outposts endpoint hostname prefix and
x-amz-outpost-id
in your API request, see the Examples section.
The following actions are related to CreateBucket
for Amazon S3 on
Outposts:
748 749 750 751 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 748 def create_bucket(params = {}, = {}) req = build_request(:create_bucket, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResult
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
This action creates a S3 Batch Operations job.
Related actions include:
1011 1012 1013 1014 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1011 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_multi_region_access_point(params = {}) ⇒ Types::CreateMultiRegionAccessPointResult
Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a
response before the command has completed. When this request provides
a response, it provides a token that you can use to monitor the status
of the request with DescribeMultiRegionAccessPointOperation
.
The following actions are related to CreateMultiRegionAccessPoint
:
1100 1101 1102 1103 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1100 def create_multi_region_access_point(params = {}, = {}) req = build_request(:create_multi_region_access_point, params) req.send_request() end |
#delete_access_point(params = {}) ⇒ Struct
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint
:
1163 1164 1165 1166 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1163 def delete_access_point(params = {}, = {}) req = build_request(:delete_access_point, params) req.send_request() end |
#delete_access_point_for_object_lambda(params = {}) ⇒ Struct
Deletes the specified Object Lambda Access Point.
The following actions are related to
DeleteAccessPointForObjectLambda
:
1205 1206 1207 1208 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1205 def delete_access_point_for_object_lambda(params = {}, = {}) req = build_request(:delete_access_point_for_object_lambda, params) req.send_request() end |
#delete_access_point_policy(params = {}) ⇒ Struct
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy
:
1266 1267 1268 1269 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1266 def delete_access_point_policy(params = {}, = {}) req = build_request(:delete_access_point_policy, params) req.send_request() end |
#delete_access_point_policy_for_object_lambda(params = {}) ⇒ Struct
Removes the resource policy for an Object Lambda Access Point.
The following actions are related to
DeleteAccessPointPolicyForObjectLambda
:
1306 1307 1308 1309 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1306 def delete_access_point_policy_for_object_lambda(params = {}, = {}) req = build_request(:delete_access_point_policy_for_object_lambda, params) req.send_request() end |
#delete_bucket(params = {}) ⇒ Struct
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
Related Resources
1378 1379 1380 1381 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1378 def delete_bucket(params = {}, = {}) req = build_request(:delete_bucket, params) req.send_request() end |
#delete_bucket_lifecycle_configuration(params = {}) ⇒ Struct
Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3-outposts:DeleteLifecycleConfiguration
action. By default, the
bucket owner has this permission and the Outposts bucket owner can
grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
1460 1461 1462 1463 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1460 def delete_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:delete_bucket_lifecycle_configuration, params) req.send_request() end |
#delete_bucket_policy(params = {}) ⇒ Struct
This implementation of the DELETE action uses the policy subresource
to delete the policy of a specified Amazon S3 on Outposts bucket. If
you are using an identity other than the root user of the Amazon Web
Services account that owns the bucket, the calling identity must have
the s3-outposts:DeleteBucketPolicy
permissions on the specified
Outposts bucket and belong to the bucket owner's account to use this
action. For more information, see Using Amazon S3 on Outposts in
Amazon S3 User Guide.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns
a 403 Access Denied
error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy
:
1548 1549 1550 1551 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1548 def delete_bucket_policy(params = {}, = {}) req = build_request(:delete_bucket_policy, params) req.send_request() end |
#delete_bucket_replication(params = {}) ⇒ Struct
Deletes the replication configuration from the specified S3 on Outposts bucket.
To use this operation, you must have permissions to perform the
s3-outposts:PutReplicationConfiguration
action. The Outposts bucket
owner has this permission by default and can grant it to others. For
more information about permissions, see Setting up IAM with S3 on
Outposts and Managing access to S3 on Outposts buckets in the
Amazon S3 User Guide.
PUT
or DELETE
requests for a
replication configuration to all S3 on Outposts systems. Therefore,
the replication configuration that's returned by a GET
request soon
after a PUT
or DELETE
request might return a more recent result
than what's on the Outpost. If an Outpost is offline, the delay in
updating the replication configuration on that Outpost can be
significant.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
The following operations are related to DeleteBucketReplication
:
1641 1642 1643 1644 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1641 def delete_bucket_replication(params = {}, = {}) req = build_request(:delete_bucket_replication, params) req.send_request() end |
#delete_bucket_tagging(params = {}) ⇒ Struct
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the
PutBucketTagging
action. By default, the bucket owner has this
permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging
:
1714 1715 1716 1717 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1714 def delete_bucket_tagging(params = {}, = {}) req = build_request(:delete_bucket_tagging, params) req.send_request() end |
#delete_job_tagging(params = {}) ⇒ Struct
Removes the entire tag set from the specified S3 Batch Operations job.
To use the DeleteJobTagging
operation, you must have permission to
perform the s3:DeleteJobTagging
action. For more information, see
Controlling access and labeling jobs using tags in the Amazon S3
User Guide.
Related actions include:
1762 1763 1764 1765 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1762 def delete_job_tagging(params = {}, = {}) req = build_request(:delete_job_tagging, params) req.send_request() end |
#delete_multi_region_access_point(params = {}) ⇒ Types::DeleteMultiRegionAccessPointResult
Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a
response before the command has completed. When this request provides
a response, it provides a token that you can use to monitor the status
of the request with DescribeMultiRegionAccessPointOperation
.
The following actions are related to DeleteMultiRegionAccessPoint
:
1836 1837 1838 1839 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1836 def delete_multi_region_access_point(params = {}, = {}) req = build_request(:delete_multi_region_access_point, params) req.send_request() end |
#delete_public_access_block(params = {}) ⇒ Struct
Removes the PublicAccessBlock
configuration for an Amazon Web
Services account. For more information, see Using Amazon S3 block
public access.
Related actions include:
1873 1874 1875 1876 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1873 def delete_public_access_block(params = {}, = {}) req = build_request(:delete_public_access_block, params) req.send_request() end |
#delete_storage_lens_configuration(params = {}) ⇒ Struct
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
s3:DeleteStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
1913 1914 1915 1916 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1913 def delete_storage_lens_configuration(params = {}, = {}) req = build_request(:delete_storage_lens_configuration, params) req.send_request() end |
#delete_storage_lens_configuration_tagging(params = {}) ⇒ Struct
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
s3:DeleteStorageLensConfigurationTagging
action. For more
information, see Setting permissions to use Amazon S3 Storage
Lens in the Amazon S3 User Guide.
1954 1955 1956 1957 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1954 def delete_storage_lens_configuration_tagging(params = {}, = {}) req = build_request(:delete_storage_lens_configuration_tagging, params) req.send_request() end |
#describe_job(params = {}) ⇒ Types::DescribeJobResult
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
2108 2109 2110 2111 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2108 def describe_job(params = {}, = {}) req = build_request(:describe_job, params) req.send_request() end |
#describe_multi_region_access_point_operation(params = {}) ⇒ Types::DescribeMultiRegionAccessPointOperationResult
Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPoint
:
2187 2188 2189 2190 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2187 def describe_multi_region_access_point_operation(params = {}, = {}) req = build_request(:describe_multi_region_access_point_operation, params) req.send_request() end |
#get_access_point(params = {}) ⇒ Types::GetAccessPointResult
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to GetAccessPoint
:
2281 2282 2283 2284 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2281 def get_access_point(params = {}, = {}) req = build_request(:get_access_point, params) req.send_request() end |
#get_access_point_configuration_for_object_lambda(params = {}) ⇒ Types::GetAccessPointConfigurationForObjectLambdaResult
Returns configuration for an Object Lambda Access Point.
The following actions are related to
GetAccessPointConfigurationForObjectLambda
:
^
2334 2335 2336 2337 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2334 def get_access_point_configuration_for_object_lambda(params = {}, = {}) req = build_request(:get_access_point_configuration_for_object_lambda, params) req.send_request() end |
#get_access_point_for_object_lambda(params = {}) ⇒ Types::GetAccessPointForObjectLambdaResult
Returns configuration information about the specified Object Lambda Access Point
The following actions are related to GetAccessPointForObjectLambda
:
2392 2393 2394 2395 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2392 def get_access_point_for_object_lambda(params = {}, = {}) req = build_request(:get_access_point_for_object_lambda, params) req.send_request() end |
#get_access_point_policy(params = {}) ⇒ Types::GetAccessPointPolicyResult
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy
:
2449 2450 2451 2452 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2449 def get_access_point_policy(params = {}, = {}) req = build_request(:get_access_point_policy, params) req.send_request() end |
#get_access_point_policy_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyForObjectLambdaResult
Returns the resource policy for an Object Lambda Access Point.
The following actions are related to
GetAccessPointPolicyForObjectLambda
:
2494 2495 2496 2497 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2494 def get_access_point_policy_for_object_lambda(params = {}, = {}) req = build_request(:get_access_point_policy_for_object_lambda, params) req.send_request() end |
#get_access_point_policy_status(params = {}) ⇒ Types::GetAccessPointPolicyStatusResult
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide.
2533 2534 2535 2536 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2533 def get_access_point_policy_status(params = {}, = {}) req = build_request(:get_access_point_policy_status, params) req.send_request() end |
#get_access_point_policy_status_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyStatusForObjectLambdaResult
Returns the status of the resource policy associated with an Object Lambda Access Point.
2567 2568 2569 2570 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2567 def get_access_point_policy_status_for_object_lambda(params = {}, = {}) req = build_request(:get_access_point_policy_status_for_object_lambda, params) req.send_request() end |
#get_bucket(params = {}) ⇒ Types::GetBucketResult
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon
Web Services account that owns the Outposts bucket, the calling
identity must have the s3-outposts:GetBucket
permissions on the
specified Outposts bucket and belong to the Outposts bucket owner's
account in order to use this action. Only users from Outposts bucket
owner account with the right permissions can perform actions on an
Outposts bucket.
If you don't have s3-outposts:GetBucket
permissions or you're not
using an identity that belongs to the bucket owner's account, Amazon
S3 returns a 403 Access Denied
error.
The following actions are related to GetBucket
for Amazon S3 on
Outposts:
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
2654 2655 2656 2657 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2654 def get_bucket(params = {}, = {}) req = build_request(:get_bucket, params) req.send_request() end |
#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationResult
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3-outposts:GetLifecycleConfiguration
action. The Outposts bucket
owner has this permission, by default. The bucket owner can grant this
permission to others. For more information about permissions, see
Permissions Related to Bucket Subresource Operations and
Managing Access Permissions to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
GetBucketLifecycleConfiguration
has the following special error:
Error code:
NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following actions are related to
GetBucketLifecycleConfiguration
:
2777 2778 2779 2780 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2777 def get_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:get_bucket_lifecycle_configuration, params) req.send_request() end |
#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyResult
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon
Web Services account that owns the bucket, the calling identity must
have the GetBucketPolicy
permissions on the specified bucket and
belong to the bucket owner's account in order to use this action.
Only users from Outposts bucket owner account with the right
permissions can perform actions on an Outposts bucket. If you don't
have s3-outposts:GetBucketPolicy
permissions or you're not using an
identity that belongs to the bucket owner's account, Amazon S3
returns a 403 Access Denied
error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to GetBucketPolicy
:
2875 2876 2877 2878 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2875 def get_bucket_policy(params = {}, = {}) req = build_request(:get_bucket_policy, params) req.send_request() end |
#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationResult
Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
PUT
or DELETE
requests for a
replication configuration to all S3 on Outposts systems. Therefore,
the replication configuration that's returned by a GET
request soon
after a PUT
or DELETE
request might return a more recent result
than what's on the Outpost. If an Outpost is offline, the delay in
updating the replication configuration on that Outpost can be
significant.
This action requires permissions for the
s3-outposts:GetReplicationConfiguration
action. The Outposts bucket
owner has this permission by default and can grant it to others. For
more information about permissions, see Setting up IAM with S3 on
Outposts and Managing access to S3 on Outposts bucket in the
Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
If you include the Filter
element in a replication configuration,
you must also include the DeleteMarkerReplication
, Status
, and
Priority
elements. The response also returns those elements.
For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
The following operations are related to GetBucketReplication
:
3006 3007 3008 3009 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3006 def get_bucket_replication(params = {}, = {}) req = build_request(:get_bucket_replication, params) req.send_request() end |
#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingResult
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
GetBucketTagging
action. By default, the bucket owner has this
permission and can grant this permission to others.
GetBucketTagging
has the following special error:
Error code:
NoSuchTagSetError
- Description: There is no tag set associated with the bucket.
^
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to GetBucketTagging
:
3095 3096 3097 3098 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3095 def get_bucket_tagging(params = {}, = {}) req = build_request(:get_bucket_tagging, params) req.send_request() end |
#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningResult
Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
If you've never set versioning on your bucket, it has no versioning
state. In that case, the GetBucketVersioning
request does not return
a versioning state value.
For more information about versioning, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following operations are related to GetBucketVersioning
for S3
on Outposts.
3170 3171 3172 3173 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3170 def get_bucket_versioning(params = {}, = {}) req = build_request(:get_bucket_versioning, params) req.send_request() end |
#get_job_tagging(params = {}) ⇒ Types::GetJobTaggingResult
Returns the tags on an S3 Batch Operations job. To use the
GetJobTagging
operation, you must have permission to perform the
s3:GetJobTagging
action. For more information, see Controlling
access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
3226 3227 3228 3229 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3226 def get_job_tagging(params = {}, = {}) req = build_request(:get_job_tagging, params) req.send_request() end |
#get_multi_region_access_point(params = {}) ⇒ Types::GetMultiRegionAccessPointResult
Returns configuration information about the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPoint
:
3303 3304 3305 3306 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3303 def get_multi_region_access_point(params = {}, = {}) req = build_request(:get_multi_region_access_point, params) req.send_request() end |
#get_multi_region_access_point_policy(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyResult
Returns the access control policy of the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicy
:
3364 3365 3366 3367 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3364 def get_multi_region_access_point_policy(params = {}, = {}) req = build_request(:get_multi_region_access_point_policy, params) req.send_request() end |
#get_multi_region_access_point_policy_status(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyStatusResult
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicyStatus
:
3424 3425 3426 3427 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3424 def get_multi_region_access_point_policy_status(params = {}, = {}) req = build_request(:get_multi_region_access_point_policy_status, params) req.send_request() end |
#get_multi_region_access_point_routes(params = {}) ⇒ Types::GetMultiRegionAccessPointRoutesResult
Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
us-east-1
us-west-2
ap-southeast-2
ap-northeast-1
eu-west-1
3481 3482 3483 3484 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3481 def get_multi_region_access_point_routes(params = {}, = {}) req = build_request(:get_multi_region_access_point_routes, params) req.send_request() end |
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
Retrieves the PublicAccessBlock
configuration for an Amazon Web
Services account. For more information, see Using Amazon S3 block
public access.
Related actions include:
3527 3528 3529 3530 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3527 def get_public_access_block(params = {}, = {}) req = build_request(:get_public_access_block, params) req.send_request() end |
#get_storage_lens_configuration(params = {}) ⇒ Types::GetStorageLensConfigurationResult
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
s3:GetStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
3606 3607 3608 3609 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3606 def get_storage_lens_configuration(params = {}, = {}) req = build_request(:get_storage_lens_configuration, params) req.send_request() end |
#get_storage_lens_configuration_tagging(params = {}) ⇒ Types::GetStorageLensConfigurationTaggingResult
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
s3:GetStorageLensConfigurationTagging
action. For more information,
see Setting permissions to use Amazon S3 Storage Lens in the
Amazon S3 User Guide.
3655 3656 3657 3658 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3655 def get_storage_lens_configuration_tagging(params = {}, = {}) req = build_request(:get_storage_lens_configuration_tagging, params) req.send_request() end |
#list_access_points(params = {}) ⇒ Types::ListAccessPointsResult
Returns a list of the access points that are owned by the current
account that's associated with the specified bucket. You can retrieve
up to 1000 access points per call. If the specified bucket has more
than 1,000 access points (or the number specified in maxResults
,
whichever is less), the response will include a continuation token
that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to ListAccessPoints
:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3757 3758 3759 3760 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3757 def list_access_points(params = {}, = {}) req = build_request(:list_access_points, params) req.send_request() end |
#list_access_points_for_object_lambda(params = {}) ⇒ Types::ListAccessPointsForObjectLambdaResult
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.
The following actions are related to
ListAccessPointsForObjectLambda
:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3828 3829 3830 3831 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3828 def list_access_points_for_object_lambda(params = {}, = {}) req = build_request(:list_access_points_for_object_lambda, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResult
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. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3913 3914 3915 3916 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3913 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_multi_region_access_points(params = {}) ⇒ Types::ListMultiRegionAccessPointsResult
Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to ListMultiRegionAccessPoint
:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3993 3994 3995 3996 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3993 def list_multi_region_access_points(params = {}, = {}) req = build_request(:list_multi_region_access_points, params) req.send_request() end |
#list_regional_buckets(params = {}) ⇒ Types::ListRegionalBucketsResult
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
For an example of the request syntax for Amazon S3 on Outposts that
uses the S3 on Outposts endpoint hostname prefix and
x-amz-outpost-id
in your request, see the Examples section.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4055 4056 4057 4058 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4055 def list_regional_buckets(params = {}, = {}) req = build_request(:list_regional_buckets, params) req.send_request() end |
#list_storage_lens_configurations(params = {}) ⇒ Types::ListStorageLensConfigurationsResult
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
s3:ListStorageLensConfigurations
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4110 4111 4112 4113 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4110 def list_storage_lens_configurations(params = {}, = {}) req = build_request(:list_storage_lens_configurations, params) req.send_request() end |
#put_access_point_configuration_for_object_lambda(params = {}) ⇒ Struct
Replaces configuration for an Object Lambda Access Point.
The following actions are related to
PutAccessPointConfigurationForObjectLambda
:
^
4167 4168 4169 4170 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4167 def put_access_point_configuration_for_object_lambda(params = {}, = {}) req = build_request(:put_access_point_configuration_for_object_lambda, params) req.send_request() end |
#put_access_point_policy(params = {}) ⇒ Struct
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy
:
4243 4244 4245 4246 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4243 def put_access_point_policy(params = {}, = {}) req = build_request(:put_access_point_policy, params) req.send_request() end |
#put_access_point_policy_for_object_lambda(params = {}) ⇒ Struct
Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to
PutAccessPointPolicyForObjectLambda
:
4289 4290 4291 4292 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4289 def put_access_point_policy_for_object_lambda(params = {}, = {}) req = build_request(:put_access_point_policy_for_object_lambda, params) req.send_request() end |
#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to
PutBucketLifecycleConfiguration
:
4404 4405 4406 4407 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4404 def put_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:put_bucket_lifecycle_configuration, params) req.send_request() end |
#put_bucket_policy(params = {}) ⇒ Struct
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon
Web Services account that owns the Outposts bucket, the calling
identity must have the PutBucketPolicy
permissions on the specified
Outposts bucket and belong to the bucket owner's account in order to
use this action.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a
403 Access Denied
error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to PutBucketPolicy
:
4506 4507 4508 4509 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4506 def put_bucket_policy(params = {}, = {}) req = build_request(:put_bucket_policy, params) req.send_request() end |
#put_bucket_replication(params = {}) ⇒ Struct
Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
PUT
or DELETE
requests for a
replication configuration to all S3 on Outposts systems. Therefore,
the replication configuration that's returned by a GET
request soon
after a PUT
or DELETE
request might return a more recent result
than what's on the Outpost. If an Outpost is offline, the delay in
updating the replication configuration on that Outpost can be
significant.
Specify the replication configuration in the request body. In the replication configuration, you provide the following information:
The name of the destination bucket or buckets where you want S3 on Outposts to replicate objects
The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf
Other relevant information, such as replication rules
A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source Outposts bucket to
apply a replication rule to, add the Filter
element as a child of
the Rule
element. You can filter objects based on an object key
prefix, one or more object tags, or both. When you add the Filter
element in the configuration, you must also add the following
elements: DeleteMarkerReplication
, Status
, and Priority
.
Using PutBucketReplication
on Outposts requires that both the source
and destination buckets must have versioning enabled. For information
about enabling versioning on a bucket, see Managing S3 Versioning for
your S3 on Outposts bucket.
For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
Handling Replication of Encrypted Objects
Outposts buckets are encrypted at all times. All the objects in the source Outposts bucket are encrypted and can be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with the same encryption key as the objects in the source Outposts bucket.
Permissions
To create a PutBucketReplication
request, you must have
s3-outposts:PutReplicationConfiguration
permissions for the bucket.
The Outposts bucket owner has this permission by default and can grant
it to others. For more information about permissions, see Setting up
IAM with S3 on Outposts and Managing access to S3 on Outposts
buckets.
iam:CreateRole
and iam:PassRole
permissions. For more information,
see Granting a user permissions to pass a role to an Amazon Web
Services service.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following operations are related to PutBucketReplication
:
4713 4714 4715 4716 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4713 def put_bucket_replication(params = {}, = {}) req = build_request(:put_bucket_replication, params) req.send_request() end |
#put_bucket_tagging(params = {}) ⇒ Struct
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.
To use this action, you must have permissions to perform the
s3-outposts:PutBucketTagging
action. The Outposts bucket owner has
this permission by default and can grant this permission to others.
For more information about permissions, see Permissions Related to
Bucket Subresource Operations and Managing access permissions to
your Amazon S3 resources.
PutBucketTagging
has the following special errors:
Error code:
InvalidTagError
- Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
^
Error code:
MalformedXMLError
- Description: The XML provided does not match the schema.
^
Error code:
OperationAbortedError
- Description: A conflicting conditional action is currently in progress against this resource. Try again.
^
Error code:
InternalError
- Description: The service was unable to apply the provided tag to the bucket.
^
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to PutBucketTagging
:
4852 4853 4854 4855 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4852 def put_bucket_tagging(params = {}, = {}) req = build_request(:put_bucket_tagging, params) req.send_request() end |
#put_bucket_versioning(params = {}) ⇒ Struct
Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
You can set the versioning state to one of the following:
Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID
null
.
If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.
When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.
If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following operations are related to PutBucketVersioning
for S3
on Outposts.
4952 4953 4954 4955 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4952 def put_bucket_versioning(params = {}, = {}) req = build_request(:put_bucket_versioning, params) req.send_request() end |
#put_job_tagging(params = {}) ⇒ Struct
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
A few things to consider about using tags:
Amazon S3 limits the maximum number of tags to 50 tags per job.
You can associate up to 50 tags with a job as long as they have unique tag keys.
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
The key and values are case sensitive.
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.
To use the PutJobTagging
operation, you must have permission to
perform the s3:PutJobTagging
action.
Related actions include:
5049 5050 5051 5052 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5049 def put_job_tagging(params = {}, = {}) req = build_request(:put_job_tagging, params) req.send_request() end |
#put_multi_region_access_point_policy(params = {}) ⇒ Types::PutMultiRegionAccessPointPolicyResult
Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to
PutMultiRegionAccessPointPolicy
:
5115 5116 5117 5118 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5115 def put_multi_region_access_point_policy(params = {}, = {}) req = build_request(:put_multi_region_access_point_policy, params) req.send_request() end |
#put_public_access_block(params = {}) ⇒ Struct
Creates or modifies the PublicAccessBlock
configuration for an
Amazon Web Services account. For this operation, users must have the
s3:PutAccountPublicAccessBlock
permission. For more information, see
Using Amazon S3 block public access.
Related actions include:
5163 5164 5165 5166 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5163 def put_public_access_block(params = {}, = {}) req = build_request(:put_public_access_block, params) req.send_request() end |
#put_storage_lens_configuration(params = {}) ⇒ Struct
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
s3:PutStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
5295 5296 5297 5298 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5295 def put_storage_lens_configuration(params = {}, = {}) req = build_request(:put_storage_lens_configuration, params) req.send_request() end |
#put_storage_lens_configuration_tagging(params = {}) ⇒ Struct
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
s3:PutStorageLensConfigurationTagging
action. For more information,
see Setting permissions to use Amazon S3 Storage Lens in the
Amazon S3 User Guide.
5349 5350 5351 5352 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5349 def put_storage_lens_configuration_tagging(params = {}, = {}) req = build_request(:put_storage_lens_configuration_tagging, params) req.send_request() end |
#submit_multi_region_access_point_routes(params = {}) ⇒ Struct
Submits an updated route configuration for a Multi-Region Access
Point. This API operation updates the routing status for the specified
Regions from active to passive, or from passive to active. A value of
0
indicates a passive status, which means that traffic won't be
routed to the specified Region. A value of 100
indicates an active
status, which means that traffic will be routed to the specified
Region. At least one Region must be active at all times.
When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged.
To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
us-east-1
us-west-2
ap-southeast-2
ap-northeast-1
eu-west-1
5423 5424 5425 5426 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5423 def submit_multi_region_access_point_routes(params = {}, = {}) req = build_request(:submit_multi_region_access_point_routes, params) req.send_request() end |
#update_job_priority(params = {}) ⇒ Types::UpdateJobPriorityResult
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
5484 5485 5486 5487 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5484 def update_job_priority(params = {}, = {}) req = build_request(:update_job_priority, params) req.send_request() end |
#update_job_status(params = {}) ⇒ Types::UpdateJobStatusResult
Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
5553 5554 5555 5556 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5553 def update_job_status(params = {}, = {}) req = build_request(:update_job_status, params) req.send_request() end |