lib/aws-sdk-s3control/client.rb in aws-sdk-s3control-1.32.0 vs lib/aws-sdk-s3control/client.rb in aws-sdk-s3control-1.33.0

- old
+ new

@@ -343,19 +343,19 @@ # @!group API Operations # Creates an access point and associates it with the specified bucket. # For more information, see [Managing Data Access with Amazon S3 Access - # Points][1] in the *Amazon Simple Storage Service User Guide*. + # Points][1] in the *Amazon S3 User Guide*. # # # - # <note markdown="1"> S3 on Outposts only supports VPC-style Access Points. + # <note markdown="1"> S3 on Outposts only supports VPC-style access points. # # For more information, see [ Accessing Amazon S3 on Outposts using - # virtual private cloud (VPC) only Access Points][2] in the *Amazon - # Simple Storage Service User Guide*. + # virtual private cloud (VPC) only access points][2] in the *Amazon S3 + # User Guide*. # # </note> # # 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 @@ -454,11 +454,11 @@ req.send_request(options) end # Creates an Object Lambda Access Point. For more information, see # [Transforming objects with Object Lambda Access Points][1] in the - # *Amazon Simple Storage Service User Guide*. + # *Amazon S3 User Guide*. # # The following actions are related to # `CreateAccessPointForObjectLambda`\: # # * [DeleteAccessPointForObjectLambda][2] @@ -523,19 +523,18 @@ req = build_request(:create_access_point_for_object_lambda, params) req.send_request(options) end # <note markdown="1"> This action creates an Amazon S3 on Outposts bucket. To create an S3 - # bucket, see [Create Bucket][1] in the *Amazon Simple Storage Service - # API*. + # bucket, see [Create Bucket][1] in the *Amazon S3 API Reference*. # # </note> # # 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][2] - # in *Amazon Simple Storage Service User Guide*. + # 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][3]. # # S3 on Outposts buckets support: @@ -684,12 +683,11 @@ end # 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][1] in the *Amazon Simple Storage Service User - # Guide*. + # [S3 Batch Operations][1] in the *Amazon S3 User Guide*. # # This action creates a S3 Batch Operations job. # # # @@ -723,11 +721,11 @@ # S3 console. # # @option params [required, Types::JobOperation] :operation # The action that you want this job to perform on every object listed in # the manifest. For more information about the available actions, see - # [Operations][1] in the *Amazon Simple Storage Service User Guide*. + # [Operations][1] in the *Amazon S3 User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html # @@ -1114,20 +1112,18 @@ req = build_request(:delete_access_point_policy_for_object_lambda, params) req.send_request(options) end # <note markdown="1"> This action deletes an Amazon S3 on Outposts bucket. To delete an S3 - # bucket, see [DeleteBucket][1] in the *Amazon Simple Storage Service - # API*. + # bucket, see [DeleteBucket][1] in the *Amazon S3 API Reference*. # # </note> # # 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][2] in *Amazon Simple Storage Service - # User Guide*. + # [Using Amazon S3 on Outposts][2] in *Amazon S3 User Guide*. # # All Amazon S3 on Outposts REST API requests for this action require an # additional parameter of `x-amz-outpost-id` to be passed with the # request and an S3 on Outposts endpoint hostname prefix instead of # `s3-control`. For an example of the request syntax for Amazon S3 on @@ -1188,22 +1184,21 @@ req.send_request(options) end # <note markdown="1"> This action deletes an Amazon S3 on Outposts bucket's lifecycle # configuration. To delete an S3 bucket's lifecycle configuration, see - # [DeleteBucketLifecycle][1] in the *Amazon Simple Storage Service API*. + # [DeleteBucketLifecycle][1] in the *Amazon S3 API Reference*. # # </note> # # 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][2] in *Amazon Simple Storage Service User - # Guide*. + # Amazon S3 on Outposts][2] in *Amazon S3 User Guide*. # # To use this action, you must have permission to perform the # `s3-outposts:DeleteLifecycleConfiguration` action. By default, the # bucket owner has this permission and the Outposts bucket owner can # grant this permission to others. @@ -1269,23 +1264,23 @@ req = build_request(:delete_bucket_lifecycle_configuration, params) req.send_request(options) end # <note markdown="1"> This action deletes an Amazon S3 on Outposts bucket policy. To delete - # an S3 bucket policy, see [DeleteBucketPolicy][1] in the *Amazon Simple - # Storage Service API*. + # an S3 bucket policy, see [DeleteBucketPolicy][1] in the *Amazon S3 API + # Reference*. # # </note> # # This implementation of the DELETE action uses the policy subresource # to delete the policy of a specified Amazon S3 on Outposts bucket. If # you are using an identity other than the root user of the AWS account # that owns the bucket, the calling identity must have the # `s3-outposts:DeleteBucketPolicy` permissions on the specified Outposts # bucket and belong to the bucket owner's account to use this action. # For more information, see [Using Amazon S3 on Outposts][2] in *Amazon - # Simple Storage Service User Guide*. + # 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. @@ -1355,18 +1350,17 @@ req = build_request(:delete_bucket_policy, params) req.send_request(options) end # <note markdown="1"> This action deletes an Amazon S3 on Outposts bucket's tags. To delete - # an S3 bucket tags, see [DeleteBucketTagging][1] in the *Amazon Simple - # Storage Service API*. + # an S3 bucket tags, see [DeleteBucketTagging][1] in the *Amazon S3 API + # Reference*. # # </note> # # Deletes the tags from the Outposts bucket. For more information, see - # [Using Amazon S3 on Outposts][2] in *Amazon Simple Storage Service - # User Guide*. + # [Using Amazon S3 on Outposts][2] 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. # @@ -1429,12 +1423,11 @@ end # Removes the entire tag set from the specified S3 Batch Operations job. # To use this operation, you must have permission to perform the # `s3:DeleteJobTagging` action. For more information, see [Controlling - # access and labeling jobs using tags][1] in the *Amazon Simple Storage - # Service User Guide*. + # access and labeling jobs using tags][1] in the *Amazon S3 User Guide*. # # # # Related actions include: # @@ -1511,17 +1504,16 @@ req.send_request(options) end # 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 ][1] in the *Amazon Simple Storage Service - # User Guide*. + # with Amazon S3 Storage Lens ][1] in the *Amazon S3 User Guide*. # # <note markdown="1"> To use this action, you must have permission to perform the # `s3:DeleteStorageLensConfiguration` action. For more information, see # [Setting permissions to use Amazon S3 Storage Lens][2] in the *Amazon - # Simple Storage Service User Guide*. + # S3 User Guide*. # # </note> # # # @@ -1552,17 +1544,17 @@ req.send_request(options) end # 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 ][1] in the *Amazon - # Simple Storage Service User Guide*. + # activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 + # User Guide*. # # <note markdown="1"> To use this action, you must have permission to perform the # `s3:DeleteStorageLensConfigurationTagging` action. For more # information, see [Setting permissions to use Amazon S3 Storage - # Lens][2] in the *Amazon Simple Storage Service User Guide*. + # Lens][2] in the *Amazon S3 User Guide*. # # </note> # # # @@ -1593,11 +1585,11 @@ req.send_request(options) end # Retrieves the configuration parameters and status for a Batch # Operations job. For more information, see [S3 Batch Operations][1] in - # the *Amazon Simple Storage Service User Guide*. + # the *Amazon S3 User Guide*. # # # # Related actions include: # @@ -2018,12 +2010,12 @@ req.send_request(options) end # 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][1] in the *Amazon Simple Storage Service Developer Guide*. + # through access points, see [Managing Data Access with Amazon S3 access + # points][1] in the *Amazon S3 User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html # @@ -2090,12 +2082,11 @@ req = build_request(:get_access_point_policy_status_for_object_lambda, params) req.send_request(options) end # Gets an Amazon S3 on Outposts bucket. For more information, see [ - # Using Amazon S3 on Outposts][1] in the *Amazon Simple Storage Service - # User Guide*. + # Using Amazon S3 on Outposts][1] in the *Amazon S3 User Guide*. # # If you are using an identity other than the root user of the AWS # account that owns the Outposts bucket, the calling identity must have # the `s3-outposts:GetBucket` permissions on the specified Outposts # bucket and belong to the Outposts bucket owner's account in order to @@ -2177,19 +2168,18 @@ req.send_request(options) end # <note markdown="1"> This action gets an Amazon S3 on Outposts bucket's lifecycle # configuration. To get an S3 bucket's lifecycle configuration, see - # [GetBucketLifecycleConfiguration][1] in the *Amazon Simple Storage - # Service API*. + # [GetBucketLifecycleConfiguration][1] in the *Amazon S3 API Reference*. # # </note> # # Returns the lifecycle configuration information set on the Outposts # bucket. For more information, see [Using Amazon S3 on Outposts][2] and # for information about lifecycle configuration, see [ Object Lifecycle - # Management][3] in *Amazon Simple Storage Service User Guide*. + # Management][3] 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 @@ -2295,17 +2285,17 @@ req.send_request(options) end # <note markdown="1"> This action gets a bucket policy for an Amazon S3 on Outposts bucket. # To get a policy for an S3 bucket, see [GetBucketPolicy][1] in the - # *Amazon Simple Storage Service API*. + # *Amazon S3 API Reference*. # # </note> # # Returns the policy of a specified Outposts bucket. For more - # information, see [Using Amazon S3 on Outposts][2] in the *Amazon - # Simple Storage Service User Guide*. + # information, see [Using Amazon S3 on Outposts][2] in the *Amazon S3 + # User Guide*. # # If you are using an identity other than the root user of the AWS # account that owns the bucket, the calling identity must have the # `GetBucketPolicy` permissions on the specified bucket and belong to # the bucket owner's account in order to use this action. @@ -2390,18 +2380,18 @@ req = build_request(:get_bucket_policy, params) req.send_request(options) end # <note markdown="1"> This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 - # bucket tags, see [GetBucketTagging][1] in the *Amazon Simple Storage - # Service API*. + # bucket tags, see [GetBucketTagging][1] in the *Amazon S3 API + # Reference*. # # </note> # # Returns the tag set associated with the Outposts bucket. For more - # information, see [Using Amazon S3 on Outposts][2] in the *Amazon - # Simple Storage Service User Guide*. + # information, see [Using Amazon S3 on Outposts][2] 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. # @@ -2480,11 +2470,11 @@ end # Returns the tags on an S3 Batch Operations job. To use this operation, # you must have permission to perform the `s3:GetJobTagging` action. For # more information, see [Controlling access and labeling jobs using - # tags][1] in the *Amazon Simple Storage Service User Guide*. + # tags][1] in the *Amazon S3 User Guide*. # # # # Related actions include: # @@ -2579,16 +2569,16 @@ req.send_request(options) end # Gets the Amazon S3 Storage Lens configuration. For more information, # see [Assessing your storage activity and usage with Amazon S3 Storage - # Lens ][1] in the *Amazon Simple Storage Service User Guide*. + # Lens ][1] in the *Amazon S3 User Guide*. # # <note markdown="1"> To use this action, you must have permission to perform the # `s3:GetStorageLensConfiguration` action. For more information, see # [Setting permissions to use Amazon S3 Storage Lens][2] in the *Amazon - # Simple Storage Service User Guide*. + # S3 User Guide*. # # </note> # # # @@ -2648,17 +2638,17 @@ req.send_request(options) end # 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 ][1] in the *Amazon - # Simple Storage Service User Guide*. + # activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 + # User Guide*. # # <note markdown="1"> To use this action, you must have permission to perform the # `s3:GetStorageLensConfigurationTagging` action. For more information, # see [Setting permissions to use Amazon S3 Storage Lens][2] in the - # *Amazon Simple Storage Service User Guide*. + # *Amazon S3 User Guide*. # # </note> # # # @@ -2865,12 +2855,12 @@ req.send_request(options) end # Lists current S3 Batch Operations jobs and jobs that have ended within # the last 30 days for the AWS account making the request. For more - # information, see [S3 Batch Operations][1] in the *Amazon Simple - # Storage Service User Guide*. + # information, see [S3 Batch Operations][1] in the *Amazon S3 User + # Guide*. # # Related actions include: # # # @@ -2948,12 +2938,11 @@ req.send_request(options) end # 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][1] in the *Amazon Simple Storage Service - # User Guide*. + # [Using Amazon S3 on Outposts][1] 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][2] section. # @@ -3011,17 +3000,17 @@ req.send_request(options) end # 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 ][1] in the *Amazon - # Simple Storage Service User Guide*. + # activity and usage with Amazon S3 Storage Lens ][1] in the *Amazon S3 + # User Guide*. # # <note markdown="1"> To use this action, you must have permission to perform the # `s3:ListStorageLensConfigurations` action. For more information, see # [Setting permissions to use Amazon S3 Storage Lens][2] in the *Amazon - # Simple Storage Service User Guide*. + # S3 User Guide*. # # </note> # # # @@ -3171,12 +3160,11 @@ # The value must be URL encoded. # # @option params [required, String] :policy # The policy that you want to apply to the specified access point. For # more information about access point policies, see [Managing data - # access with Amazon S3 Access Points][1] in the *Amazon Simple Storage - # Service User Guide*. + # access with Amazon S3 access points][1] in the *Amazon S3 User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html # @@ -3199,11 +3187,11 @@ req.send_request(options) end # Creates or replaces resource policy for an Object Lambda Access Point. # For an example policy, see [Creating Object Lambda Access Points][1] - # in the *Amazon Simple Storage Service User Guide*. + # in the *Amazon S3 User Guide*. # # The following actions are related to # `PutAccessPointPolicyForObjectLambda`\: # # * [DeleteAccessPointPolicyForObjectLambda][2] @@ -3245,12 +3233,11 @@ req.send_request(options) end # <note markdown="1"> This action puts a lifecycle configuration to an Amazon S3 on Outposts # bucket. To put a lifecycle configuration to an S3 bucket, see - # [PutBucketLifecycleConfiguration][1] in the *Amazon Simple Storage - # Service API*. + # [PutBucketLifecycleConfiguration][1] in the *Amazon S3 API Reference*. # # </note> # # Creates a new lifecycle configuration for the S3 on Outposts bucket or # replaces an existing lifecycle configuration. Outposts buckets only @@ -3356,17 +3343,17 @@ req.send_request(options) end # <note markdown="1"> This action puts a bucket policy to an Amazon S3 on Outposts bucket. # To put a policy on an S3 bucket, see [PutBucketPolicy][1] in the - # *Amazon Simple Storage Service API*. + # *Amazon S3 API Reference*. # # </note> # # Applies an Amazon S3 bucket policy to an Outposts bucket. For more - # information, see [Using Amazon S3 on Outposts][2] in the *Amazon - # Simple Storage Service User Guide*. + # information, see [Using Amazon S3 on Outposts][2] in the *Amazon S3 + # User Guide*. # # If you are using an identity other than the root user of the AWS # account that owns the Outposts bucket, the calling identity must have # the `PutBucketPolicy` permissions on the specified Outposts bucket and # belong to the bucket owner's account in order to use this action. @@ -3454,18 +3441,17 @@ req = build_request(:put_bucket_policy, params) req.send_request(options) end # <note markdown="1"> This action puts tags on an Amazon S3 on Outposts bucket. To put tags - # on an S3 bucket, see [PutBucketTagging][1] in the *Amazon Simple - # Storage Service API*. + # on an S3 bucket, see [PutBucketTagging][1] in the *Amazon S3 API + # Reference*. # # </note> # # Sets the tags for an S3 on Outposts bucket. For more information, see - # [Using Amazon S3 on Outposts][2] in the *Amazon Simple Storage Service - # User Guide*. + # [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*. # # Use tags to organize your AWS bill to reflect your own cost structure. # To do this, sign up to get your AWS account bill with tag key values # included. Then, to see the cost of combined resources, organize your # billing information according to resources with the same tag key @@ -3600,11 +3586,11 @@ # can either replace the existing tag set entirely, or make changes # within the existing tag set by retrieving the existing tag set using # [GetJobTagging][1], modify that tag set, and use this action to # replace the tag set with the one you modified. For more information, # see [Controlling access and labeling jobs using tags][2] in the - # *Amazon Simple Storage Service User Guide*. + # *Amazon S3 User Guide*. # # # # <note markdown="1"> * If you send this request with an empty tag set, Amazon S3 deletes # the existing tag set on the Batch Operations job. If you use this @@ -3735,16 +3721,16 @@ req.send_request(options) end # Puts an Amazon S3 Storage Lens configuration. For more information # about S3 Storage Lens, see [Working with Amazon S3 Storage Lens][1] in - # the *Amazon Simple Storage Service User Guide*. + # the *Amazon S3 User Guide*. # # <note markdown="1"> To use this action, you must have permission to perform the # `s3:PutStorageLensConfiguration` action. For more information, see # [Setting permissions to use Amazon S3 Storage Lens][2] in the *Amazon - # Simple Storage Service User Guide*. + # S3 User Guide*. # # </note> # # # @@ -3844,16 +3830,16 @@ end # 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 - # ][1] in the *Amazon Simple Storage Service User Guide*. + # ][1] in the *Amazon S3 User Guide*. # # <note markdown="1"> To use this action, you must have permission to perform the # `s3:PutStorageLensConfigurationTagging` action. For more information, # see [Setting permissions to use Amazon S3 Storage Lens][2] in the - # *Amazon Simple Storage Service User Guide*. + # *Amazon S3 User Guide*. # # </note> # # # @@ -3896,12 +3882,12 @@ req = build_request(:put_storage_lens_configuration_tagging, params) req.send_request(options) end # Updates an existing S3 Batch Operations job's priority. For more - # information, see [S3 Batch Operations][1] in the *Amazon Simple - # Storage Service User Guide*. + # information, see [S3 Batch Operations][1] in the *Amazon S3 User + # Guide*. # # # # Related actions include: # @@ -3957,12 +3943,12 @@ req.send_request(options) end # Updates the status for the specified job. Use this action to confirm # that you want to run a job or to cancel an existing job. For more - # information, see [S3 Batch Operations][1] in the *Amazon Simple - # Storage Service User Guide*. + # information, see [S3 Batch Operations][1] in the *Amazon S3 User + # Guide*. # # # # Related actions include: # @@ -4036,10 +4022,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-s3control' - context[:gem_version] = '1.32.0' + context[:gem_version] = '1.33.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated