lib/aws-sdk-s3control/client.rb in aws-sdk-s3control-1.53.0 vs lib/aws-sdk-s3control/client.rb in aws-sdk-s3control-1.54.0
- old
+ new
@@ -28,14 +28,14 @@
require 'aws-sdk-core/plugins/transfer_encoding.rb'
require 'aws-sdk-core/plugins/http_checksum.rb'
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
require 'aws-sdk-core/plugins/defaults_mode.rb'
require 'aws-sdk-core/plugins/recursion_detection.rb'
+require 'aws-sdk-core/plugins/sign.rb'
require 'aws-sdk-core/plugins/protocols/rest_xml.rb'
require 'aws-sdk-s3control/plugins/arn.rb'
require 'aws-sdk-s3control/plugins/dualstack.rb'
-require 'aws-sdk-s3control/plugins/s3_control_signer.rb'
require 'aws-sdk-s3control/plugins/s3_host_id.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:s3control)
module Aws::S3Control
@@ -80,15 +80,16 @@
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::HttpChecksum)
add_plugin(Aws::Plugins::ChecksumAlgorithm)
add_plugin(Aws::Plugins::DefaultsMode)
add_plugin(Aws::Plugins::RecursionDetection)
+ add_plugin(Aws::Plugins::Sign)
add_plugin(Aws::Plugins::Protocols::RestXml)
add_plugin(Aws::S3Control::Plugins::ARN)
add_plugin(Aws::S3Control::Plugins::Dualstack)
- add_plugin(Aws::S3Control::Plugins::S3ControlSigner)
add_plugin(Aws::S3Control::Plugins::S3HostId)
+ add_plugin(Aws::S3Control::Plugins::Endpoints)
# @overload initialize(options)
# @param [Hash] options
# @option options [required, Aws::CredentialProvider] :credentials
# Your AWS credentials. This can be an instance of any one of the
@@ -297,10 +298,23 @@
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
#
# ** Please note ** When response stubbing is enabled, no HTTP
# requests are made, and retries are disabled.
#
+ # @option options [Aws::TokenProvider] :token_provider
+ # A Bearer Token Provider. This can be an instance of any one of the
+ # following classes:
+ #
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
+ # tokens.
+ #
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
+ # access token generated from `aws login`.
+ #
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
+ # will be used to search for tokens configured for your profile in shared configuration files.
+ #
# @option options [Boolean] :use_dualstack_endpoint
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
# will be used if available.
#
# @option options [Boolean] :use_fips_endpoint
@@ -310,10 +324,13 @@
#
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
+ # @option options [Aws::S3Control::EndpointProvider] :endpoint_provider
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::S3Control::EndpointParameters`
+ #
# @option options [URI::HTTP,String] :http_proxy A proxy to send
# requests through. Formatted like 'http://proxy.com:123'.
#
# @option options [Float] :http_open_timeout (15) The number of
# seconds to wait when opening a HTTP session before raising a
@@ -402,11 +419,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the bucket for
# which you want to create an access point.
#
# @option params [required, String] :name
# The name you want to assign to this access point.
@@ -447,11 +464,11 @@
# * {Types::CreateAccessPointResult#alias #alias} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_access_point({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "AccessPointName", # required
# bucket: "BucketName", # required
# vpc_configuration: {
# vpc_id: "VpcId", # required
# },
@@ -495,11 +512,11 @@
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for owner of the specified Object
# Lambda Access Point.
#
# @option params [required, String] :name
# The name you want to assign to this Object Lambda Access Point.
@@ -512,11 +529,11 @@
# * {Types::CreateAccessPointForObjectLambdaResult#object_lambda_access_point_arn #object_lambda_access_point_arn} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_access_point_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# configuration: { # required
# supporting_access_point: "ObjectLambdaSupportingAccessPointArn", # required
# cloud_watch_metrics_enabled: false,
# allowed_features: ["GetObject-Range"], # accepts GetObject-Range, GetObject-PartNumber, HeadObject-Range, HeadObject-PartNumber
@@ -733,11 +750,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID that creates the job.
#
# @option params [Boolean] :confirmation_required
# Indicates whether confirmation is required before Amazon S3 runs the
# job. Confirmation is only required for jobs created through the Amazon
@@ -793,11 +810,11 @@
# * {Types::CreateJobResult#job_id #job_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_job({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# confirmation_required: false,
# operation: { # required
# lambda_invoke: {
# function_arn: "FunctionArnString",
# },
@@ -1000,11 +1017,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point. The owner of the Multi-Region Access Point also must own
# the underlying buckets.
#
# @option params [required, String] :client_token
@@ -1023,11 +1040,11 @@
# * {Types::CreateMultiRegionAccessPointResult#request_token_arn #request_token_arn} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_multi_region_access_point({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# client_token: "MultiRegionAccessPointClientToken", # required
# details: { # required
# name: "MultiRegionAccessPointName", # required
# public_access_block: {
# block_public_acls: false,
@@ -1079,11 +1096,11 @@
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified access point.
#
# @option params [required, String] :name
# The name of the access point you want to delete.
#
@@ -1103,11 +1120,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_access_point({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "AccessPointName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPoint AWS API Documentation
#
@@ -1133,11 +1150,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the access point you want to delete.
@@ -1145,11 +1162,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_access_point_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPointForObjectLambda AWS API Documentation
#
@@ -1182,11 +1199,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified access point.
#
# @option params [required, String] :name
# The name of the access point whose policy you want to delete.
#
@@ -1206,11 +1223,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_access_point_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "AccessPointName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPointPolicy AWS API Documentation
#
@@ -1233,11 +1250,11 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the Object Lambda Access Point you want to delete the
@@ -1246,11 +1263,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_access_point_policy_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPointPolicyForObjectLambda AWS API Documentation
#
@@ -1294,11 +1311,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID that owns the Outposts bucket.
#
# @option params [required, String] :bucket
# Specifies the bucket being deleted.
#
@@ -1318,11 +1335,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucket AWS API Documentation
#
@@ -1376,11 +1393,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the lifecycle configuration to delete.
#
# @option params [required, String] :bucket
# Specifies the bucket.
#
@@ -1400,11 +1417,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_lifecycle_configuration({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketLifecycleConfiguration AWS API Documentation
#
@@ -1464,11 +1481,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# Specifies the bucket.
#
@@ -1488,11 +1505,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketPolicy AWS API Documentation
#
@@ -1536,11 +1553,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket tag set to
# be removed.
#
# @option params [required, String] :bucket
# The bucket ARN that has the tag set to be removed.
@@ -1561,11 +1578,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_tagging({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketTagging AWS API Documentation
#
@@ -1596,11 +1613,11 @@
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID associated with the S3 Batch
# Operations job.
#
# @option params [required, String] :job_id
# The ID for the S3 Batch Operations job whose tags you want to delete.
@@ -1608,11 +1625,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_job_tagging({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# job_id: "JobId", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteJobTagging AWS API Documentation
#
@@ -1653,11 +1670,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point.
#
# @option params [required, String] :client_token
# An idempotency token used to identify the request and guarantee that
@@ -1675,11 +1692,11 @@
# * {Types::DeleteMultiRegionAccessPointResult#request_token_arn #request_token_arn} => String
#
# @example Request syntax with placeholder values
#
# resp = client.delete_multi_region_access_point({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# client_token: "MultiRegionAccessPointClientToken", # required
# details: { # required
# name: "MultiRegionAccessPointName", # required
# },
# })
@@ -1711,20 +1728,20 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the Amazon Web Services account whose
# `PublicAccessBlock` configuration you want to remove.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_public_access_block({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeletePublicAccessBlock AWS API Documentation
#
# @overload delete_public_access_block(params = {})
@@ -1751,20 +1768,20 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html
#
# @option params [required, String] :config_id
# The ID of the S3 Storage Lens configuration.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the requester.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_storage_lens_configuration({
# config_id: "ConfigId", # required
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteStorageLensConfiguration AWS API Documentation
#
# @overload delete_storage_lens_configuration(params = {})
@@ -1792,20 +1809,20 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html
#
# @option params [required, String] :config_id
# The ID of the S3 Storage Lens configuration.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the requester.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_storage_lens_configuration_tagging({
# config_id: "ConfigId", # required
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteStorageLensConfigurationTagging AWS API Documentation
#
# @overload delete_storage_lens_configuration_tagging(params = {})
@@ -1837,11 +1854,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID associated with the S3 Batch
# Operations job.
#
# @option params [required, String] :job_id
# The ID for the job whose information you want to retrieve.
@@ -1851,11 +1868,11 @@
# * {Types::DescribeJobResult#job #job} => Types::JobDescriptor
#
# @example Request syntax with placeholder values
#
# resp = client.describe_job({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# job_id: "JobId", # required
# })
#
# @example Response structure
#
@@ -1991,11 +2008,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point.
#
# @option params [required, String] :request_token_arn
# The request token associated with the request you want to know about.
@@ -2008,11 +2025,11 @@
# * {Types::DescribeMultiRegionAccessPointOperationResult#async_operation #async_operation} => Types::AsyncOperation
#
# @example Request syntax with placeholder values
#
# resp = client.describe_multi_region_access_point_operation({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# request_token_arn: "AsyncRequestTokenARN", # required
# })
#
# @example Response structure
#
@@ -2072,11 +2089,11 @@
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified access point.
#
# @option params [required, String] :name
# The name of the access point whose configuration information you want
# to retrieve.
@@ -2107,11 +2124,11 @@
# * {Types::GetAccessPointResult#endpoints #endpoints} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.get_access_point({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "AccessPointName", # required
# })
#
# @example Response structure
#
@@ -2149,11 +2166,11 @@
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the Object Lambda Access Point you want to return the
@@ -2164,11 +2181,11 @@
# * {Types::GetAccessPointConfigurationForObjectLambdaResult#configuration #configuration} => Types::ObjectLambdaConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_access_point_configuration_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# })
#
# @example Response structure
#
@@ -2206,11 +2223,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the Object Lambda Access Point.
@@ -2222,11 +2239,11 @@
# * {Types::GetAccessPointForObjectLambdaResult#creation_date #creation_date} => Time
#
# @example Request syntax with placeholder values
#
# resp = client.get_access_point_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# })
#
# @example Response structure
#
@@ -2258,11 +2275,11 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified access point.
#
# @option params [required, String] :name
# The name of the access point whose policy you want to retrieve.
#
@@ -2284,11 +2301,11 @@
# * {Types::GetAccessPointPolicyResult#policy #policy} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_access_point_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "AccessPointName", # required
# })
#
# @example Response structure
#
@@ -2315,11 +2332,11 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the Object Lambda Access Point.
@@ -2329,11 +2346,11 @@
# * {Types::GetAccessPointPolicyForObjectLambdaResult#policy #policy} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_access_point_policy_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# })
#
# @example Response structure
#
@@ -2355,11 +2372,11 @@
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified access point.
#
# @option params [required, String] :name
# The name of the access point whose policy status you want to retrieve.
#
@@ -2368,11 +2385,11 @@
# * {Types::GetAccessPointPolicyStatusResult#policy_status #policy_status} => Types::PolicyStatus
#
# @example Request syntax with placeholder values
#
# resp = client.get_access_point_policy_status({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "AccessPointName", # required
# })
#
# @example Response structure
#
@@ -2388,11 +2405,11 @@
end
# Returns the status of the resource policy associated with an Object
# Lambda Access Point.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the Object Lambda Access Point.
@@ -2402,11 +2419,11 @@
# * {Types::GetAccessPointPolicyStatusForObjectLambdaResult#policy_status #policy_status} => Types::PolicyStatus
#
# @example Request syntax with placeholder values
#
# resp = client.get_access_point_policy_status_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# })
#
# @example Response structure
#
@@ -2459,11 +2476,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# Specifies the bucket.
#
@@ -2487,11 +2504,11 @@
# * {Types::GetBucketResult#creation_date #creation_date} => Time
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
@@ -2560,11 +2577,11 @@
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# The Amazon Resource Name (ARN) of the bucket.
#
@@ -2586,11 +2603,11 @@
# * {Types::GetBucketLifecycleConfigurationResult#rules #rules} => Array<Types::LifecycleRule>
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_lifecycle_configuration({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
@@ -2679,11 +2696,11 @@
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# Specifies the bucket.
#
@@ -2705,11 +2722,11 @@
# * {Types::GetBucketPolicyResult#policy #policy} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
@@ -2766,11 +2783,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# Specifies the bucket.
#
@@ -2792,11 +2809,11 @@
# * {Types::GetBucketTaggingResult#tag_set #tag_set} => Array<Types::S3Tag>
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_tagging({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
@@ -2854,11 +2871,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the S3 on Outposts bucket.
#
# @option params [required, String] :bucket
# The S3 on Outposts bucket to return the versioning state for.
#
@@ -2868,11 +2885,11 @@
# * {Types::GetBucketVersioningResult#mfa_delete #mfa_delete} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_versioning({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
@@ -2908,11 +2925,11 @@
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID associated with the S3 Batch
# Operations job.
#
# @option params [required, String] :job_id
# The ID for the S3 Batch Operations job whose tags you want to
@@ -2923,11 +2940,11 @@
# * {Types::GetJobTaggingResult#tags #tags} => Array<Types::S3Tag>
#
# @example Request syntax with placeholder values
#
# resp = client.get_job_tagging({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# job_id: "JobId", # required
# })
#
# @example Response structure
#
@@ -2968,11 +2985,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point.
#
# @option params [required, String] :name
# The name of the Multi-Region Access Point whose configuration
@@ -2991,11 +3008,11 @@
# * {Types::GetMultiRegionAccessPointResult#access_point #access_point} => Types::MultiRegionAccessPointReport
#
# @example Request syntax with placeholder values
#
# resp = client.get_multi_region_access_point({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "MultiRegionAccessPointName", # required
# })
#
# @example Response structure
#
@@ -3039,11 +3056,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point.
#
# @option params [required, String] :name
# Specifies the Multi-Region Access Point. The name of the Multi-Region
@@ -3061,11 +3078,11 @@
# * {Types::GetMultiRegionAccessPointPolicyResult#policy #policy} => Types::MultiRegionAccessPointPolicyDocument
#
# @example Request syntax with placeholder values
#
# resp = client.get_multi_region_access_point_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "MultiRegionAccessPointName", # required
# })
#
# @example Response structure
#
@@ -3100,11 +3117,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point.
#
# @option params [required, String] :name
# Specifies the Multi-Region Access Point. The name of the Multi-Region
@@ -3122,11 +3139,11 @@
# * {Types::GetMultiRegionAccessPointPolicyStatusResult#established #established} => Types::PolicyStatus
#
# @example Request syntax with placeholder values
#
# resp = client.get_multi_region_access_point_policy_status({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "MultiRegionAccessPointName", # required
# })
#
# @example Response structure
#
@@ -3155,22 +3172,22 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the Amazon Web Services account whose
# `PublicAccessBlock` configuration you want to retrieve.
#
# @return [Types::GetPublicAccessBlockOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetPublicAccessBlockOutput#public_access_block_configuration #public_access_block_configuration} => Types::PublicAccessBlockConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_public_access_block({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# })
#
# @example Response structure
#
# resp.public_access_block_configuration.block_public_acls #=> Boolean
@@ -3204,22 +3221,22 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html
#
# @option params [required, String] :config_id
# The ID of the Amazon S3 Storage Lens configuration.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the requester.
#
# @return [Types::GetStorageLensConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetStorageLensConfigurationResult#storage_lens_configuration #storage_lens_configuration} => Types::StorageLensConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_storage_lens_configuration({
# config_id: "ConfigId", # required
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# })
#
# @example Response structure
#
# resp.storage_lens_configuration.id #=> String
@@ -3275,22 +3292,22 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html
#
# @option params [required, String] :config_id
# The ID of the Amazon S3 Storage Lens configuration.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the requester.
#
# @return [Types::GetStorageLensConfigurationTaggingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetStorageLensConfigurationTaggingResult#tags #tags} => Array<Types::StorageLensTag>
#
# @example Request syntax with placeholder values
#
# resp = client.get_storage_lens_configuration_tagging({
# config_id: "ConfigId", # required
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# })
#
# @example Response structure
#
# resp.tags #=> Array
@@ -3336,11 +3353,11 @@
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for owner of the bucket whose
# access points you want to list.
#
# @option params [String] :bucket
# The name of the bucket whose associated access points you want to
@@ -3379,11 +3396,11 @@
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_access_points({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName",
# next_token: "NonEmptyMaxLength1024String",
# max_results: 1,
# })
#
@@ -3426,11 +3443,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [String] :next_token
# If the list has more access points than can be returned in one call to
@@ -3453,11 +3470,11 @@
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_access_points_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# next_token: "NonEmptyMaxLength1024String",
# max_results: 1,
# })
#
# @example Response structure
@@ -3499,11 +3516,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID associated with the S3 Batch
# Operations job.
#
# @option params [Array<String>] :job_statuses
# The `List Jobs` request returns jobs that match the statuses listed in
@@ -3528,11 +3545,11 @@
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_jobs({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# job_statuses: ["Active"], # accepts Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended
# next_token: "StringForNextToken",
# max_results: 1,
# })
#
@@ -3588,11 +3605,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point.
#
# @option params [String] :next_token
# Not currently used. Do not use this parameter.
@@ -3608,11 +3625,11 @@
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_multi_region_access_points({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# next_token: "NonEmptyMaxLength1024String",
# max_results: 1,
# })
#
# @example Response structure
@@ -3651,11 +3668,11 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [String] :next_token
#
# @option params [Integer] :max_results
@@ -3675,11 +3692,11 @@
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_regional_buckets({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# next_token: "NonEmptyMaxLength1024String",
# max_results: 1,
# outpost_id: "NonEmptyMaxLength64String",
# })
#
@@ -3717,11 +3734,11 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the requester.
#
# @option params [String] :next_token
# A pagination token to request the next page of results.
#
@@ -3733,11 +3750,11 @@
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_storage_lens_configurations({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# next_token: "ContinuationToken",
# })
#
# @example Response structure
#
@@ -3768,11 +3785,11 @@
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the Object Lambda Access Point.
@@ -3783,11 +3800,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_access_point_configuration_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# configuration: { # required
# supporting_access_point: "ObjectLambdaSupportingAccessPointArn", # required
# cloud_watch_metrics_enabled: false,
# allowed_features: ["GetObject-Range"], # accepts GetObject-Range, GetObject-PartNumber, HeadObject-Range, HeadObject-PartNumber
@@ -3839,11 +3856,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for owner of the bucket associated
# with the specified access point.
#
# @option params [required, String] :name
# The name of the access point that you want to associate with the
@@ -3874,11 +3891,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_access_point_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "AccessPointName", # required
# policy: "Policy", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutAccessPointPolicy AWS API Documentation
@@ -3905,11 +3922,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the account that owns the specified Object Lambda
# Access Point.
#
# @option params [required, String] :name
# The name of the Object Lambda Access Point.
@@ -3920,11 +3937,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_access_point_policy_for_object_lambda({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# name: "ObjectLambdaAccessPointName", # required
# policy: "ObjectLambdaPolicy", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutAccessPointPolicyForObjectLambda AWS API Documentation
@@ -3969,11 +3986,11 @@
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# The name of the bucket for which to set the configuration.
#
@@ -3983,11 +4000,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_lifecycle_configuration({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# lifecycle_configuration: {
# rules: [
# {
# expiration: {
@@ -4096,11 +4113,11 @@
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# Specifies the bucket.
#
@@ -4131,11 +4148,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# confirm_remove_self_bucket_access: false,
# policy: "Policy", # required
# })
#
@@ -4238,11 +4255,11 @@
# [8]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the Outposts bucket.
#
# @option params [required, String] :bucket
# The Amazon Resource Name (ARN) of the bucket.
#
@@ -4264,11 +4281,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_tagging({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# tagging: { # required
# tag_set: [ # required
# {
# key: "TagKeyString", # required
@@ -4349,11 +4366,11 @@
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID of the S3 on Outposts bucket.
#
# @option params [required, String] :bucket
# The S3 on Outposts bucket to set the versioning state for.
#
@@ -4367,11 +4384,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_versioning({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# bucket: "BucketName", # required
# mfa: "MFA",
# versioning_configuration: { # required
# mfa_delete: "Enabled", # accepts Enabled, Disabled
# status: "Enabled", # accepts Enabled, Suspended
@@ -4448,11 +4465,11 @@
# [3]: http://aws.amazon.com/s3/pricing/
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID associated with the S3 Batch
# Operations job.
#
# @option params [required, String] :job_id
# The ID for the S3 Batch Operations job whose tags you want to replace.
@@ -4463,11 +4480,11 @@
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_job_tagging({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# job_id: "JobId", # required
# tags: [ # required
# {
# key: "TagKeyString", # required
# value: "TagValueString", # required
@@ -4505,11 +4522,11 @@
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID for the owner of the Multi-Region
# Access Point.
#
# @option params [required, String] :client_token
# An idempotency token used to identify the request and guarantee that
@@ -4527,11 +4544,11 @@
# * {Types::PutMultiRegionAccessPointPolicyResult#request_token_arn #request_token_arn} => String
#
# @example Request syntax with placeholder values
#
# resp = client.put_multi_region_access_point_policy({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# client_token: "MultiRegionAccessPointClientToken", # required
# details: { # required
# name: "MultiRegionAccessPointName", # required
# policy: "Policy", # required
# },
@@ -4569,11 +4586,11 @@
#
# @option params [required, Types::PublicAccessBlockConfiguration] :public_access_block_configuration
# The `PublicAccessBlock` configuration that you want to apply to the
# specified Amazon Web Services account.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID for the Amazon Web Services account whose
# `PublicAccessBlock` configuration you want to set.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -4584,11 +4601,11 @@
# block_public_acls: false,
# ignore_public_acls: false,
# block_public_policy: false,
# restrict_public_buckets: false,
# },
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlock AWS API Documentation
#
# @overload put_public_access_block(params = {})
@@ -4615,11 +4632,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html
#
# @option params [required, String] :config_id
# The ID of the S3 Storage Lens configuration.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the requester.
#
# @option params [required, Types::StorageLensConfiguration] :storage_lens_configuration
# The S3 Storage Lens configuration.
#
@@ -4634,11 +4651,11 @@
#
# @example Request syntax with placeholder values
#
# resp = client.put_storage_lens_configuration({
# config_id: "ConfigId", # required
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# storage_lens_configuration: { # required
# id: "ConfigId", # required
# account_level: { # required
# activity_metrics: {
# is_enabled: false,
@@ -4727,11 +4744,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html
#
# @option params [required, String] :config_id
# The ID of the S3 Storage Lens configuration.
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The account ID of the requester.
#
# @option params [required, Array<Types::StorageLensTag>] :tags
# The tag set of the S3 Storage Lens configuration.
#
@@ -4743,11 +4760,11 @@
#
# @example Request syntax with placeholder values
#
# resp = client.put_storage_lens_configuration_tagging({
# config_id: "ConfigId", # required
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# tags: [ # required
# {
# key: "TagKeyString", # required
# value: "TagValueString", # required
# },
@@ -4785,11 +4802,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID associated with the S3 Batch
# Operations job.
#
# @option params [required, String] :job_id
# The ID for the job whose priority you want to update.
@@ -4803,11 +4820,11 @@
# * {Types::UpdateJobPriorityResult#priority #priority} => Integer
#
# @example Request syntax with placeholder values
#
# resp = client.update_job_priority({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# job_id: "JobId", # required
# priority: 1, # required
# })
#
# @example Response structure
@@ -4847,11 +4864,11 @@
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html
#
- # @option params [required, String] :account_id
+ # @option params [String] :account_id
# The Amazon Web Services account ID associated with the S3 Batch
# Operations job.
#
# @option params [required, String] :job_id
# The ID of the job whose status you want to update.
@@ -4870,11 +4887,11 @@
# * {Types::UpdateJobStatusResult#status_update_reason #status_update_reason} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_job_status({
- # account_id: "AccountId", # required
+ # account_id: "AccountId",
# job_id: "JobId", # required
# requested_job_status: "Cancelled", # required, accepts Cancelled, Ready
# status_update_reason: "JobStatusUpdateReason",
# })
#
@@ -4904,10 +4921,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-s3control'
- context[:gem_version] = '1.53.0'
+ context[:gem_version] = '1.54.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated