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_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_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_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_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 currently 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_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_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.
-
#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.
360 361 362 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 360 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 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
:
475 476 477 478 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 475 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
:
545 546 547 548 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 545 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:
703 704 705 706 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 703 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:
966 967 968 969 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 966 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
:
1054 1055 1056 1057 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1054 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 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
:
1116 1117 1118 1119 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1116 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
:
1158 1159 1160 1161 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1158 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
:
1219 1220 1221 1222 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1219 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
:
1259 1260 1261 1262 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1259 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 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
1331 1332 1333 1334 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1331 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 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:
1413 1414 1415 1416 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1413 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 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
:
1501 1502 1503 1504 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1501 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 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 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
:
1574 1575 1576 1577 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1574 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 S3 User Guide.
Related actions include:
1621 1622 1623 1624 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1621 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
:
1695 1696 1697 1698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1695 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:
1732 1733 1734 1735 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1732 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.
1772 1773 1774 1775 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1772 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.
1813 1814 1815 1816 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1813 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:
1967 1968 1969 1970 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1967 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
:
2045 2046 2047 2048 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2045 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 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
:
2136 2137 2138 2139 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2136 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
:
^
2189 2190 2191 2192 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2189 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
:
2244 2245 2246 2247 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2244 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
:
2301 2302 2303 2304 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2301 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
:
2346 2347 2348 2349 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2346 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.
2385 2386 2387 2388 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2385 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.
2419 2420 2421 2422 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2419 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 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.
2506 2507 2508 2509 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2506 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 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
:
2624 2625 2626 2627 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2624 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 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
:
2722 2723 2724 2725 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2722 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 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 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
:
2811 2812 2813 2814 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2811 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 S3 User Guide.
Related actions include:
2867 2868 2869 2870 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2867 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
:
2943 2944 2945 2946 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2943 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
:
3004 3005 3006 3007 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3004 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
:
3064 3065 3066 3067 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3064 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_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:
3110 3111 3112 3113 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3110 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.
s3:GetStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
3180 3181 3182 3183 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3180 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.
3229 3230 3231 3232 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3229 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.
3330 3331 3332 3333 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3330 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.
3399 3400 3401 3402 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3399 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.
3484 3485 3486 3487 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3484 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.
3563 3564 3565 3566 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3563 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.
3625 3626 3627 3628 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3625 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.
3680 3681 3682 3683 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3680 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
:
^
3737 3738 3739 3740 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3737 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
:
3813 3814 3815 3816 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3813 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
:
3859 3860 3861 3862 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3859 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
:
3969 3970 3971 3972 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3969 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 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
:
4071 4072 4073 4074 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4071 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 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 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
:
4210 4211 4212 4213 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4210 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 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 this action, you must have permission to perform the
s3:PutJobTagging
action.
Related actions include:
4307 4308 4309 4310 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4307 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
:
4373 4374 4375 4376 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4373 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:PutBucketPublicAccessBlock
permission. For more information, see
Using Amazon S3 block public access.
Related actions include:
4421 4422 4423 4424 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4421 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.
s3:PutStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
4532 4533 4534 4535 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4532 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.
4586 4587 4588 4589 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4586 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 S3 User Guide.
Related actions include:
4647 4648 4649 4650 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4647 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:
4716 4717 4718 4719 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4716 def update_job_status(params = {}, = {}) req = build_request(:update_job_status, params) req.send_request() end |