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.
-
#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_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_public_access_block(params = {}) ⇒ Struct
Removes the
PublicAccessBlock
configuration for an AWS 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.
-
#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_tagging(params = {}) ⇒ Types::GetBucketTaggingResult
This action gets an Amazon S3 on Outposts bucket's tags. -
#get_job_tagging(params = {}) ⇒ Types::GetJobTaggingResult
Returns the tags on an S3 Batch Operations job.
-
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
Retrieves the
PublicAccessBlock
configuration for an AWS 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 currently associated with the specified bucket.
-
#list_access_points_for_object_lambda(params = {}) ⇒ Types::ListAccessPointsForObjectLambdaResult
Returns a list of the access points associated with the Object Lambda Access Point.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request.
-
#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_tagging(params = {}) ⇒ Struct
This action puts tags on an Amazon S3 on Outposts bucket. -
#put_job_tagging(params = {}) ⇒ Struct
Sets the supplied tag-set on an S3 Batch Operations job.
-
#put_public_access_block(params = {}) ⇒ Struct
Creates or modifies the
PublicAccessBlock
configuration for an AWS 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.
-
#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.
340 341 342 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 340 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 Simple Storage Service User Guide.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only Access Points in the Amazon Simple Storage Service 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to CreateAccessPoint
:
452 453 454 455 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 452 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 Simple Storage Service User Guide.
The following actions are related to
CreateAccessPointForObjectLambda
:
522 523 524 525 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 522 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 Simple Storage Service 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:
681 682 683 684 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 681 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 Simple Storage Service User Guide.
This action creates a S3 Batch Operations job.
Related actions include:
910 911 912 913 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 910 def create_job(params = {}, = {}) req = build_request(:create_job, 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to DeleteAccessPoint
:
971 972 973 974 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 971 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
:
1013 1014 1015 1016 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1013 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to DeleteAccessPointPolicy
:
1073 1074 1075 1076 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1073 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
:
1113 1114 1115 1116 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1113 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 Simple Storage Service 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 and 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 using the access point ARN, see the
Examples section.
Related Resources
1186 1187 1188 1189 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1186 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 Simple Storage Service 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 and 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 using the access point ARN, see the
Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
1268 1269 1270 1271 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1268 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 AWS 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
Simple Storage Service 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 AWS 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to DeleteBucketPolicy
:
1354 1355 1356 1357 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1354 def delete_bucket_policy(params = {}, = {}) req = build_request(:delete_bucket_policy, 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 Simple Storage Service 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to DeleteBucketTagging
:
1426 1427 1428 1429 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1426 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 this 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 Simple Storage
Service User Guide.
Related actions include:
1473 1474 1475 1476 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1473 def delete_job_tagging(params = {}, = {}) req = build_request(:delete_job_tagging, params) req.send_request() end |
#delete_public_access_block(params = {}) ⇒ Struct
Removes the PublicAccessBlock
configuration for an AWS account. For
more information, see Using Amazon S3 block public access.
Related actions include:
1509 1510 1511 1512 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1509 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 Simple Storage Service User Guide.
s3:DeleteStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service User Guide.
1550 1551 1552 1553 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1550 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 Simple Storage Service User Guide.
s3:DeleteStorageLensConfigurationTagging
action. For more
information, see Setting permissions to use Amazon S3 Storage
Lens in the Amazon Simple Storage Service User Guide.
1591 1592 1593 1594 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1591 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 Simple Storage Service User Guide.
Related actions include:
1724 1725 1726 1727 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1724 def describe_job(params = {}, = {}) req = build_request(:describe_job, 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to GetAccessPoint
:
1807 1808 1809 1810 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1807 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
:
^
1860 1861 1862 1863 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1860 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
:
1915 1916 1917 1918 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1915 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
:
1971 1972 1973 1974 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1971 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
:
2016 2017 2018 2019 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2016 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 Simple Storage Service Developer Guide.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2055 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.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2089 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 Simple Storage Service User Guide.
If you are using an identity other than the root user of the AWS
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 and 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 using the access point ARN, see the
Examples section.
2175 2176 2177 2178 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2175 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 Simple Storage Service 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 and 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 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
:
2293 2294 2295 2296 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2293 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 Simple Storage Service User Guide.
If you are using an identity other than the root user of the AWS
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 AWS 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to GetBucketPolicy
:
2389 2390 2391 2392 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2389 def get_bucket_policy(params = {}, = {}) req = build_request(:get_bucket_policy, 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 Simple Storage Service 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to GetBucketTagging
:
2477 2478 2479 2480 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2477 def get_bucket_tagging(params = {}, = {}) req = build_request(:get_bucket_tagging, params) req.send_request() end |
#get_job_tagging(params = {}) ⇒ Types::GetJobTaggingResult
Returns the tags on an S3 Batch Operations job. To use this 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 Simple Storage Service User Guide.
Related actions include:
2532 2533 2534 2535 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2532 def get_job_tagging(params = {}, = {}) req = build_request(:get_job_tagging, params) req.send_request() end |
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
Retrieves the PublicAccessBlock
configuration for an AWS account.
For more information, see Using Amazon S3 block public access.
Related actions include:
2577 2578 2579 2580 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2577 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 Simple Storage Service User Guide.
s3:GetStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service User Guide.
2646 2647 2648 2649 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2646 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 Simple Storage Service User Guide.
s3:GetStorageLensConfigurationTagging
action. For more information,
see Setting permissions to use Amazon S3 Storage Lens in the
Amazon Simple Storage Service User Guide.
2695 2696 2697 2698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2695 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 currently 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 and 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 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.
2794 2795 2796 2797 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2794 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 a list of the access points associated with the Object Lambda
Access Point. You can retrieve up to 1000 access points per call. If
there are 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.
The following actions are related to
ListAccessPointsForObjectLambda
:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2863 2864 2865 2866 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2863 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 AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide.
Related actions include:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2946 2947 2948 2949 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2946 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, 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 Simple Storage Service 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.
3009 3010 3011 3012 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3009 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 Simple Storage Service User Guide.
s3:ListStorageLensConfigurations
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3064 3065 3066 3067 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3064 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
:
^
3121 3122 3123 3124 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3121 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to PutAccessPointPolicy
:
3197 3198 3199 3200 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3197 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 Simple Storage Service User Guide.
The following actions are related to
PutAccessPointPolicyForObjectLambda
:
3243 3244 3245 3246 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3243 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to
PutBucketLifecycleConfiguration
:
3354 3355 3356 3357 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3354 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 Simple Storage Service User Guide.
If you are using an identity other than the root user of the AWS
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 AWS 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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to PutBucketPolicy
:
3453 3454 3455 3456 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3453 def put_bucket_policy(params = {}, = {}) req = build_request(:put_bucket_policy, 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 Simple Storage Service User Guide.
Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS 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 AWS-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 and 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 using the access point ARN, see the
Examples section.
The following actions are related to PutBucketTagging
:
3590 3591 3592 3593 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3590 def put_bucket_tagging(params = {}, = {}) req = build_request(:put_bucket_tagging, 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 Simple Storage Service 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 AWS Billing and Cost Management User Guide.
To use this action, you must have permission to perform the
s3:PutJobTagging
action.
Related actions include:
3686 3687 3688 3689 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3686 def put_job_tagging(params = {}, = {}) req = build_request(:put_job_tagging, params) req.send_request() end |
#put_public_access_block(params = {}) ⇒ Struct
Creates or modifies the PublicAccessBlock
configuration for an AWS
account. For more information, see Using Amazon S3 block public
access.
Related actions include:
3733 3734 3735 3736 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3733 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 Simple Storage Service User Guide.
s3:PutStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service User Guide.
3841 3842 3843 3844 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3841 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 Simple Storage Service User Guide.
s3:PutStorageLensConfigurationTagging
action. For more information,
see Setting permissions to use Amazon S3 Storage Lens in the
Amazon Simple Storage Service User Guide.
3895 3896 3897 3898 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3895 def put_storage_lens_configuration_tagging(params = {}, = {}) req = build_request(:put_storage_lens_configuration_tagging, 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 Simple Storage Service User Guide.
Related actions include:
3955 3956 3957 3958 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3955 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 Simple Storage Service User Guide.
Related actions include:
4023 4024 4025 4026 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4023 def update_job_status(params = {}, = {}) req = build_request(:update_job_status, params) req.send_request() end |