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_bucket(params = {}) ⇒ Types::CreateBucketResult
This API operation creates an Amazon S3 on Outposts bucket. -
#create_job(params = {}) ⇒ Types::CreateJobResult
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects.
-
#delete_access_point(params = {}) ⇒ Struct
Deletes the specified access point.
-
#delete_access_point_policy(params = {}) ⇒ Struct
Deletes the access point policy for the specified access point.
-
#delete_bucket(params = {}) ⇒ Struct
This API operation deletes an Amazon S3 on Outposts bucket. -
#delete_bucket_lifecycle_configuration(params = {}) ⇒ Struct
This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. -
#delete_bucket_policy(params = {}) ⇒ Struct
This API operation deletes an Amazon S3 on Outposts bucket policy. -
#delete_bucket_tagging(params = {}) ⇒ Struct
This operation 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_policy(params = {}) ⇒ Types::GetAccessPointPolicyResult
Returns the access point policy associated with the specified 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_bucket(params = {}) ⇒ Types::GetBucketResult
Gets an Amazon S3 on Outposts bucket.
-
#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationResult
This operation 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 operation 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_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_policy(params = {}) ⇒ Struct
Associates an access policy with the specified 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 Developer Guide.
Using this action with Amazon S3 on Outposts
This action:
Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.
Does not support ACL on S3 on Outposts buckets.
Does not support Public Access on S3 on Outposts buckets.
Does not support object lock for S3 on Outposts buckets.
For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer 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
:
469 470 471 472 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 469 def create_access_point(params = {}, = {}) req = build_request(:create_access_point, 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 Developer 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 do not support
ACLs. Instead, configure access point policies to manage access to buckets.
Public access.
Object Lock
Bucket Location constraint
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:
628 629 630 631 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 628 def create_bucket(params = {}, = {}) req = build_request(:create_bucket, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResult
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
This operation creates an S3 Batch Operations job.
Related actions include:
853 854 855 856 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 853 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
:
914 915 916 917 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 914 def delete_access_point(params = {}, = {}) req = build_request(:delete_access_point, 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
:
974 975 976 977 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 974 def delete_access_point_policy(params = {}, = {}) req = build_request(:delete_access_point_policy, 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 Developer 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
1047 1048 1049 1050 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1047 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 Developer Guide.
To use this operation, 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:
1129 1130 1131 1132 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1129 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 operation 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
operation. For more information, see Using Amazon S3 on Outposts
in Amazon Simple Storage Service Developer 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 operation, 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
:
1215 1216 1217 1218 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1215 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 Developer Guide.
To use this operation, 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
:
1287 1288 1289 1290 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1287 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 Developer Guide.
Related actions include:
1334 1335 1336 1337 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1334 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:
1370 1371 1372 1373 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1370 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 Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:DeleteStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service Developer Guide.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1410 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 Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:DeleteStorageLensConfigurationTagging
action. For more
information, see Setting permissions to use Amazon S3 Storage
Lens in the Amazon Simple Storage Service Developer Guide.
1450 1451 1452 1453 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1450 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 Developer Guide.
Related actions include:
1582 1583 1584 1585 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1582 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
:
1665 1666 1667 1668 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1665 def get_access_point(params = {}, = {}) req = build_request(:get_access_point, 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
:
1721 1722 1723 1724 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1721 def get_access_point_policy(params = {}, = {}) req = build_request(:get_access_point_policy, 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.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1760 def get_access_point_policy_status(params = {}, = {}) req = build_request(:get_access_point_policy_status, 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 Developer 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
s3-outposts:GetBucket
permissions on the specified bucket and belong
to the bucket owner's account in order to use this operation. 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.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1846 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 Developer Guide.
To use this operation, 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
:
1964 1965 1966 1967 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1964 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 Developer 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 operation.
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 operation, 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
:
2060 2061 2062 2063 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2060 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 Developer Guide.
To use this operation, 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
:
2148 2149 2150 2151 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2148 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 Developer Guide.
Related actions include:
2203 2204 2205 2206 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2203 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:
2248 2249 2250 2251 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2248 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 Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:GetStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service Developer Guide.
2317 2318 2319 2320 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2317 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 Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:GetStorageLensConfigurationTagging
action. For more information,
see Setting permissions to use Amazon S3 Storage Lens in the
Amazon Simple Storage Service Developer Guide.
2365 2366 2367 2368 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2365 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.
2464 2465 2466 2467 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2464 def list_access_points(params = {}, = {}) req = build_request(:list_access_points, 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 Developer Guide.
Related actions include:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2546 2547 2548 2549 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2546 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 Developer 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.
2609 2610 2611 2612 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2609 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 Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:ListStorageLensConfigurations
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service Developer Guide.
2661 2662 2663 2664 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2661 def list_storage_lens_configurations(params = {}, = {}) req = build_request(:list_storage_lens_configurations, 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
:
2737 2738 2739 2740 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2737 def put_access_point_policy(params = {}, = {}) req = build_request(:put_access_point_policy, params) req.send_request() end |
#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct
Creates a new lifecycle configuration for the 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. For more information, see Managing Lifecycle Permissions 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.
The following actions are related to
PutBucketLifecycleConfiguration
:
2851 2852 2853 2854 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2851 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 Developer 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 operation.
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 operation, 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
:
2950 2951 2952 2953 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2950 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 Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer 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 operation, 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 operation 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
:
3087 3088 3089 3090 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3087 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 Developer 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 operation, you must have permission to perform the
s3:PutJobTagging
action.
Related actions include:
3183 3184 3185 3186 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3183 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:
3230 3231 3232 3233 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3230 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 Developer Guide.
s3:PutStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
Simple Storage Service Developer Guide.
3338 3339 3340 3341 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3338 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 Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:PutStorageLensConfigurationTagging
action. For more information,
see Setting permissions to use Amazon S3 Storage Lens in the
Amazon Simple Storage Service Developer Guide.
3392 3393 3394 3395 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3392 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 Developer Guide.
Related actions include:
3451 3452 3453 3454 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3451 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 operation 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 Developer Guide.
Related actions include:
3518 3519 3520 3521 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3518 def update_job_status(params = {}, = {}) req = build_request(:update_job_status, params) req.send_request() end |