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
-
#associate_access_grants_identity_center(params = {}) ⇒ Struct
Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance.
-
#create_access_grant(params = {}) ⇒ Types::CreateAccessGrantResult
Creates an access grant that gives a grantee access to your S3 data.
-
#create_access_grants_instance(params = {}) ⇒ Types::CreateAccessGrantsInstanceResult
Creates an S3 Access Grants instance, which serves as a logical grouping for access grants.
-
#create_access_grants_location(params = {}) ⇒ Types::CreateAccessGrantsLocationResult
The S3 data location that you would like to register in your S3 Access Grants instance.
-
#create_access_point(params = {}) ⇒ Types::CreateAccessPointResult
This operation is not supported by directory buckets. -
#create_access_point_for_object_lambda(params = {}) ⇒ Types::CreateAccessPointForObjectLambdaResult
This operation is not supported by directory buckets. -
#create_bucket(params = {}) ⇒ Types::CreateBucketResult
This action creates an Amazon S3 on Outposts bucket. -
#create_job(params = {}) ⇒ Types::CreateJobResult
This operation creates an S3 Batch Operations job.
-
#create_multi_region_access_point(params = {}) ⇒ Types::CreateMultiRegionAccessPointResult
This operation is not supported by directory buckets. -
#create_storage_lens_group(params = {}) ⇒ Struct
Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID.
-
#delete_access_grant(params = {}) ⇒ Struct
Deletes the access grant from the S3 Access Grants instance.
-
#delete_access_grants_instance(params = {}) ⇒ Struct
Deletes your S3 Access Grants instance.
-
#delete_access_grants_instance_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy of the S3 Access Grants instance.
-
#delete_access_grants_location(params = {}) ⇒ Struct
Deregisters a location from your S3 Access Grants instance.
-
#delete_access_point(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#delete_access_point_for_object_lambda(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#delete_access_point_policy(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#delete_access_point_policy_for_object_lambda(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#delete_bucket(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket. -
#delete_bucket_lifecycle_configuration(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. -
#delete_bucket_policy(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket policy. -
#delete_bucket_replication(params = {}) ⇒ Struct
This operation deletes an Amazon S3 on Outposts bucket's replication configuration. -
#delete_bucket_tagging(params = {}) ⇒ Struct
This action deletes an Amazon S3 on Outposts bucket's tags. -
#delete_job_tagging(params = {}) ⇒ Struct
Removes the entire tag set from the specified S3 Batch Operations job.
-
#delete_multi_region_access_point(params = {}) ⇒ Types::DeleteMultiRegionAccessPointResult
This operation is not supported by directory buckets. -
#delete_public_access_block(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#delete_storage_lens_configuration(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#delete_storage_lens_configuration_tagging(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#delete_storage_lens_group(params = {}) ⇒ Struct
Deletes an existing S3 Storage Lens group.
-
#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
This operation is not supported by directory buckets. -
#dissociate_access_grants_identity_center(params = {}) ⇒ Struct
Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.
-
#get_access_grant(params = {}) ⇒ Types::GetAccessGrantResult
Get the details of an access grant from your S3 Access Grants instance.
-
#get_access_grants_instance(params = {}) ⇒ Types::GetAccessGrantsInstanceResult
Retrieves the S3 Access Grants instance for a Region in your account.
-
#get_access_grants_instance_for_prefix(params = {}) ⇒ Types::GetAccessGrantsInstanceForPrefixResult
Retrieve the S3 Access Grants instance that contains a particular prefix.
-
#get_access_grants_instance_resource_policy(params = {}) ⇒ Types::GetAccessGrantsInstanceResourcePolicyResult
Returns the resource policy of the S3 Access Grants instance.
-
#get_access_grants_location(params = {}) ⇒ Types::GetAccessGrantsLocationResult
Retrieves the details of a particular location registered in your S3 Access Grants instance.
-
#get_access_point(params = {}) ⇒ Types::GetAccessPointResult
This operation is not supported by directory buckets. -
#get_access_point_configuration_for_object_lambda(params = {}) ⇒ Types::GetAccessPointConfigurationForObjectLambdaResult
This operation is not supported by directory buckets. -
#get_access_point_for_object_lambda(params = {}) ⇒ Types::GetAccessPointForObjectLambdaResult
This operation is not supported by directory buckets. -
#get_access_point_policy(params = {}) ⇒ Types::GetAccessPointPolicyResult
This operation is not supported by directory buckets. -
#get_access_point_policy_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyForObjectLambdaResult
This operation is not supported by directory buckets. -
#get_access_point_policy_status(params = {}) ⇒ Types::GetAccessPointPolicyStatusResult
This operation is not supported by directory buckets. -
#get_access_point_policy_status_for_object_lambda(params = {}) ⇒ Types::GetAccessPointPolicyStatusForObjectLambdaResult
This operation is not supported by directory buckets. -
#get_bucket(params = {}) ⇒ Types::GetBucketResult
Gets an Amazon S3 on Outposts bucket.
-
#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationResult
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. -
#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyResult
This action gets a bucket policy for an Amazon S3 on Outposts bucket. -
#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationResult
This operation gets an Amazon S3 on Outposts bucket's replication configuration. -
#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingResult
This action gets an Amazon S3 on Outposts bucket's tags. -
#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningResult
This operation returns the versioning state for S3 on Outposts buckets only. -
#get_data_access(params = {}) ⇒ Types::GetDataAccessResult
Returns a temporary access credential from S3 Access Grants to the grantee or client application.
-
#get_job_tagging(params = {}) ⇒ Types::GetJobTaggingResult
Returns the tags on an S3 Batch Operations job.
-
#get_multi_region_access_point(params = {}) ⇒ Types::GetMultiRegionAccessPointResult
This operation is not supported by directory buckets. -
#get_multi_region_access_point_policy(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyResult
This operation is not supported by directory buckets. -
#get_multi_region_access_point_policy_status(params = {}) ⇒ Types::GetMultiRegionAccessPointPolicyStatusResult
This operation is not supported by directory buckets. -
#get_multi_region_access_point_routes(params = {}) ⇒ Types::GetMultiRegionAccessPointRoutesResult
This operation is not supported by directory buckets. -
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
This operation is not supported by directory buckets. -
#get_storage_lens_configuration(params = {}) ⇒ Types::GetStorageLensConfigurationResult
This operation is not supported by directory buckets. -
#get_storage_lens_configuration_tagging(params = {}) ⇒ Types::GetStorageLensConfigurationTaggingResult
This operation is not supported by directory buckets. -
#get_storage_lens_group(params = {}) ⇒ Types::GetStorageLensGroupResult
Retrieves the Storage Lens group configuration details.
-
#list_access_grants(params = {}) ⇒ Types::ListAccessGrantsResult
Returns the list of access grants in your S3 Access Grants instance.
-
#list_access_grants_instances(params = {}) ⇒ Types::ListAccessGrantsInstancesResult
Returns a list of S3 Access Grants instances.
-
#list_access_grants_locations(params = {}) ⇒ Types::ListAccessGrantsLocationsResult
Returns a list of the locations registered in your S3 Access Grants instance.
-
#list_access_points(params = {}) ⇒ Types::ListAccessPointsResult
This operation is not supported by directory buckets. -
#list_access_points_for_object_lambda(params = {}) ⇒ Types::ListAccessPointsForObjectLambdaResult
This operation is not supported by directory buckets. -
#list_caller_access_grants(params = {}) ⇒ Types::ListCallerAccessGrantsResult
Returns a list of the access grants that were given to the caller using S3 Access Grants and that allow the caller to access the S3 data of the Amazon Web Services account specified in the request.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request.
-
#list_multi_region_access_points(params = {}) ⇒ Types::ListMultiRegionAccessPointsResult
This operation is not supported by directory buckets. -
#list_regional_buckets(params = {}) ⇒ Types::ListRegionalBucketsResult
This operation is not supported by directory buckets. -
#list_storage_lens_configurations(params = {}) ⇒ Types::ListStorageLensConfigurationsResult
This operation is not supported by directory buckets. -
#list_storage_lens_groups(params = {}) ⇒ Types::ListStorageLensGroupsResult
Lists all the Storage Lens groups in the specified home Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
This operation allows you to list all the Amazon Web Services resource tags for a specified resource.
-
#put_access_grants_instance_resource_policy(params = {}) ⇒ Types::PutAccessGrantsInstanceResourcePolicyResult
Updates the resource policy of the S3 Access Grants instance.
-
#put_access_point_configuration_for_object_lambda(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#put_access_point_policy(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#put_access_point_policy_for_object_lambda(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. -
#put_bucket_policy(params = {}) ⇒ Struct
This action puts a bucket policy to an Amazon S3 on Outposts bucket. -
#put_bucket_replication(params = {}) ⇒ Struct
This action creates an Amazon S3 on Outposts bucket's replication configuration. -
#put_bucket_tagging(params = {}) ⇒ Struct
This action puts tags on an Amazon S3 on Outposts bucket. -
#put_bucket_versioning(params = {}) ⇒ Struct
This operation sets the versioning state for S3 on Outposts buckets only. -
#put_job_tagging(params = {}) ⇒ Struct
Sets the supplied tag-set on an S3 Batch Operations job.
-
#put_multi_region_access_point_policy(params = {}) ⇒ Types::PutMultiRegionAccessPointPolicyResult
This operation is not supported by directory buckets. -
#put_public_access_block(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#put_storage_lens_configuration(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#put_storage_lens_configuration_tagging(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#submit_multi_region_access_point_routes(params = {}) ⇒ Struct
This operation is not supported by directory buckets. -
#tag_resource(params = {}) ⇒ Struct
Creates a new Amazon Web Services resource tag or updates an existing resource tag.
-
#untag_resource(params = {}) ⇒ Struct
This operation removes the specified Amazon Web Services resource tags from an S3 resource.
-
#update_access_grants_location(params = {}) ⇒ Types::UpdateAccessGrantsLocationResult
Updates the IAM role of a registered location in your S3 Access Grants instance.
-
#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.
-
#update_storage_lens_group(params = {}) ⇒ Struct
Updates the existing Storage Lens group.
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.
458 459 460 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 458 def initialize(*args) super end |
Instance Method Details
#associate_access_grants_identity_center(params = {}) ⇒ Struct
Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance.
- Permissions
You must have the
s3:AssociateAccessGrantsIdentityCenter
permission to use this operation.- Additional Permissions
You must also have the following permissions:
sso:CreateApplication
,sso:PutApplicationGrant
, andsso:PutApplicationAuthenticationMethod
.
510 511 512 513 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 510 def associate_access_grants_identity_center(params = {}, = {}) req = build_request(:associate_access_grants_identity_center, params) req.send_request() end |
#create_access_grant(params = {}) ⇒ Types::CreateAccessGrantResult
Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.
- Permissions
You must have the
s3:CreateAccessGrant
permission to use this operation.- Additional Permissions
For any directory identity -
sso:DescribeInstance
andsso:DescribeApplication
For directory users -
identitystore:DescribeUser
For directory groups -
identitystore:DescribeGroup
648 649 650 651 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 648 def create_access_grant(params = {}, = {}) req = build_request(:create_access_grant, params) req.send_request() end |
#create_access_grants_instance(params = {}) ⇒ Types::CreateAccessGrantsInstanceResult
Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.
- Permissions
You must have the
s3:CreateAccessGrantsInstance
permission to use this operation.- Additional Permissions
To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the
sso:DescribeInstance
,sso:CreateApplication
,sso:PutApplicationGrant
, andsso:PutApplicationAuthenticationMethod
permissions.
727 728 729 730 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 727 def create_access_grants_instance(params = {}, = {}) req = build_request(:create_access_grants_instance, params) req.send_request() end |
#create_access_grants_location(params = {}) ⇒ Types::CreateAccessGrantsLocationResult
The S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:
The default S3 location
s3://
A bucket -
S3://<bucket-name>
A bucket and prefix -
S3://<bucket-name>/<prefix>
When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy. S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.
- Permissions
You must have the
s3:CreateAccessGrantsLocation
permission to use this operation.- Additional Permissions
You must also have the following permission for the specified IAM role:
iam:PassRole
820 821 822 823 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 820 def create_access_grants_location(params = {}, = {}) req = build_request(:create_access_grants_location, params) req.send_request() end |
#create_access_point(params = {}) ⇒ Types::CreateAccessPointResult
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to CreateAccessPoint
:
948 949 950 951 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 948 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
:
1025 1026 1027 1028 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1025 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:
1183 1184 1185 1186 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1183 def create_bucket(params = {}, = {}) req = build_request(:create_bucket, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResult
This operation creates an S3 Batch Operations job.
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.
- Permissions
For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
1465 1466 1467 1468 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1465 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations 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
:
1558 1559 1560 1561 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1558 def create_multi_region_access_point(params = {}, = {}) req = build_request(:create_multi_region_access_point, params) req.send_request() end |
#create_storage_lens_group(params = {}) ⇒ Struct
Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags, object size, object age, or a combination of these filters. For each Storage Lens group that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information about S3 Storage Lens groups, see Working with S3 Storage Lens groups.
To use this operation, you must have the permission to perform the
s3:CreateStorageLensGroup
action. If you’re trying to create a
Storage Lens group with Amazon Web Services resource tags, you must
also have permission to perform the s3:TagResource
action. For more
information about the required Storage Lens Groups permissions, see
Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1674 def create_storage_lens_group(params = {}, = {}) req = build_request(:create_storage_lens_group, params) req.send_request() end |
#delete_access_grant(params = {}) ⇒ Struct
Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data.
- Permissions
You must have the
s3:DeleteAccessGrant
permission to use this operation.
1708 1709 1710 1711 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1708 def delete_access_grant(params = {}, = {}) req = build_request(:delete_access_grant, params) req.send_request() end |
#delete_access_grants_instance(params = {}) ⇒ Struct
Deletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter.
- Permissions
You must have the
s3:DeleteAccessGrantsInstance
permission to use this operation.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1750 def delete_access_grants_instance(params = {}, = {}) req = build_request(:delete_access_grants_instance, params) req.send_request() end |
#delete_access_grants_instance_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance.
- Permissions
You must have the
s3:DeleteAccessGrantsInstanceResourcePolicy
permission to use this operation.
1780 1781 1782 1783 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1780 def delete_access_grants_instance_resource_policy(params = {}, = {}) req = build_request(:delete_access_grants_instance_resource_policy, params) req.send_request() end |
#delete_access_grants_location(params = {}) ⇒ Struct
Deregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See Delete a grant for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants.
- Permissions
You must have the
s3:DeleteAccessGrantsLocation
permission to use this operation.
1824 1825 1826 1827 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1824 def delete_access_grants_location(params = {}, = {}) req = build_request(:delete_access_grants_location, params) req.send_request() end |
#delete_access_point(params = {}) ⇒ Struct
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint
:
1891 1892 1893 1894 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1891 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
:
1937 1938 1939 1940 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 1937 def delete_access_point_for_object_lambda(params = {}, = {}) req = build_request(:delete_access_point_for_object_lambda, params) req.send_request() end |
#delete_access_point_policy(params = {}) ⇒ Struct
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy
:
2002 2003 2004 2005 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2002 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
:
2046 2047 2048 2049 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2046 def delete_access_point_policy_for_object_lambda(params = {}, = {}) req = build_request(:delete_access_point_policy_for_object_lambda, params) req.send_request() end |
#delete_bucket(params = {}) ⇒ Struct
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
Related Resources
2118 2119 2120 2121 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2118 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 operation, you must have permission to perform the
s3-outposts:PutLifecycleConfiguration
action. By default, the bucket
owner has this permission and the Outposts bucket owner can grant this
permission to others.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
2200 2201 2202 2203 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2200 def delete_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:delete_bucket_lifecycle_configuration, params) req.send_request() end |
#delete_bucket_policy(params = {}) ⇒ Struct
This implementation of the DELETE action uses the policy subresource
to delete the policy of a specified Amazon S3 on Outposts bucket. If
you are using an identity other than the root user of the Amazon Web
Services account that owns the bucket, the calling identity must have
the s3-outposts:DeleteBucketPolicy
permissions on the specified
Outposts bucket and belong to the bucket owner's account to use this
action. For more information, see Using Amazon S3 on Outposts in
Amazon S3 User Guide.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns
a 403 Access Denied
error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy
:
2288 2289 2290 2291 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2288 def delete_bucket_policy(params = {}, = {}) req = build_request(:delete_bucket_policy, params) req.send_request() end |
#delete_bucket_replication(params = {}) ⇒ Struct
Deletes the replication configuration from the specified S3 on Outposts bucket.
To use this operation, you must have permissions to perform the
s3-outposts:PutReplicationConfiguration
action. The Outposts bucket
owner has this permission by default and can grant it to others. For
more information about permissions, see Setting up IAM with S3 on
Outposts and Managing access to S3 on Outposts buckets in the
Amazon S3 User Guide.
PUT
or DELETE
requests for a
replication configuration to all S3 on Outposts systems. Therefore,
the replication configuration that's returned by a GET
request soon
after a PUT
or DELETE
request might return a more recent result
than what's on the Outpost. If an Outpost is offline, the delay in
updating the replication configuration on that Outpost can be
significant.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
The following operations are related to DeleteBucketReplication
:
2381 2382 2383 2384 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2381 def delete_bucket_replication(params = {}, = {}) req = build_request(:delete_bucket_replication, params) req.send_request() end |
#delete_bucket_tagging(params = {}) ⇒ Struct
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the
PutBucketTagging
action. By default, the bucket owner has this
permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging
:
2454 2455 2456 2457 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2454 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.
- Permissions
To use the
DeleteJobTagging
operation, you must have permission to perform thes3:DeleteJobTagging
action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
2503 2504 2505 2506 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2503 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations 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
:
2581 2582 2583 2584 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2581 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:
2622 2623 2624 2625 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2622 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.
2666 2667 2668 2669 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2666 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.
2711 2712 2713 2714 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2711 def delete_storage_lens_configuration_tagging(params = {}, = {}) req = build_request(:delete_storage_lens_configuration_tagging, params) req.send_request() end |
#delete_storage_lens_group(params = {}) ⇒ Struct
Deletes an existing S3 Storage Lens group.
To use this operation, you must have the permission to perform the
s3:DeleteStorageLensGroup
action. For more information about the
required Storage Lens Groups permissions, see Setting account
permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
2751 2752 2753 2754 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2751 def delete_storage_lens_group(params = {}, = {}) req = build_request(:delete_storage_lens_group, 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.
- Permissions
To use the
DescribeJob
operation, you must have permission to perform thes3:DescribeJob
action.
Related actions include:
2921 2922 2923 2924 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 2921 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 Using Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPoint
:
3003 3004 3005 3006 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3003 def describe_multi_region_access_point_operation(params = {}, = {}) req = build_request(:describe_multi_region_access_point_operation, params) req.send_request() end |
#dissociate_access_grants_identity_center(params = {}) ⇒ Struct
Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.
- Permissions
You must have the
s3:DissociateAccessGrantsIdentityCenter
permission to use this operation.- Additional Permissions
You must have the
sso:DeleteApplication
permission to use this operation.
3036 3037 3038 3039 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3036 def dissociate_access_grants_identity_center(params = {}, = {}) req = build_request(:dissociate_access_grants_identity_center, params) req.send_request() end |
#get_access_grant(params = {}) ⇒ Types::GetAccessGrantResult
Get the details of an access grant from your S3 Access Grants instance.
- Permissions
You must have the
s3:GetAccessGrant
permission to use this operation.
3092 3093 3094 3095 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3092 def get_access_grant(params = {}, = {}) req = build_request(:get_access_grant, params) req.send_request() end |
#get_access_grants_instance(params = {}) ⇒ Types::GetAccessGrantsInstanceResult
Retrieves the S3 Access Grants instance for a Region in your account.
- Permissions
You must have the
s3:GetAccessGrantsInstance
permission to use this operation.
GetAccessGrantsInstance
is not supported for cross-account access.
You can only call the API from the account that owns the S3 Access
Grants instance.
3141 3142 3143 3144 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3141 def get_access_grants_instance(params = {}, = {}) req = build_request(:get_access_grants_instance, params) req.send_request() end |
#get_access_grants_instance_for_prefix(params = {}) ⇒ Types::GetAccessGrantsInstanceForPrefixResult
Retrieve the S3 Access Grants instance that contains a particular prefix.
- Permissions
You must have the
s3:GetAccessGrantsInstanceForPrefix
permission for the caller account to use this operation.- Additional Permissions
The prefix owner account must grant you the following permissions to their S3 Access Grants instance:
s3:GetAccessGrantsInstanceForPrefix
.
3187 3188 3189 3190 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3187 def get_access_grants_instance_for_prefix(params = {}, = {}) req = build_request(:get_access_grants_instance_for_prefix, params) req.send_request() end |
#get_access_grants_instance_resource_policy(params = {}) ⇒ Types::GetAccessGrantsInstanceResourcePolicyResult
Returns the resource policy of the S3 Access Grants instance.
- Permissions
You must have the
s3:GetAccessGrantsInstanceResourcePolicy
permission to use this operation.
3224 3225 3226 3227 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3224 def get_access_grants_instance_resource_policy(params = {}, = {}) req = build_request(:get_access_grants_instance_resource_policy, params) req.send_request() end |
#get_access_grants_location(params = {}) ⇒ Types::GetAccessGrantsLocationResult
Retrieves the details of a particular location registered in your S3 Access Grants instance.
- Permissions
You must have the
s3:GetAccessGrantsLocation
permission to use this operation.
3273 3274 3275 3276 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3273 def get_access_grants_location(params = {}, = {}) req = build_request(:get_access_grants_location, params) req.send_request() end |
#get_access_point(params = {}) ⇒ Types::GetAccessPointResult
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to GetAccessPoint
:
3371 3372 3373 3374 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3371 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
:
^
3428 3429 3430 3431 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3428 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
:
3490 3491 3492 3493 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3490 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
:
3551 3552 3553 3554 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3551 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
:
3600 3601 3602 3603 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3600 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.
3643 3644 3645 3646 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3643 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.
3681 3682 3683 3684 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3681 def get_access_point_policy_status_for_object_lambda(params = {}, = {}) req = build_request(:get_access_point_policy_status_for_object_lambda, params) req.send_request() end |
#get_bucket(params = {}) ⇒ Types::GetBucketResult
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon
Web Services account that owns the Outposts bucket, the calling
identity must have the s3-outposts:GetBucket
permissions on the
specified Outposts bucket and belong to the Outposts bucket owner's
account in order to use this action. Only users from Outposts bucket
owner account with the right permissions can perform actions on an
Outposts bucket.
If you don't have s3-outposts:GetBucket
permissions or you're not
using an identity that belongs to the bucket owner's account, Amazon
S3 returns a 403 Access Denied
error.
The following actions are related to GetBucket
for Amazon S3 on
Outposts:
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
3768 3769 3770 3771 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3768 def get_bucket(params = {}, = {}) req = build_request(:get_bucket, params) req.send_request() end |
#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationResult
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.
To use this action, you must have permission to perform the
s3-outposts:GetLifecycleConfiguration
action. The Outposts bucket
owner has this permission, by default. The bucket owner can grant this
permission to others. For more information about permissions, see
Permissions Related to Bucket Subresource Operations and
Managing Access Permissions to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
GetBucketLifecycleConfiguration
has the following special error:
Error code:
NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following actions are related to
GetBucketLifecycleConfiguration
:
3891 3892 3893 3894 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3891 def get_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:get_bucket_lifecycle_configuration, params) req.send_request() end |
#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyResult
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon
Web Services account that owns the bucket, the calling identity must
have the GetBucketPolicy
permissions on the specified bucket and
belong to the bucket owner's account in order to use this action.
Only users from Outposts bucket owner account with the right
permissions can perform actions on an Outposts bucket. If you don't
have s3-outposts:GetBucketPolicy
permissions or you're not using an
identity that belongs to the bucket owner's account, Amazon S3
returns a 403 Access Denied
error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to GetBucketPolicy
:
3989 3990 3991 3992 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 3989 def get_bucket_policy(params = {}, = {}) req = build_request(:get_bucket_policy, params) req.send_request() end |
#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationResult
Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
PUT
or DELETE
requests for a
replication configuration to all S3 on Outposts systems. Therefore,
the replication configuration that's returned by a GET
request soon
after a PUT
or DELETE
request might return a more recent result
than what's on the Outpost. If an Outpost is offline, the delay in
updating the replication configuration on that Outpost can be
significant.
This action requires permissions for the
s3-outposts:GetReplicationConfiguration
action. The Outposts bucket
owner has this permission by default and can grant it to others. For
more information about permissions, see Setting up IAM with S3 on
Outposts and Managing access to S3 on Outposts bucket in the
Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
If you include the Filter
element in a replication configuration,
you must also include the DeleteMarkerReplication
, Status
, and
Priority
elements. The response also returns those elements.
For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
The following operations are related to GetBucketReplication
:
4120 4121 4122 4123 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4120 def get_bucket_replication(params = {}, = {}) req = build_request(:get_bucket_replication, params) req.send_request() end |
#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingResult
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
GetBucketTagging
action. By default, the bucket owner has this
permission and can grant this permission to others.
GetBucketTagging
has the following special error:
Error code:
NoSuchTagSetError
- Description: There is no tag set associated with the bucket.
^
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to GetBucketTagging
:
4209 4210 4211 4212 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4209 def get_bucket_tagging(params = {}, = {}) req = build_request(:get_bucket_tagging, params) req.send_request() end |
#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningResult
Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
If you've never set versioning on your bucket, it has no versioning
state. In that case, the GetBucketVersioning
request does not return
a versioning state value.
For more information about versioning, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following operations are related to GetBucketVersioning
for S3
on Outposts.
4284 4285 4286 4287 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4284 def get_bucket_versioning(params = {}, = {}) req = build_request(:get_bucket_versioning, params) req.send_request() end |
#get_data_access(params = {}) ⇒ Types::GetDataAccessResult
Returns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.
- Permissions
You must have the
s3:GetDataAccess
permission to use this operation.- Additional Permissions
The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location:
sts:AssumeRole
, for directory users or groupssts:SetContext
, and for IAM users or rolessts:SetSourceIdentity
.
4381 4382 4383 4384 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4381 def get_data_access(params = {}, = {}) req = build_request(:get_data_access, params) req.send_request() end |
#get_job_tagging(params = {}) ⇒ Types::GetJobTaggingResult
Returns the tags on an S3 Batch Operations job.
- Permissions
To use the
GetJobTagging
operation, you must have permission to perform thes3:GetJobTagging
action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
4439 4440 4441 4442 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4439 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPoint
:
4520 4521 4522 4523 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4520 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicy
:
4585 4586 4587 4588 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4585 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
GetMultiRegionAccessPointPolicyStatus
:
4649 4650 4651 4652 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4649 def get_multi_region_access_point_policy_status(params = {}, = {}) req = build_request(:get_multi_region_access_point_policy_status, params) req.send_request() end |
#get_multi_region_access_point_routes(params = {}) ⇒ Types::GetMultiRegionAccessPointRoutesResult
Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
us-east-1
us-west-2
ap-southeast-2
ap-northeast-1
eu-west-1
4706 4707 4708 4709 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4706 def get_multi_region_access_point_routes(params = {}, = {}) req = build_request(:get_multi_region_access_point_routes, params) req.send_request() end |
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
Retrieves the PublicAccessBlock
configuration for an Amazon Web
Services account. For more information, see Using Amazon S3 block
public access.
Related actions include:
4756 4757 4758 4759 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4756 def get_public_access_block(params = {}, = {}) req = build_request(:get_public_access_block, params) req.send_request() end |
#get_storage_lens_configuration(params = {}) ⇒ Types::GetStorageLensConfigurationResult
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
s3:GetStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
4843 4844 4845 4846 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4843 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.
4896 4897 4898 4899 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4896 def get_storage_lens_configuration_tagging(params = {}, = {}) req = build_request(:get_storage_lens_configuration_tagging, params) req.send_request() end |
#get_storage_lens_group(params = {}) ⇒ Types::GetStorageLensGroupResult
Retrieves the Storage Lens group configuration details.
To use this operation, you must have the permission to perform the
s3:GetStorageLensGroup
action. For more information about the
required Storage Lens Groups permissions, see Setting account
permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
4977 4978 4979 4980 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 4977 def get_storage_lens_group(params = {}, = {}) req = build_request(:get_storage_lens_group, params) req.send_request() end |
#list_access_grants(params = {}) ⇒ Types::ListAccessGrantsResult
Returns the list of access grants in your S3 Access Grants instance.
- Permissions
You must have the
s3:ListAccessGrants
permission to use this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5086 5087 5088 5089 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5086 def list_access_grants(params = {}, = {}) req = build_request(:list_access_grants, params) req.send_request() end |
#list_access_grants_instances(params = {}) ⇒ Types::ListAccessGrantsInstancesResult
Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.
- Permissions
You must have the
s3:ListAccessGrantsInstances
permission to use this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5145 5146 5147 5148 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5145 def list_access_grants_instances(params = {}, = {}) req = build_request(:list_access_grants_instances, params) req.send_request() end |
#list_access_grants_locations(params = {}) ⇒ Types::ListAccessGrantsLocationsResult
Returns a list of the locations registered in your S3 Access Grants instance.
- Permissions
You must have the
s3:ListAccessGrantsLocations
permission to use this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5212 5213 5214 5215 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5212 def list_access_grants_locations(params = {}, = {}) req = build_request(:list_access_grants_locations, params) req.send_request() end |
#list_access_points(params = {}) ⇒ Types::ListAccessPointsResult
Returns a list of the access points that are owned by the current
account that's associated with the specified bucket. You can retrieve
up to 1000 access points per call. If the specified bucket has more
than 1,000 access points (or the number specified in maxResults
,
whichever is less), the response will include a continuation token
that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to ListAccessPoints
:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5318 5319 5320 5321 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5318 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.
5393 5394 5395 5396 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5393 def list_access_points_for_object_lambda(params = {}, = {}) req = build_request(:list_access_points_for_object_lambda, params) req.send_request() end |
#list_caller_access_grants(params = {}) ⇒ Types::ListCallerAccessGrantsResult
Returns a list of the access grants that were given to the caller using S3 Access Grants and that allow the caller to access the S3 data of the Amazon Web Services account specified in the request.
- Permissions
You must have the
s3:ListCallerAccessGrants
permission to use this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5462 5463 5464 5465 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5462 def list_caller_access_grants(params = {}, = {}) req = build_request(:list_caller_access_grants, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
To use the
ListJobs
operation, you must have permission to perform thes3:ListJobs
action.
Related actions include:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5552 5553 5554 5555 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5552 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations 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.
5636 5637 5638 5639 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5636 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.
5702 5703 5704 5705 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5702 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.
5761 5762 5763 5764 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5761 def list_storage_lens_configurations(params = {}, = {}) req = build_request(:list_storage_lens_configurations, params) req.send_request() end |
#list_storage_lens_groups(params = {}) ⇒ Types::ListStorageLensGroupsResult
Lists all the Storage Lens groups in the specified home Region.
To use this operation, you must have the permission to perform the
s3:ListStorageLensGroups
action. For more information about the
required Storage Lens Groups permissions, see Setting account
permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5814 5815 5816 5817 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5814 def list_storage_lens_groups(params = {}, = {}) req = build_request(:list_storage_lens_groups, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
This operation allows you to list all the Amazon Web Services resource tags for a specified resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- Permissions
You must have the
s3:ListTagsForResource
permission to use this operation.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
5879 5880 5881 5882 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5879 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_access_grants_instance_resource_policy(params = {}) ⇒ Types::PutAccessGrantsInstanceResourcePolicyResult
Updates the resource policy of the S3 Access Grants instance.
- Permissions
You must have the
s3:PutAccessGrantsInstanceResourcePolicy
permission to use this operation.
5926 5927 5928 5929 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5926 def put_access_grants_instance_resource_policy(params = {}, = {}) req = build_request(:put_access_grants_instance_resource_policy, 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
:
^
5987 5988 5989 5990 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 5987 def put_access_point_configuration_for_object_lambda(params = {}, = {}) req = build_request(:put_access_point_configuration_for_object_lambda, params) req.send_request() end |
#put_access_point_policy(params = {}) ⇒ Struct
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy
:
6067 6068 6069 6070 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6067 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
:
6117 6118 6119 6120 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6117 def put_access_point_policy_for_object_lambda(params = {}, = {}) req = build_request(:put_access_point_policy_for_object_lambda, params) req.send_request() end |
#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to
PutBucketLifecycleConfiguration
:
6232 6233 6234 6235 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6232 def put_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:put_bucket_lifecycle_configuration, params) req.send_request() end |
#put_bucket_policy(params = {}) ⇒ Struct
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon
Web Services account that owns the Outposts bucket, the calling
identity must have the PutBucketPolicy
permissions on the specified
Outposts bucket and belong to the bucket owner's account in order to
use this action.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a
403 Access Denied
error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to PutBucketPolicy
:
6334 6335 6336 6337 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6334 def put_bucket_policy(params = {}, = {}) req = build_request(:put_bucket_policy, params) req.send_request() end |
#put_bucket_replication(params = {}) ⇒ Struct
Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.
PUT
or DELETE
requests for a
replication configuration to all S3 on Outposts systems. Therefore,
the replication configuration that's returned by a GET
request soon
after a PUT
or DELETE
request might return a more recent result
than what's on the Outpost. If an Outpost is offline, the delay in
updating the replication configuration on that Outpost can be
significant.
Specify the replication configuration in the request body. In the replication configuration, you provide the following information:
The name of the destination bucket or buckets where you want S3 on Outposts to replicate objects
The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf
Other relevant information, such as replication rules
A replication configuration must include at least one rule and can contain a maximum of 100. Each rule identifies a subset of objects to replicate by filtering the objects in the source Outposts bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source Outposts bucket to
apply a replication rule to, add the Filter
element as a child of
the Rule
element. You can filter objects based on an object key
prefix, one or more object tags, or both. When you add the Filter
element in the configuration, you must also add the following
elements: DeleteMarkerReplication
, Status
, and Priority
.
Using PutBucketReplication
on Outposts requires that both the source
and destination buckets must have versioning enabled. For information
about enabling versioning on a bucket, see Managing S3 Versioning for
your S3 on Outposts bucket.
For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
Handling Replication of Encrypted Objects
Outposts buckets are encrypted at all times. All the objects in the source Outposts bucket are encrypted and can be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with the same encryption key as the objects in the source Outposts bucket.
Permissions
To create a PutBucketReplication
request, you must have
s3-outposts:PutReplicationConfiguration
permissions for the bucket.
The Outposts bucket owner has this permission by default and can grant
it to others. For more information about permissions, see Setting up
IAM with S3 on Outposts and Managing access to S3 on Outposts
buckets.
iam:CreateRole
and iam:PassRole
permissions. For more information,
see Granting a user permissions to pass a role to an Amazon Web
Services service.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following operations are related to PutBucketReplication
:
6541 6542 6543 6544 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6541 def put_bucket_replication(params = {}, = {}) req = build_request(:put_bucket_replication, params) req.send_request() end |
#put_bucket_tagging(params = {}) ⇒ Struct
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.
To use this action, you must have permissions to perform the
s3-outposts:PutBucketTagging
action. The Outposts bucket owner has
this permission by default and can grant this permission to others.
For more information about permissions, see Permissions Related to
Bucket Subresource Operations and Managing access permissions to
your Amazon S3 resources.
PutBucketTagging
has the following special errors:
Error code:
InvalidTagError
- Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
^
Error code:
MalformedXMLError
- Description: The XML provided does not match the schema.
^
Error code:
OperationAbortedError
- Description: A conflicting conditional action is currently in progress against this resource. Try again.
^
Error code:
InternalError
- Description: The service was unable to apply the provided tag to the bucket.
^
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following actions are related to PutBucketTagging
:
6680 6681 6682 6683 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6680 def put_bucket_tagging(params = {}, = {}) req = build_request(:put_bucket_tagging, params) req.send_request() end |
#put_bucket_versioning(params = {}) ⇒ Struct
Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.
You can set the versioning state to one of the following:
Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID
null
.
If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.
When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.
If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax
for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id
derived by using the access
point ARN, see the Examples section.
The following operations are related to PutBucketVersioning
for S3
on Outposts.
6780 6781 6782 6783 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6780 def put_bucket_versioning(params = {}, = {}) req = build_request(:put_bucket_versioning, params) req.send_request() end |
#put_job_tagging(params = {}) ⇒ Struct
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this operation 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.
- Permissions
To use the
PutJobTagging
operation, you must have permission to perform thes3:PutJobTagging
action.
Related actions include:
6875 6876 6877 6878 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6875 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide.
The following actions are related to
PutMultiRegionAccessPointPolicy
:
6945 6946 6947 6948 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6945 def put_multi_region_access_point_policy(params = {}, = {}) req = build_request(:put_multi_region_access_point_policy, params) req.send_request() end |
#put_public_access_block(params = {}) ⇒ Struct
Creates or modifies the PublicAccessBlock
configuration for an
Amazon Web Services account. For this operation, users must have the
s3:PutAccountPublicAccessBlock
permission. For more information, see
Using Amazon S3 block public access.
Related actions include:
6997 6998 6999 7000 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 6997 def put_public_access_block(params = {}, = {}) req = build_request(:put_public_access_block, params) req.send_request() end |
#put_storage_lens_configuration(params = {}) ⇒ Struct
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
s3:PutStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
7139 7140 7141 7142 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7139 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.
7197 7198 7199 7200 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7197 def put_storage_lens_configuration_tagging(params = {}, = {}) req = build_request(:put_storage_lens_configuration_tagging, params) req.send_request() end |
#submit_multi_region_access_point_routes(params = {}) ⇒ Struct
Submits an updated route configuration for a Multi-Region Access
Point. This API operation updates the routing status for the specified
Regions from active to passive, or from passive to active. A value of
0
indicates a passive status, which means that traffic won't be
routed to the specified Region. A value of 100
indicates an active
status, which means that traffic will be routed to the specified
Region. At least one Region must be active at all times.
When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged.
To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:
us-east-1
us-west-2
ap-southeast-2
ap-northeast-1
eu-west-1
7271 7272 7273 7274 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7271 def submit_multi_region_access_point_routes(params = {}, = {}) req = build_request(:submit_multi_region_access_point_routes, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates a new Amazon Web Services resource tag or updates an existing resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource.
- Permissions
You must have the
s3:TagResource
permission to use this operation.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
7339 7340 7341 7342 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7339 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
This operation removes the specified Amazon Web Services resource tags from an S3 resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- Permissions
You must have the
s3:UntagResource
permission to use this operation.
For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
7401 7402 7403 7404 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7401 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access_grants_location(params = {}) ⇒ Types::UpdateAccessGrantsLocationResult
Updates the IAM role of a registered location in your S3 Access Grants instance.
- Permissions
You must have the
s3:UpdateAccessGrantsLocation
permission to use this operation.- Additional Permissions
You must also have the following permission:
iam:PassRole
7469 7470 7471 7472 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7469 def update_access_grants_location(params = {}, = {}) req = build_request(:update_access_grants_location, 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.
- Permissions
To use the
UpdateJobPriority
operation, you must have permission to perform thes3:UpdateJobPriority
action.
Related actions include:
7533 7534 7535 7536 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7533 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 S3 User Guide.
- Permissions
To use the
UpdateJobStatus
operation, you must have permission to perform thes3:UpdateJobStatus
action.
Related actions include:
7605 7606 7607 7608 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7605 def update_job_status(params = {}, = {}) req = build_request(:update_job_status, params) req.send_request() end |
#update_storage_lens_group(params = {}) ⇒ Struct
Updates the existing Storage Lens group.
To use this operation, you must have the permission to perform the
s3:UpdateStorageLensGroup
action. For more information about the
required Storage Lens Groups permissions, see Setting account
permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
7705 7706 7707 7708 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb', line 7705 def update_storage_lens_group(params = {}, = {}) req = build_request(:update_storage_lens_group, params) req.send_request() end |