Class: Aws::S3::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-s3/client.rb

Overview

An API client for S3. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::S3::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_grants (Boolean) — default: false —

    When ‘true`, the S3 client will use the S3 Access Grants feature to authenticate requests. Bucket credentials will be fetched from S3 Control using the `get_data_access` API.

  • :access_grants_credentials_provider (Aws::S3::AccessGrantsCredentialsProvider) —

    When ‘access_grants` is `true`, this option can be used to provide additional options to the credentials provider, including a privilege setting, caching, and fallback behavior.

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :compute_checksums (Boolean) — default: true —

    When ‘true` a MD5 checksum will be computed and sent in the Content Md5 header for :put_object and :upload_part. When `false`, MD5 checksums will not be computed for these operations. Checksums are still computed for operations requiring them. Checksum errors returned by Amazon S3 are automatically retried up to `:retry_limit` times.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :disable_s3_express_session_auth (Boolean) —

    Parameter to indicate whether S3Express session auth should be disabled

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :express_credentials_provider (Aws::S3::ExpressCredentialsProvider) —

    Credential Provider for S3 Express endpoints. Manages credentials for different buckets.

  • :follow_redirects (Boolean) — default: true —

    When ‘true`, this client will follow 307 redirects returned by Amazon S3.

  • :force_path_style (Boolean) — default: false —

    When set to ‘true`, the bucket name is always left in the request URI and never moved to the host as a sub-domain.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :input_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it can be used for sending events for the event stream.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :output_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :require_https_for_sse_cpk (Boolean) — default: true —

    When ‘true`, the endpoint must be HTTPS for all operations where server-side-encryption is used with customer-provided keys. This should only be disabled for local testing.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :s3_disable_multiregion_access_points (Boolean) — default: false —

    When set to ‘false` this will option will raise errors when multi-region access point ARNs are used. Multi-region access points can potentially result in cross region requests.

  • :s3_us_east_1_regional_endpoint (String) — default: "legacy" —

    Pass in ‘regional` to enable the `us-east-1` regional endpoint. Defaults to `legacy` mode which uses the global endpoint.

  • :s3_use_arn_region (Boolean) — default: true —

    For S3 ARNs passed into the ‘:bucket` parameter, this option will use the region in the ARN, allowing for cross-region requests to be made. Set to `false` to use the client’s region instead.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    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.

  • :use_accelerate_endpoint (Boolean) — default: false —

    When set to ‘true`, accelerated bucket endpoints will be used for all object operations. You must first enable accelerate for each bucket. [Go here for more information](docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::S3::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::S3::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



551
552
553
 
# File 'lib/aws-sdk-s3/client.rb', line 551

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



20606
20607
20608
 
# File 'lib/aws-sdk-s3/client.rb', line 20606

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



20609
20610
20611
 
# File 'lib/aws-sdk-s3/client.rb', line 20609

def errors_module
  Errors
end

Instance Method Details

#abort_multipart_upload(params = {}) ⇒ Types::AbortMultipartUploadOutput

This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed and prevent getting charged for the part storage, you should call the [ListParts] API operation and ensure that the parts list is empty.

<note markdown=“1”> * **Directory buckets** - If multipart uploads in a directory bucket

are in progress, you can't delete the bucket until all the
in-progress multipart uploads are aborted or completed. To delete
these in-progress multipart uploads, use the `ListMultipartUploads`
operation to list the in-progress multipart uploads in the bucket
and use the `AbortMultipartUpload` operation to abort all the
in-progress multipart uploads.

  • **Directory buckets** - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format ‘bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

Permissions : * **General purpose bucket permissions** - For information about

  permissions required to use the multipart upload, see [Multipart
  Upload and Permissions][4] in the *Amazon S3 User Guide*.

* **Directory bucket permissions** - To grant access to this API
  operation on a directory bucket, we recommend that you use the [
  `CreateSession` ][5] API operation for session-based
  authorization. Specifically, you grant the
  `s3express:CreateSession` permission to the directory bucket in a
  bucket policy or an IAM identity-based policy. Then, you make the
  `CreateSession` API call on the bucket to obtain a session token.
  With the session token in your request header, you can make API
  requests to this operation. After the session token expires, you
  make another `CreateSession` API call to generate a new session
  token for use. Amazon Web Services CLI or SDKs create session and
  refresh the session token automatically to avoid service
  interruptions when a session expires. For more information about
  authorization, see [ `CreateSession` ][5].

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following operations are related to ‘AbortMultipartUpload`:

  • CreateMultipartUpload][6
  • UploadPart][7
  • CompleteMultipartUpload][8
  • ListParts][1
  • ListMultipartUploads][9

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html

Examples:

Example: To abort a multipart upload


# The following example aborts a multipart upload.

resp = client.abort_multipart_upload({
  bucket: "examplebucket", 
  key: "bigobject", 
  upload_id: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.abort_multipart_upload({
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  upload_id: "MultipartUploadId", # required
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  if_match_initiated_time: Time.now,
})

Response structure


resp.request_charged #=> String, one of "requester"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name to which the upload was taking place.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][3

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :key (required, String) —

    Key of the object for which the multipart upload was initiated.

  • :upload_id (required, String) —

    Upload ID that identifies the multipart upload.

  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :if_match_initiated_time (Time, DateTime, Date, Integer, String) —

    If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a ‘412 Precondition Failed` error. If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a `204 Success (No Content)` response.

    <note markdown=“1”> This functionality is only supported for directory buckets.

    </note>

Returns:

See Also:



761
762
763
764
 
# File 'lib/aws-sdk-s3/client.rb', line 761

def abort_multipart_upload(params = {}, options = {})
  req = build_request(:abort_multipart_upload, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
20472
20473
20474
20475
20476
 
# File 'lib/aws-sdk-s3/client.rb', line 20460

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::S3')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-s3'
  context[:gem_version] = '1.176.0'
  Seahorse::Client::Request.new(handlers, context)
end

#complete_multipart_upload(params = {}) ⇒ Types::CompleteMultipartUploadOutput

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the [UploadPart] operation or the [UploadPartCopy] operation. After successfully uploading all relevant parts of an upload, you call this ‘CompleteMultipartUpload` operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the `PartNumber` value and the `ETag` value that are returned after that part was uploaded.

The processing of a CompleteMultipartUpload request could take several minutes to finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a ‘200 OK` response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request could fail after the initial `200 OK` response has been sent. This means that a `200 OK` response can contain either a success or an error. The error response might be embedded in the `200 OK` response. If you call this API operation directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don’t use exceptions, they return an error).

Note that if ‘CompleteMultipartUpload` fails, applications should be prepared to retry any failed requests (including 500 error responses). For more information, see [Amazon S3 Error Best Practices].

You can’t use ‘Content-Type: application/x-www-form-urlencoded` for the CompleteMultipartUpload requests. Also, if you don’t provide a ‘Content-Type` header, `CompleteMultipartUpload` can still return a `200 OK` response.

For more information about multipart uploads, see [Uploading Objects Using Multipart Upload] in the *Amazon S3 User Guide*.

<note markdown=“1”> **Directory buckets** - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format ‘bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see

Available Local Zone for directory buckets][6

in the *Amazon S3 User

Guide*.

</note>

Permissions : * **General purpose bucket permissions** - For information about

  permissions required to use the multipart upload API, see
  [Multipart Upload and Permissions][7] in the *Amazon S3 User
  Guide*.

  If you provide an [additional checksum value][8] in your
  `MultipartUpload` requests and the object is encrypted with Key
  Management Service, you must have permission to use the
  `kms:Decrypt` action for the `CompleteMultipartUpload` request to
  succeed.

* **Directory bucket permissions** - To grant access to this API
  operation on a directory bucket, we recommend that you use the [
  `CreateSession` ][9] API operation for session-based
  authorization. Specifically, you grant the
  `s3express:CreateSession` permission to the directory bucket in a
  bucket policy or an IAM identity-based policy. Then, you make the
  `CreateSession` API call on the bucket to obtain a session token.
  With the session token in your request header, you can make API
  requests to this operation. After the session token expires, you
  make another `CreateSession` API call to generate a new session
  token for use. Amazon Web Services CLI or SDKs create session and
  refresh the session token automatically to avoid service
  interruptions when a session expires. For more information about
  authorization, see [ `CreateSession` ][9].

  If the object is encrypted with SSE-KMS, you must also have the
  `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
  identity-based policies and KMS key policies for the KMS key.

Special errors : * Error Code: ‘EntityTooSmall`

  * Description: Your proposed upload is smaller than the minimum
    allowed object size. Each part must be at least 5 MB in size,
    except the last part.

  * HTTP Status Code: 400 Bad Request
* Error Code: `InvalidPart`

  * Description: One or more of the specified parts could not be
    found. The part might not have been uploaded, or the specified
    ETag might not have matched the uploaded part's ETag.

  * HTTP Status Code: 400 Bad Request
* Error Code: `InvalidPartOrder`

  * Description: The list of parts was not in ascending order. The
    parts list must be specified in order by part number.

  * HTTP Status Code: 400 Bad Request
* Error Code: `NoSuchUpload`

  * Description: The specified multipart upload does not exist. The
    upload ID might be invalid, or the multipart upload might have
    been aborted or completed.

  * HTTP Status Code: 404 Not Found

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following operations are related to ‘CompleteMultipartUpload`:

  • CreateMultipartUpload][10
  • UploadPart][1
  • AbortMultipartUpload][11
  • ListParts][12
  • ListMultipartUploads][13

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html [12]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [13]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html

Examples:

Example: To complete multipart upload


# The following example completes a multipart upload.

resp = client.complete_multipart_upload({
  bucket: "examplebucket", 
  key: "bigobject", 
  multipart_upload: {
    parts: [
      {
        etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"", 
        part_number: 1, 
      }, 
      {
        etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"", 
        part_number: 2, 
      }, 
    ], 
  }, 
  upload_id: "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--", 
})

resp.to_h outputs the following:
{
  bucket: "acexamplebucket", 
  etag: "\"4d9031c7644d8081c2829f4ea23c55f7-2\"", 
  key: "bigobject", 
  location: "https://examplebucket.s3.<Region>.amazonaws.com/bigobject", 
}

Request syntax with placeholder values


resp = client.complete_multipart_upload({
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  multipart_upload: {
    parts: [
      {
        etag: "ETag",
        checksum_crc32: "ChecksumCRC32",
        checksum_crc32c: "ChecksumCRC32C",
        checksum_sha1: "ChecksumSHA1",
        checksum_sha256: "ChecksumSHA256",
        part_number: 1,
      },
    ],
  },
  upload_id: "MultipartUploadId", # required
  checksum_crc32: "ChecksumCRC32",
  checksum_crc32c: "ChecksumCRC32C",
  checksum_sha1: "ChecksumSHA1",
  checksum_sha256: "ChecksumSHA256",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  if_match: "IfMatch",
  if_none_match: "IfNoneMatch",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
})

Response structure


resp.location #=> String
resp.bucket #=> String
resp.key #=> String
resp.expiration #=> String
resp.etag #=> String
resp.checksum_crc32 #=> String
resp.checksum_crc32c #=> String
resp.checksum_sha1 #=> String
resp.checksum_sha256 #=> String
resp.server_side_encryption #=> String, one of "AES256", "aws:kms", "aws:kms:dsse"
resp.version_id #=> String
resp.ssekms_key_id #=> String
resp.bucket_key_enabled #=> Boolean
resp.request_charged #=> String, one of "requester"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    Name of the bucket to which the multipart upload was initiated.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][3

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :key (required, String) —

    Object key for which the multipart upload was initiated.

  • :multipart_upload (Types::CompletedMultipartUpload) —

    The container for the multipart upload request information.

  • :upload_id (required, String) —

    ID for the initiated multipart upload.

  • :checksum_crc32 (String) —

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

  • :checksum_crc32c (String) —

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

  • :checksum_sha1 (String) —

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

  • :checksum_sha256 (String) —

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :if_match (String) —

    Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a ‘412 Precondition Failed` error.

    If a conflicting operation occurs during the upload S3 returns a ‘409 ConditionalRequestConflict` response. On a 409 failure you should fetch the object’s ETag, re-initiate the multipart upload with ‘CreateMultipartUpload`, and re-upload each part.

    Expects the ETag value as a string.

    For more information about conditional requests, see [RFC 7232], or

    Conditional requests][2

    in the *Amazon S3 User Guide*.

    [1]: tools.ietf.org/html/rfc7232 [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html

  • :if_none_match (String) —

    Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a ‘412 Precondition Failed` error.

    If a conflicting operation occurs during the upload S3 returns a ‘409 ConditionalRequestConflict` response. On a 409 failure you should re-initiate the multipart upload with `CreateMultipartUpload` and re-upload each part.

    Expects the ‘*’ (asterisk) character.

    For more information about conditional requests, see [RFC 7232], or

    Conditional requests][2

    in the *Amazon S3 User Guide*.

    [1]: tools.ietf.org/html/rfc7232 [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html

  • :sse_customer_algorithm (String) —

    The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key

  • :sse_customer_key (String) —

    The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :sse_customer_key_md5 (String) —

    The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:

See Also:



1219
1220
1221
1222
 
# File 'lib/aws-sdk-s3/client.rb', line 1219

def complete_multipart_upload(params = {}, options = {})
  req = build_request(:complete_multipart_upload, params)
  req.send_request(options)
end

#copy_object(params = {}) ⇒ Types::CopyObjectOutput

Creates a copy of an object that is already stored in Amazon S3.

<note markdown=“1”> You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see [Copy Object Using the REST Multipart Upload API].

</note>

You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.

<note markdown=“1”> * Amazon S3 supports copy operations using Multi-Region Access Points

only as a destination when using the Multi-Region Access Point ARN.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format ‘bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

  • VPC endpoints don’t support cross-Region requests (including copies). If you’re using VPC endpoints, your source and destination buckets should be in the same Amazon Web Services Region as your VPC endpoint.

</note>

Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. For more information about how to enable a Region for your account, see [Enable or disable a Region for standalone accounts] in the *Amazon Web Services Account Management Guide*.

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a ‘400 Bad Request` error. For more information, see [Transfer Acceleration].

Authentication and authorization

: All ‘CopyObject` requests must be authenticated and signed by using

IAM credentials (access key ID and secret access key for the IAM
identities). All headers with the `x-amz-` prefix, including
`x-amz-copy-source`, must be signed. For more information, see [REST
Authentication][6].

**Directory buckets** - You must use the IAM credentials to
authenticate and authorize your access to the `CopyObject` API
operation, instead of using the temporary security credentials
through the `CreateSession` API operation.

Amazon Web Services CLI or SDKs handles authentication and
authorization on your behalf.

Permissions

: You must have read access to the source object and write access

to the destination bucket.

* **General purpose bucket permissions** - You must have permissions
  in an IAM policy based on the source and destination bucket types
  in a `CopyObject` operation.

  * If the source object is in a general purpose bucket, you must
    have <b> <code>s3:GetObject</code> </b> permission to read the
    source object that is being copied.

  * If the destination bucket is a general purpose bucket, you must
    have <b> <code>s3:PutObject</code> </b> permission to write the
    object copy to the destination bucket.
* **Directory bucket permissions** - You must have permissions in a
  bucket policy or an IAM identity-based policy based on the source
  and destination bucket types in a `CopyObject` operation.

  * If the source object that you want to copy is in a directory
    bucket, you must have the <b>
    <code>s3express:CreateSession</code> </b> permission in the
    `Action` element of a policy to read the object. By default, the
    session is in the `ReadWrite` mode. If you want to restrict the
    access, you can explicitly set the `s3express:SessionMode`
    condition key to `ReadOnly` on the copy source bucket.

  * If the copy destination is a directory bucket, you must have the
    <b> <code>s3express:CreateSession</code> </b> permission in the
    `Action` element of a policy to write the object to the
    destination. The `s3express:SessionMode` condition key can't be
    set to `ReadOnly` on the copy destination bucket.
  If the object is encrypted with SSE-KMS, you must also have the
  `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
  identity-based policies and KMS key policies for the KMS key.

  For example policies, see [Example bucket policies for S3 Express
  One Zone][7] and [Amazon Web Services Identity and Access
  Management (IAM) identity-based policies for S3 Express One
  Zone][8] in the *Amazon S3 User Guide*.

Response and special errors

: When the request is an HTTP 1.1 request, the response is chunk

encoded. When the request is not an HTTP 1.1 request, the response
would not contain the `Content-Length`. You always need to read the
entire response body to check if the copy succeeds.

* If the copy is successful, you receive a response with information
  about the copied object.

* A copy request might return an error when Amazon S3 receives the
  copy request or while Amazon S3 is copying the files. A `200 OK`
  response can contain either a success or an error.

  * If the error occurs before the copy action starts, you receive a
    standard Amazon S3 error.

  * If the error occurs during the copy operation, the error
    response is embedded in the `200 OK` response. For example, in a
    cross-region copy, you may encounter throttling and receive a
    `200 OK` response. For more information, see [Resolve the Error
    200 response when copying objects to Amazon S3][9]. The `200 OK`
    status code means the copy was accepted, but it doesn't mean
    the copy is complete. Another example is when you disconnect
    from Amazon S3 before the copy is complete, Amazon S3 might
    cancel the copy and you may receive a `200 OK` response. You
    must stay connected to Amazon S3 until the entire response is
    successfully received and processed.

    If you call this API operation directly, make sure to design
    your application to parse the content of the response and handle
    it appropriately. If you use Amazon Web Services SDKs, SDKs
    handle this condition. The SDKs detect the embedded error and
    apply error handling per your configuration settings (including
    automatically retrying the request as appropriate). If the
    condition persists, the SDKs throw an exception (or, for the
    SDKs that don't use exceptions, they return an error).

Charge

: The copy request charge is based on the storage class and Region

that you specify for the destination object. The request can also
result in a data retrieval charge for the source if the source
storage class bills for data retrieval. If the copy source is in a
different region, the data transfer is billed to the copy source
account. For pricing information, see [Amazon S3 pricing][10].

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following operations are related to ‘CopyObject`:

  • PutObject][11
  • GetObject][12

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [4]: docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone [5]: docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html [8]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html [9]: repost.aws/knowledge-center/s3-resolve-200-internalerror [10]: aws.amazon.com/s3/pricing/ [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [12]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html

Examples:

Example: To copy an object


# The following example copies an object from one bucket to another.

resp = client.copy_object({
  bucket: "destinationbucket", 
  copy_source: "/sourcebucket/HappyFacejpg", 
  key: "HappyFaceCopyjpg", 
})

resp.to_h outputs the following:
{
  copy_object_result: {
    etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    last_modified: Time.parse("2016-12-15T17:38:53.000Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.copy_object({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  bucket: "BucketName", # required
  cache_control: "CacheControl",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  content_disposition: "ContentDisposition",
  content_encoding: "ContentEncoding",
  content_language: "ContentLanguage",
  content_type: "ContentType",
  copy_source: "CopySource", # required
  copy_source_if_match: "CopySourceIfMatch",
  copy_source_if_modified_since: Time.now,
  copy_source_if_none_match: "CopySourceIfNoneMatch",
  copy_source_if_unmodified_since: Time.now,
  expires: Time.now,
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  metadata_directive: "COPY", # accepts COPY, REPLACE
  tagging_directive: "COPY", # accepts COPY, REPLACE
  server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  bucket_key_enabled: false,
  copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
  copy_source_sse_customer_key: "CopySourceSSECustomerKey",
  copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
  expected_bucket_owner: "AccountId",
  expected_source_bucket_owner: "AccountId",
})

Response structure


resp.copy_object_result.etag #=> String
resp.copy_object_result.last_modified #=> Time
resp.copy_object_result.checksum_crc32 #=> String
resp.copy_object_result.checksum_crc32c #=> String
resp.copy_object_result.checksum_sha1 #=> String
resp.copy_object_result.checksum_sha256 #=> String
resp.expiration #=> String
resp.copy_source_version_id #=> String
resp.version_id #=> String
resp.server_side_encryption #=> String, one of "AES256", "aws:kms", "aws:kms:dsse"
resp.sse_customer_algorithm #=> String
resp.sse_customer_key_md5 #=> String
resp.ssekms_key_id #=> String
resp.ssekms_encryption_context #=> String
resp.bucket_key_enabled #=> Boolean
resp.request_charged #=> String, one of "requester"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :acl (String) —

    The canned access control list (ACL) to apply to the object.

    When you copy an object, the ACL metadata is not preserved and is set to ‘private` by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see [Using ACLs].

    If the destination bucket that you’re copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept ‘PUT` requests that don’t specify an ACL or ‘PUT` requests that specify bucket owner full control ACLs, such as the `bucket-owner-full-control` canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see

    Controlling ownership of objects and disabling ACLs][2

    in the

    *Amazon S3 User Guide*.

    <note markdown=“1”> * If your destination bucket uses the bucket owner enforced setting

    for Object Ownership, all objects written to the bucket by any
account will be owned by the bucket owner.

    • This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html

  • :bucket (required, String) —

    The name of the destination bucket.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Copying objects across different Amazon Web Services Regions isn’t supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP ‘400 Bad Request` error with the error code `InvalidRequest`.

    </note>

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][3

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :cache_control (String) —

    Specifies the caching behavior along the request/reply chain.

  • :checksum_algorithm (String) —

    Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the ‘CopyObject` request does not include this `x-amz-checksum-algorithm` header, the checksum algorithm will be copied from the source object to the destination object (if it’s present on the source object). You can optionally specify a different checksum algorithm to use with the ‘x-amz-checksum-algorithm` header. Unrecognized or unsupported values will respond with the HTTP status code `400 Bad Request`.

    <note markdown=“1”> For directory buckets, when you use Amazon Web Services SDKs, ‘CRC32` is the default checksum algorithm that’s used for performance.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

  • :content_disposition (String) —

    Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.

  • :content_encoding (String) —

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    <note markdown=“1”> For directory buckets, only the ‘aws-chunked` value is supported in this header field.

    </note>
  • :content_language (String) —

    The language the content is in.

  • :content_type (String) —

    A standard MIME type that describes the format of the object data.

  • :copy_source (required, String) —

    Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.

    You specify the value of the copy source in one of two formats, depending on whether you want to access the source object through an [access point]:

    • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object ‘reports/january.pdf` from the general purpose bucket `awsexamplebucket`, use `awsexamplebucket/reports/january.pdf`. The value must be URL-encoded. To copy the object `reports/january.pdf` from the directory bucket `awsexamplebucket–use1-az5–x-s3`, use `awsexamplebucket–use1-az5–x-s3/reports/january.pdf`. The value must be URL-encoded.

    • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format ‘arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>`. For example, to copy the object `reports/january.pdf` through access point `my-access-point` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf`. The value must be URL encoded.

      <note markdown=“1”> * Amazon S3 supports copy operations using Access points only when

      the source and destination buckets are in the same Amazon Web
Services Region.

      • Access points are not supported by directory buckets.

      </note>

      Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>`. For example, to copy the object `reports/january.pdf` through outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf`. The value must be URL-encoded.

    If your source bucket versioning is enabled, the ‘x-amz-copy-source` header by default identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the `versionId` query parameter. Specifically, append `?versionId=<version-id>` to the value (for example, `awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`). If you don’t specify a version ID, Amazon S3 copies the latest version of the source object.

    If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the ‘x-amz-version-id` response header in the response.

    If you do not enable versioning or suspend it on the destination bucket, the version ID that Amazon S3 generates in the ‘x-amz-version-id` response header is always null.

    <note markdown=“1”> **Directory buckets** - S3 Versioning isn’t enabled and supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html

  • :copy_source_if_match (String) —

    Copies the object if its entity tag (ETag) matches the specified tag.

    If both the ‘x-amz-copy-source-if-match` and `x-amz-copy-source-if-unmodified-since` headers are present in the request and evaluate as follows, Amazon S3 returns `200 OK` and copies the data:

    • ‘x-amz-copy-source-if-match` condition evaluates to true

    • ‘x-amz-copy-source-if-unmodified-since` condition evaluates to false

  • :copy_source_if_modified_since (Time, DateTime, Date, Integer, String) —

    Copies the object if it has been modified since the specified time.

    If both the ‘x-amz-copy-source-if-none-match` and `x-amz-copy-source-if-modified-since` headers are present in the request and evaluate as follows, Amazon S3 returns the `412 Precondition Failed` response code:

    • ‘x-amz-copy-source-if-none-match` condition evaluates to false

    • ‘x-amz-copy-source-if-modified-since` condition evaluates to true

  • :copy_source_if_none_match (String) —

    Copies the object if its entity tag (ETag) is different than the specified ETag.

    If both the ‘x-amz-copy-source-if-none-match` and `x-amz-copy-source-if-modified-since` headers are present in the request and evaluate as follows, Amazon S3 returns the `412 Precondition Failed` response code:

    • ‘x-amz-copy-source-if-none-match` condition evaluates to false

    • ‘x-amz-copy-source-if-modified-since` condition evaluates to true

  • :copy_source_if_unmodified_since (Time, DateTime, Date, Integer, String) —

    Copies the object if it hasn’t been modified since the specified time.

    If both the ‘x-amz-copy-source-if-match` and `x-amz-copy-source-if-unmodified-since` headers are present in the request and evaluate as follows, Amazon S3 returns `200 OK` and copies the data:

    • ‘x-amz-copy-source-if-match` condition evaluates to true

    • ‘x-amz-copy-source-if-unmodified-since` condition evaluates to false

  • :expires (Time, DateTime, Date, Integer, String) —

    The date and time at which the object is no longer cacheable.

  • :grant_full_control (String) —

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>
  • :grant_read (String) —

    Allows grantee to read the object data and its metadata.

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>
  • :grant_read_acp (String) —

    Allows grantee to read the object ACL.

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>
  • :grant_write_acp (String) —

    Allows grantee to write the ACL for the applicable object.

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>
  • :key (required, String) —

    The key of the destination object.

  • :metadata (Hash<String,String>) —

    A map of metadata to store with the object in S3.

  • :metadata_directive (String) —

    Specifies whether the metadata is copied from the source object or replaced with metadata that’s provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, ‘COPY` is the default behavior.

    **General purpose bucket** - For general purpose buckets, when you grant permissions, you can use the ‘s3:x-amz-metadata-directive` condition key to enforce certain metadata behavior when objects are uploaded. For more information, see [Amazon S3 condition key examples] in the *Amazon S3 User Guide*.

    <note markdown=“1”> ‘x-amz-website-redirect-location` is unique to each object and is not copied when using the `x-amz-metadata-directive` header. To copy the value, you must specify `x-amz-website-redirect-location` in the request header.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html

  • :tagging_directive (String) —

    Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that’s provided in the request.

    The default value is ‘COPY`.

    <note markdown=“1”> **Directory buckets** - For directory buckets in a ‘CopyObject` operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a `501 Not Implemented` status code. When the destination bucket is a directory bucket, you will receive a `501 Not Implemented` response in any of the following situations:

    * When you attempt to `COPY` the tag-set from an S3 source object that
 has non-empty tags.

    • When you attempt to ‘REPLACE` the tag-set of a source object and set a non-empty value to `x-amz-tagging`.

    • When you don’t set the ‘x-amz-tagging-directive` header and the source object has non-empty tags. This is because the default value of `x-amz-tagging-directive` is `COPY`.

    Because only the empty tag-set is supported for directory buckets in a

    ‘CopyObject` operation, the following situations are allowed:

    * When you attempt to `COPY` the tag-set from a directory bucket
 source object that has no tags to a general purpose bucket. It
 copies an empty tag-set to the destination object.

    • When you attempt to ‘REPLACE` the tag-set of a directory bucket source object and set the `x-amz-tagging` value of the directory bucket destination object to empty.

    • When you attempt to ‘REPLACE` the tag-set of a general purpose bucket source object that has non-empty tags and set the `x-amz-tagging` value of the directory bucket destination object to empty.

    • When you attempt to ‘REPLACE` the tag-set of a directory bucket source object and don’t set the ‘x-amz-tagging` value of the directory bucket destination object. This is because the default value of `x-amz-tagging` is the empty value.

    </note>
  • :server_side_encryption (String) —

    The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized or unsupported values won’t write a destination object and will receive a ‘400 Bad Request` response.

    Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don’t specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a different default encryption configuration, Amazon S3 uses the corresponding encryption key to encrypt the target object copy.

    With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see

    Using Server-Side Encryption][1

    in the *Amazon S3 User Guide*.

    General purpose buckets

    • For general purpose buckets, there are the following supported options for server-side encryption: server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and server-side encryption with customer-provided encryption keys (SSE-C). Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target object copy.

    • When you perform a ‘CopyObject` operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

    Directory buckets

    • For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (‘AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We recommend that the bucket’s default encryption uses the desired encryption configuration and you don’t override the bucket default encryption in your ‘CreateSession` requests or `PUT` object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see [Protecting data with server-side encryption] in the *Amazon S3 User Guide*. For more information about the encryption overriding behaviors in directory buckets, see [Specifying server-side encryption with KMS for new object uploads].

    • To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you specify SSE-KMS as the directory bucket’s default encryption configuration with a KMS key (specifically, a [customer managed key]). The [Amazon Web Services managed key] (‘aws/s3`) isn’t supported. Your SSE-KMS configuration can only support 1 [customer managed key] per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS, you can’t override the customer managed key for the bucket’s SSE-KMS configuration. Then, when you perform a ‘CopyObject` operation and want to specify server-side encryption settings for new object copies with SSE-KMS in the encryption-related request headers, you must ensure the encryption key is the same customer managed key that you specified for the directory bucket’s default encryption configuration.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html [4]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [5]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

  • :storage_class (String) —

    If the ‘x-amz-storage-class` header is not used, the copied object will be stored in the `STANDARD` Storage Class by default. The `STANDARD` storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.

    <note markdown=“1”> * Directory buckets - For directory buckets, only the S3

    Express One Zone storage class is supported to store newly created
objects. Unsupported storage class values won't write a destination
object and will respond with the HTTP status code `400 Bad Request`.

    • Amazon S3 on Outposts - S3 on Outposts only uses the ‘OUTPOSTS` Storage Class.

    </note>

    You can use the ‘CopyObject` action to change the storage class of an object that is already stored in Amazon S3 by using the `x-amz-storage-class` header. For more information, see [Storage Classes] in the *Amazon S3 User Guide*.

    Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:

    • The storage class of the source object is ‘GLACIER` or `DEEP_ARCHIVE`.

    • The storage class of the source object is ‘INTELLIGENT_TIERING` and it’s [S3 Intelligent-Tiering access tier] is ‘Archive Access` or `Deep Archive Access`.

    For more information, see [RestoreObject] and [Copying Objects] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html

  • :website_redirect_location (String) —

    If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the ‘x-amz-metadata-directive` header. Instead, you may opt to provide this header in combination with the `x-amz-metadata-directive` header.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :sse_customer_algorithm (String) —

    Specifies the algorithm to use when encrypting the object (for example, ‘AES256`).

    When you perform a ‘CopyObject` operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

    <note markdown=“1”> This functionality is not supported when the destination bucket is a directory bucket.

    </note>
  • :sse_customer_key (String) —

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded. Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

    <note markdown=“1”> This functionality is not supported when the destination bucket is a directory bucket.

    </note>
  • :sse_customer_key_md5 (String) —

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    <note markdown=“1”> This functionality is not supported when the destination bucket is a directory bucket.

    </note>
  • :ssekms_key_id (String) —

    Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they’re not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see [Specifying the Signature Version in Request Authentication] in the *Amazon S3 User Guide*.

    **Directory buckets** - If you specify ‘x-amz-server-side-encryption` with `aws:kms`, the ` x-amz-server-side-encryption-aws-kms-key-id` header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that’s configured for your directory bucket’s default encryption setting. If you want to specify the ‘ x-amz-server-side-encryption-aws-kms-key-id` header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that’s configured for your directory bucket’s default encryption setting. Otherwise, you get an HTTP ‘400 Bad Request` error. Only use the key ID or key ARN. The key alias format of the KMS key isn’t supported. Your SSE-KMS configuration can only support 1 [customer managed key] per directory bucket for the lifetime of the bucket. The [Amazon Web Services managed key] (‘aws/s3`) isn’t supported.

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [3]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

  • :ssekms_encryption_context (String) —

    Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for the destination object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    **General purpose buckets** - This value must be explicitly added to specify encryption context for ‘CopyObject` requests if you want an additional encryption context for your destination object. The additional encryption context of the source object won’t be copied to the destination object. For more information, see [Encryption context] in the *Amazon S3 User Guide*.

    **Directory buckets** - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context

  • :bucket_key_enabled (Boolean) —

    Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.

    Setting this header to ‘true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

    For more information, see [Amazon S3 Bucket Keys] in the *Amazon S3 User Guide*.

    <note markdown=“1”> **Directory buckets** - S3 Bucket Keys aren’t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through [CopyObject]. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html

  • :copy_source_sse_customer_algorithm (String) —

    Specifies the algorithm to use when decrypting the source object (for example, ‘AES256`).

    If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

    <note markdown=“1”> This functionality is not supported when the source object is in a directory bucket.

    </note>
  • :copy_source_sse_customer_key (String) —

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be the same one that was used when the source object was created.

    If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

    <note markdown=“1”> This functionality is not supported when the source object is in a directory bucket.

    </note>
  • :copy_source_sse_customer_key_md5 (String) —

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

    <note markdown=“1”> This functionality is not supported when the source object is in a directory bucket.

    </note>
  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :tagging (String) —

    The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the ‘x-amz-tagging-directive` if you choose `REPLACE` for the `x-amz-tagging-directive`. If you choose `COPY` for the `x-amz-tagging-directive`, you don’t need to set the ‘x-amz-tagging` header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.

    The default value is the empty value.

    <note markdown=“1”> **Directory buckets** - For directory buckets in a ‘CopyObject` operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a `501 Not Implemented` status code. When the destination bucket is a directory bucket, you will receive a `501 Not Implemented` response in any of the following situations:

    * When you attempt to `COPY` the tag-set from an S3 source object that
 has non-empty tags.

    • When you attempt to ‘REPLACE` the tag-set of a source object and set a non-empty value to `x-amz-tagging`.

    • When you don’t set the ‘x-amz-tagging-directive` header and the source object has non-empty tags. This is because the default value of `x-amz-tagging-directive` is `COPY`.

    Because only the empty tag-set is supported for directory buckets in a

    ‘CopyObject` operation, the following situations are allowed:

    * When you attempt to `COPY` the tag-set from a directory bucket
 source object that has no tags to a general purpose bucket. It
 copies an empty tag-set to the destination object.

    • When you attempt to ‘REPLACE` the tag-set of a directory bucket source object and set the `x-amz-tagging` value of the directory bucket destination object to empty.

    • When you attempt to ‘REPLACE` the tag-set of a general purpose bucket source object that has non-empty tags and set the `x-amz-tagging` value of the directory bucket destination object to empty.

    • When you attempt to ‘REPLACE` the tag-set of a directory bucket source object and don’t set the ‘x-amz-tagging` value of the directory bucket destination object. This is because the default value of `x-amz-tagging` is the empty value.

    </note>
  • :object_lock_mode (String) —

    The Object Lock mode that you want to apply to the object copy.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —

    The date and time when you want the Object Lock of the object copy to expire.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :object_lock_legal_hold_status (String) —

    Specifies whether you want to apply a legal hold to the object copy.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :expected_bucket_owner (String) —

    The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :expected_source_bucket_owner (String) —

    The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



2275
2276
2277
2278
 
# File 'lib/aws-sdk-s3/client.rb', line 2275

def copy_object(params = {}, options = {})
  req = build_request(:copy_object, params)
  req.send_request(options)
end

#create_bucket(params = {}) ⇒ Types::CreateBucketOutput

<note markdown=“1”> This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see [ ‘CreateBucket` ][1].

</note>

Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see [Creating, configuring, and working with Amazon S3 buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> * **General purpose buckets** - If you send your ‘CreateBucket`

request to the `s3.amazonaws.com` global endpoint, the request goes
to the `us-east-1` Region. So the signature calculations in
Signature Version 4 must use `us-east-1` as the Region, even if the
location constraint in the request specifies another Region where
the bucket is to be created. If you create a bucket in a Region
other than US East (N. Virginia), your application must be able to
handle 307 redirect. For more information, see [Virtual hosting of
buckets][3] in the *Amazon S3 User Guide*.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

Permissions : * **General purpose bucket permissions** - In addition to the

  `s3:CreateBucket` permission, the following permissions are
  required in a policy when your `CreateBucket` request includes
  specific headers:

  * **Access control lists (ACLs)** - In your `CreateBucket`
    request, if you specify an access control list (ACL) and set it
    to `public-read`, `public-read-write`, `authenticated-read`, or
    if you explicitly specify any other custom ACLs, both
    `s3:CreateBucket` and `s3:PutBucketAcl` permissions are
    required. In your `CreateBucket` request, if you set the ACL to
    `private`, or if you don't specify any ACLs, only the
    `s3:CreateBucket` permission is required.

  * **Object Lock** - In your `CreateBucket` request, if you set
    `x-amz-bucket-object-lock-enabled` to true, the
    `s3:PutBucketObjectLockConfiguration` and
    `s3:PutBucketVersioning` permissions are required.

  * **S3 Object Ownership** - If your `CreateBucket` request
    includes the `x-amz-object-ownership` header, then the
    `s3:PutBucketOwnershipControls` permission is required.

    To set an ACL on a bucket as part of a `CreateBucket` request,
    you must explicitly set S3 Object Ownership for the bucket to a
    different value than the default, `BucketOwnerEnforced`.
    Additionally, if your desired bucket ACL grants public access,
    you must first create the bucket (without the bucket ACL) and
    then explicitly disable Block Public Access on the bucket before
    using `PutBucketAcl` to set the ACL. If you try to create a
    bucket with a public ACL, the request will fail.

     For the majority of modern use cases in S3, we recommend that
    you keep all Block Public Access settings enabled and keep ACLs
    disabled. If you would like to share data with users outside of
    your account, you can use bucket policies as needed. For more
    information, see [Controlling ownership of objects and disabling
    ACLs for your bucket ][6] and [Blocking public access to your
    Amazon S3 storage ][7] in the *Amazon S3 User Guide*.

  * **S3 Block Public Access** - If your specific use case requires
    granting public access to your S3 resources, you can disable
    Block Public Access. Specifically, you can create a new bucket
    with Block Public Access enabled, then separately call the [
    `DeletePublicAccessBlock` ][8] API. To use this operation, you
    must have the `s3:PutBucketPublicAccessBlock` permission. For
    more information about S3 Block Public Access, see [Blocking
    public access to your Amazon S3 storage ][7] in the *Amazon S3
    User Guide*.
* **Directory bucket permissions** - You must have the
  `s3express:CreateBucket` permission in an IAM identity-based
  policy instead of a bucket policy. Cross-account access to this
  API operation isn't supported. This operation can only be
  performed by the Amazon Web Services account that owns the
  resource. For more information about directory bucket policies and
  permissions, see [Amazon Web Services Identity and Access
  Management (IAM) for S3 Express One Zone][9] in the *Amazon S3
  User Guide*.

  The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
  Block Public Access are not supported for directory buckets. For
  directory buckets, all Block Public Access settings are enabled at
  the bucket level and S3 Object Ownership is set to Bucket owner
  enforced (ACLs disabled). These settings can't be modified.

   For more information about permissions for creating and working
  with directory buckets, see [Directory buckets][10] in the *Amazon
  S3 User Guide*. For more information about supported S3 features
  for directory buckets, see [Features of S3 Express One Zone][11]
  in the *Amazon S3 User Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region-code.amazonaws.com`.

The following operations are related to ‘CreateBucket`:

  • PutObject][12
  • DeleteBucket][13

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html [9]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [10]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html [11]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features [12]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [13]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html

Examples:

Example: To create a bucket in a specific region


# The following example creates a bucket. The request specifies an AWS region where to create the bucket.

resp = client.create_bucket({
  bucket: "examplebucket", 
  create_bucket_configuration: {
    location_constraint: "eu-west-1", 
  }, 
})

resp.to_h outputs the following:
{
  location: "http://examplebucket.<Region>.s3.amazonaws.com/", 
}

Example: To create a bucket


# The following example creates a bucket.

resp = client.create_bucket({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  location: "/examplebucket", 
}

Request syntax with placeholder values


resp = client.create_bucket({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read
  bucket: "BucketName", # required
  create_bucket_configuration: {
    location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
    location: {
      type: "AvailabilityZone", # accepts AvailabilityZone, LocalZone
      name: "LocationNameAsString",
    },
    bucket: {
      data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone, SingleLocalZone
      type: "Directory", # accepts Directory
    },
  },
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  object_lock_enabled_for_bucket: false,
  object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
})

Response structure


resp.location #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :acl (String) —

    The canned ACL to apply to the bucket.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :bucket (required, String) —

    The name of the bucket to create.

    **General purpose buckets** - For information about bucket naming restrictions, see [Bucket naming rules] in the *Amazon S3 User Guide*.

    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ‘ bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

  • :create_bucket_configuration (Types::CreateBucketConfiguration) —

    The configuration information for the bucket.

  • :grant_full_control (String) —

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :grant_read (String) —

    Allows grantee to list the objects in the bucket.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :grant_read_acp (String) —

    Allows grantee to read the bucket ACL.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :grant_write (String) —

    Allows grantee to create new objects in the bucket.

    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :grant_write_acp (String) —

    Allows grantee to write the ACL for the applicable bucket.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :object_lock_enabled_for_bucket (Boolean) —

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :object_ownership (String) —

    The container element for object ownership for a bucket’s ownership controls.

    ‘BucketOwnerPreferred` - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the `bucket-owner-full-control` canned ACL.

    ‘ObjectWriter` - The uploading account will own the object if the object is uploaded with the `bucket-owner-full-control` canned ACL.

    ‘BucketOwnerEnforced` - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don’t specify an ACL or specify bucket owner full control ACLs (such as the predefined ‘bucket-owner-full-control` canned ACL or a custom ACL in XML format that grants the same permissions).

    By default, ‘ObjectOwnership` is set to `BucketOwnerEnforced` and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see [Controlling ownership of objects and disabling ACLs for your bucket] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html

Returns:

See Also:



2599
2600
2601
2602
 
# File 'lib/aws-sdk-s3/client.rb', line 2599

def create_bucket(params = {}, options = {})
  req = build_request(:create_bucket, params)
  req.send_request(options)
end

#create_bucket_metadata_table_configuration(params = {}) ⇒ Struct

Creates a metadata table configuration for a general purpose bucket. For more information, see [Accelerating data discovery with S3 Metadata] in the *Amazon S3 User Guide*.

Permissions

: To use this operation, you must have the following permissions. For

more information, see [Setting up permissions for configuring
metadata tables][2] in the *Amazon S3 User Guide*.

If you also want to integrate your table bucket with Amazon Web
Services analytics services so that you can query your metadata
table, you need additional permissions. For more information, see [
Integrating Amazon S3 Tables with Amazon Web Services analytics
services][3] in the *Amazon S3 User Guide*.

* `s3:CreateBucketMetadataTableConfiguration`

* `s3tables:CreateNamespace`

* `s3tables:GetTable`

* `s3tables:CreateTable`

* `s3tables:PutTablePolicy`

The following operations are related to ‘CreateBucketMetadataTableConfiguration`:

  • DeleteBucketMetadataTableConfiguration][4
  • GetBucketMetadataTableConfiguration][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-integrating-aws.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.create_bucket_metadata_table_configuration({
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  metadata_table_configuration: { # required
    s3_tables_destination: { # required
      table_bucket_arn: "S3TablesBucketArn", # required
      table_name: "S3TablesName", # required
    },
  },
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The general purpose bucket that you want to create the metadata table configuration in.

  • :content_md5 (String) —

    The ‘Content-MD5` header for the metadata table configuration.

  • :checksum_algorithm (String) —

    The checksum algorithm to use with your metadata table configuration.

  • :metadata_table_configuration (required, Types::MetadataTableConfiguration) —

    The contents of your metadata table configuration.

  • :expected_bucket_owner (String) —

    The expected owner of the general purpose bucket that contains your metadata table configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2683
2684
2685
2686
 
# File 'lib/aws-sdk-s3/client.rb', line 2683

def create_bucket_metadata_table_configuration(params = {}, options = {})
  req = build_request(:create_bucket_metadata_table_configuration, params)
  req.send_request(options)
end

#create_multipart_upload(params = {}) ⇒ Types::CreateMultipartUploadOutput

This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see [UploadPart]). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see [Multipart Upload Overview] in the *Amazon S3 User Guide*.

<note markdown=“1”> After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stops charging you for storing them only after you either complete or abort a multipart upload.

</note>

If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration].

<note markdown=“1”> * Directory buckets - S3 Lifecycle is not supported by

directory buckets.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format ‘bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

Request signing

: For request signing, multipart upload is just a series of regular

requests. You initiate a multipart upload, send one or more requests
to upload parts, and then complete the multipart upload process. You
sign each request individually. There is nothing special about
signing multipart upload requests. For more information about
signing, see [Authenticating Requests (Amazon Web Services Signature
Version 4)][6] in the *Amazon S3 User Guide*.

Permissions : * **General purpose bucket permissions** - To perform a multipart

  upload with encryption using an Key Management Service (KMS) KMS
  key, the requester must have permission to the `kms:Decrypt` and
  `kms:GenerateDataKey` actions on the key. The requester must also
  have permissions for the `kms:GenerateDataKey` action for the
  `CreateMultipartUpload` API. Then, the requester needs permissions
  for the `kms:Decrypt` action on the `UploadPart` and
  `UploadPartCopy` APIs. These permissions are required because
  Amazon S3 must decrypt and read data from the encrypted file parts
  before it completes the multipart upload. For more information,
  see [Multipart upload API and permissions][7] and [Protecting data
  using server-side encryption with Amazon Web Services KMS][8] in
  the *Amazon S3 User Guide*.

* **Directory bucket permissions** - To grant access to this API
  operation on a directory bucket, we recommend that you use the [
  `CreateSession` ][9] API operation for session-based
  authorization. Specifically, you grant the
  `s3express:CreateSession` permission to the directory bucket in a
  bucket policy or an IAM identity-based policy. Then, you make the
  `CreateSession` API call on the bucket to obtain a session token.
  With the session token in your request header, you can make API
  requests to this operation. After the session token expires, you
  make another `CreateSession` API call to generate a new session
  token for use. Amazon Web Services CLI or SDKs create session and
  refresh the session token automatically to avoid service
  interruptions when a session expires. For more information about
  authorization, see [ `CreateSession` ][9].

Encryption : * **General purpose buckets** - Server-side encryption is for data

  encryption at rest. Amazon S3 encrypts your data as it writes it
  to disks in its data centers and decrypts it when you access it.
  Amazon S3 automatically encrypts all new objects that are uploaded
  to an S3 bucket. When doing a multipart upload, if you don't
  specify encryption information in your request, the encryption
  setting of the uploaded parts is set to the default encryption
  configuration of the destination bucket. By default, all buckets
  have a base level of encryption configuration that uses
  server-side encryption with Amazon S3 managed keys (SSE-S3). If
  the destination bucket has a default encryption configuration that
  uses server-side encryption with an Key Management Service (KMS)
  key (SSE-KMS), or a customer-provided encryption key (SSE-C),
  Amazon S3 uses the corresponding KMS key, or a customer-provided
  key to encrypt the uploaded parts. When you perform a
  CreateMultipartUpload operation, if you want to use a different
  type of encryption setting for the uploaded parts, you can request
  that Amazon S3 encrypts the object with a different encryption key
  (such as an Amazon S3 managed key, a KMS key, or a
  customer-provided key). When the encryption setting in your
  request is different from the default encryption configuration of
  the destination bucket, the encryption setting in your request
  takes precedence. If you choose to provide your own encryption
  key, the request headers you provide in [UploadPart][1] and
  [UploadPartCopy][10] requests must match the headers you used in
  the `CreateMultipartUpload` request.

  * Use KMS keys (SSE-KMS) that include the Amazon Web Services
    managed key (`aws/s3`) and KMS customer managed keys stored in
    Key Management Service (KMS) – If you want Amazon Web Services
    to manage the keys used to encrypt data, specify the following
    headers in the request.

    * `x-amz-server-side-encryption`

    * `x-amz-server-side-encryption-aws-kms-key-id`

    * `x-amz-server-side-encryption-context`
    <note markdown="1"> * If you specify `x-amz-server-side-encryption:aws:kms`, but
      don't provide `x-amz-server-side-encryption-aws-kms-key-id`,
      Amazon S3 uses the Amazon Web Services managed key (`aws/s3`
      key) in KMS to protect the data.

    * To perform a multipart upload with encryption by using an
      Amazon Web Services KMS key, the requester must have
      permission to the `kms:Decrypt` and `kms:GenerateDataKey*`
      actions on the key. These permissions are required because
      Amazon S3 must decrypt and read data from the encrypted file
      parts before it completes the multipart upload. For more
      information, see [Multipart upload API and permissions][7] and
      [Protecting data using server-side encryption with Amazon Web
      Services KMS][8] in the *Amazon S3 User Guide*.

    * If your Identity and Access Management (IAM) user or role is
      in the same Amazon Web Services account as the KMS key, then
      you must have these permissions on the key policy. If your IAM
      user or role is in a different account from the key, then you
      must have the permissions on both the key policy and your IAM
      user or role.

    * All `GET` and `PUT` requests for an object protected by KMS
      fail if you don't make them by using Secure Sockets Layer
      (SSL), Transport Layer Security (TLS), or Signature Version 4.
      For information about configuring any of the officially
      supported Amazon Web Services SDKs and Amazon Web Services
      CLI, see [Specifying the Signature Version in Request
      Authentication][11] in the *Amazon S3 User Guide*.

     </note>

    For more information about server-side encryption with KMS keys
    (SSE-KMS), see [Protecting Data Using Server-Side Encryption
    with KMS keys][8] in the *Amazon S3 User Guide*.

  * Use customer-provided encryption keys (SSE-C) – If you want to
    manage your own encryption keys, provide all the following
    headers in the request.

    * `x-amz-server-side-encryption-customer-algorithm`

    * `x-amz-server-side-encryption-customer-key`

    * `x-amz-server-side-encryption-customer-key-MD5`
    For more information about server-side encryption with
    customer-provided encryption keys (SSE-C), see [ Protecting data
    using server-side encryption with customer-provided encryption
    keys (SSE-C)][12] in the *Amazon S3 User Guide*.
* **Directory buckets** - For directory buckets, there are only two
  supported options for server-side encryption: server-side
  encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and
  server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We
  recommend that the bucket's default encryption uses the desired
  encryption configuration and you don't override the bucket
  default encryption in your `CreateSession` requests or `PUT`
  object requests. Then, new objects are automatically encrypted
  with the desired encryption settings. For more information, see
  [Protecting data with server-side encryption][13] in the *Amazon
  S3 User Guide*. For more information about the encryption
  overriding behaviors in directory buckets, see [Specifying
  server-side encryption with KMS for new object uploads][14].

  In the Zonal endpoint API calls (except [CopyObject][15] and
  [UploadPartCopy][10]) using the REST API, the encryption request
  headers must match the encryption settings that are specified in
  the `CreateSession` request. You can't override the values of the
  encryption settings (`x-amz-server-side-encryption`,
  `x-amz-server-side-encryption-aws-kms-key-id`,
  `x-amz-server-side-encryption-context`, and
  `x-amz-server-side-encryption-bucket-key-enabled`) that are
  specified in the `CreateSession` request. You don't need to
  explicitly specify these encryption settings values in Zonal
  endpoint API calls, and Amazon S3 will use the encryption settings
  values from the `CreateSession` request to protect new objects in
  the directory bucket.

  <note markdown="1"> When you use the CLI or the Amazon Web Services SDKs, for
  `CreateSession`, the session token refreshes automatically to
  avoid service interruptions when a session expires. The CLI or the
  Amazon Web Services SDKs use the bucket's default encryption
  configuration for the `CreateSession` request. It's not supported
  to override the encryption settings values in the `CreateSession`
  request. So in the Zonal endpoint API calls (except
  [CopyObject][15] and [UploadPartCopy][10]), the encryption request
  headers must match the default encryption configuration of the
  directory bucket.

   </note>

  <note markdown="1"> For directory buckets, when you perform a `CreateMultipartUpload`
  operation and an `UploadPartCopy` operation, the request headers
  you provide in the `CreateMultipartUpload` request must match the
  default encryption configuration of the destination bucket.

   </note>

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following operations are related to ‘CreateMultipartUpload`:

  • UploadPart][1
  • CompleteMultipartUpload][16
  • AbortMultipartUpload][17
  • ListParts][18
  • ListMultipartUploads][19

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions [8]: docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [11]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version [12]: docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html [13]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [14]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html [15]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [16]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [17]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html [18]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [19]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html

Examples:

Example: To initiate a multipart upload


# The following example initiates a multipart upload.

resp = client.create_multipart_upload({
  bucket: "examplebucket", 
  key: "largeobject", 
})

resp.to_h outputs the following:
{
  bucket: "examplebucket", 
  key: "largeobject", 
  upload_id: "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--", 
}

Request syntax with placeholder values


resp = client.create_multipart_upload({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  bucket: "BucketName", # required
  cache_control: "CacheControl",
  content_disposition: "ContentDisposition",
  content_encoding: "ContentEncoding",
  content_language: "ContentLanguage",
  content_type: "ContentType",
  expires: Time.now,
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  bucket_key_enabled: false,
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
  expected_bucket_owner: "AccountId",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
})

Response structure


resp.abort_date #=> Time
resp.abort_rule_id #=> String
resp.bucket #=> String
resp.key #=> String
resp.upload_id #=> String
resp.server_side_encryption #=> String, one of "AES256", "aws:kms", "aws:kms:dsse"
resp.sse_customer_algorithm #=> String
resp.sse_customer_key_md5 #=> String
resp.ssekms_key_id #=> String
resp.ssekms_encryption_context #=> String
resp.bucket_key_enabled #=> Boolean
resp.request_charged #=> String, one of "requester"
resp.checksum_algorithm #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :acl (String) —

    The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as *canned ACLs*. Each canned ACL has a predefined set of grantees and permissions. For more information, see

    Canned ACL][1

    in the *Amazon S3 User Guide*.

    By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see [Using ACLs]. One way to grant the permissions using the request headers is to specify a canned ACL with the ‘x-amz-acl` request header.

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL [2]: docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html

  • :bucket (required, String) —

    The name of the bucket where the multipart upload is initiated and where the object is uploaded.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][3

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :cache_control (String) —

    Specifies caching behavior along the request/reply chain.

  • :content_disposition (String) —

    Specifies presentational information for the object.

  • :content_encoding (String) —

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    <note markdown=“1”> For directory buckets, only the ‘aws-chunked` value is supported in this header field.

    </note>
  • :content_language (String) —

    The language that the content is in.

  • :content_type (String) —

    A standard MIME type describing the format of the object data.

  • :expires (Time, DateTime, Date, Integer, String) —

    The date and time at which the object is no longer cacheable.

  • :grant_full_control (String) —

    Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview] in the *Amazon S3 User Guide*.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • ‘id` – if the value specified is the canonical user ID of an Amazon Web Services account

    • ‘uri` – if you are granting permissions to a predefined group

    • ‘emailAddress` – if the value specified is the email address of an Amazon Web Services account

      <note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      * US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see
      Regions and Endpoints][2

      in the Amazon Web Services General

      Reference.

      </note>

    For example, the following ‘x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    ‘x-amz-grant-read: id=“11112222333”, id=“444455556666” `

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

  • :grant_read (String) —

    Specify access permissions explicitly to allow grantee to read the object data and its metadata.

    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview] in the *Amazon S3 User Guide*.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • ‘id` – if the value specified is the canonical user ID of an Amazon Web Services account

    • ‘uri` – if you are granting permissions to a predefined group

    • ‘emailAddress` – if the value specified is the email address of an Amazon Web Services account

      <note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      * US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see
      Regions and Endpoints][2

      in the Amazon Web Services General

      Reference.

      </note>

    For example, the following ‘x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    ‘x-amz-grant-read: id=“11112222333”, id=“444455556666” `

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

  • :grant_read_acp (String) —

    Specify access permissions explicitly to allows grantee to read the object ACL.

    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview] in the *Amazon S3 User Guide*.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • ‘id` – if the value specified is the canonical user ID of an Amazon Web Services account

    • ‘uri` – if you are granting permissions to a predefined group

    • ‘emailAddress` – if the value specified is the email address of an Amazon Web Services account

      <note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      * US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see
      Regions and Endpoints][2

      in the Amazon Web Services General

      Reference.

      </note>

    For example, the following ‘x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    ‘x-amz-grant-read: id=“11112222333”, id=“444455556666” `

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

  • :grant_write_acp (String) —

    Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.

    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview] in the *Amazon S3 User Guide*.

    You specify each grantee as a type=value pair, where the type is one of the following:

    • ‘id` – if the value specified is the canonical user ID of an Amazon Web Services account

    • ‘uri` – if you are granting permissions to a predefined group

    • ‘emailAddress` – if the value specified is the email address of an Amazon Web Services account

      <note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      * US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see
      Regions and Endpoints][2

      in the Amazon Web Services General

      Reference.

      </note>

    For example, the following ‘x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    ‘x-amz-grant-read: id=“11112222333”, id=“444455556666” `

    <note markdown=“1”> * This functionality is not supported for directory buckets.

    • This functionality is not supported for Amazon S3 on Outposts.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

  • :key (required, String) —

    Object key for which the multipart upload is to be initiated.

  • :metadata (Hash<String,String>) —

    A map of metadata to store with the object in S3.

  • :server_side_encryption (String) —

    The server-side encryption algorithm used when you store this object in Amazon S3 (for example, ‘AES256`, `aws:kms`).

    • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (‘AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We recommend that the bucket’s default encryption uses the desired encryption configuration and you don’t override the bucket default encryption in your ‘CreateSession` requests or `PUT` object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see [Protecting data with server-side encryption] in the *Amazon S3 User Guide*. For more information about the encryption overriding behaviors in directory buckets, see [Specifying server-side encryption with KMS for new object uploads].

      In the Zonal endpoint API calls (except [CopyObject] and [UploadPartCopy]) using the REST API, the encryption request headers must match the encryption settings that are specified in the ‘CreateSession` request. You can’t override the values of the encryption settings (‘x-amz-server-side-encryption`, `x-amz-server-side-encryption-aws-kms-key-id`, `x-amz-server-side-encryption-context`, and `x-amz-server-side-encryption-bucket-key-enabled`) that are specified in the `CreateSession` request. You don’t need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the ‘CreateSession` request to protect new objects in the directory bucket.

      <note markdown=“1”> When you use the CLI or the Amazon Web Services SDKs, for ‘CreateSession`, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket’s default encryption configuration for the ‘CreateSession` request. It’s not supported to override the encryption settings values in the ‘CreateSession` request. So in the Zonal endpoint API calls (except [CopyObject] and [UploadPartCopy]), the encryption request headers must match the default encryption configuration of the directory bucket.

      </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html

  • :storage_class (String) —

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see [Storage Classes] in the *Amazon S3 User Guide*.

    <note markdown=“1”> * For directory buckets, only the S3 Express One Zone storage class is

    supported to store newly created objects.

    • Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html

  • :website_redirect_location (String) —

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :sse_customer_algorithm (String) —

    Specifies the algorithm to use when encrypting the object (for example, AES256).

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :sse_customer_key (String) —

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :sse_customer_key_md5 (String) —

    Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :ssekms_key_id (String) —

    Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn’t exist in the same account that’s issuing the command, you must use the full Key ARN not the Key ID.

    **General purpose buckets** - If you specify ‘x-amz-server-side-encryption` with `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify `x-amz-server-side-encryption:aws:kms` or `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the Amazon Web Services managed key (`aws/s3`) to protect the data.

    **Directory buckets** - If you specify ‘x-amz-server-side-encryption` with `aws:kms`, the ` x-amz-server-side-encryption-aws-kms-key-id` header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that’s configured for your directory bucket’s default encryption setting. If you want to specify the ‘ x-amz-server-side-encryption-aws-kms-key-id` header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that’s configured for your directory bucket’s default encryption setting. Otherwise, you get an HTTP ‘400 Bad Request` error. Only use the key ID or key ARN. The key alias format of the KMS key isn’t supported. Your SSE-KMS configuration can only support 1 [customer managed key] per directory bucket for the lifetime of the bucket. The [Amazon Web Services managed key] (‘aws/s3`) isn’t supported.

    [1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

  • :ssekms_encryption_context (String) —

    Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

    **Directory buckets** - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

  • :bucket_key_enabled (Boolean) —

    Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

    **General purpose buckets** - Setting this header to ‘true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

    **Directory buckets** - S3 Bucket Keys are always enabled for ‘GET` and `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren’t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through [CopyObject], [UploadPartCopy], [the Copy operation in Batch Operations], or [the import jobs]. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job

  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :tagging (String) —

    The tag-set for the object. The tag-set must be encoded as URL Query parameters.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :object_lock_mode (String) —

    Specifies the Object Lock mode that you want to apply to the uploaded object.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —

    Specifies the date and time when you want the Object Lock to expire.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :object_lock_legal_hold_status (String) —

    Specifies whether you want to apply a legal hold to the uploaded object.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :checksum_algorithm (String) —

    Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

See Also:



3632
3633
3634
3635
 
# File 'lib/aws-sdk-s3/client.rb', line 3632

def create_multipart_upload(params = {}, options = {})
  req = build_request(:create_multipart_upload, params)
  req.send_request(options)
end

#create_session(params = {}) ⇒ Types::CreateSessionOutput

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see [S3 Express One Zone APIs] in the *Amazon S3 User Guide*.

To make Zonal endpoint API requests on a directory bucket, use the ‘CreateSession` API operation. Specifically, you grant `s3express:CreateSession` permission to a bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the `CreateSession` API request on the bucket, which returns temporary security credentials that include the access key ID, secret access key, session token, and expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After the session is created, you don’t need to use other policies to grant permissions to each Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by applying the temporary security credentials of the session to the request headers and following the SigV4 protocol for authentication. You also apply the session token to the `x-amz-s3session-token` request header for authorization. Temporary security credentials are scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that you make with those credentials will fail. You must use IAM credentials again to make a `CreateSession` API request that generates a new set of temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see [Performance guidelines and design patterns] in the *Amazon S3 User Guide*.

<note markdown=“1”> * You must make requests for this API operation to the Zonal endpoint.

These endpoints support virtual-hosted-style requests in the format
`https://bucket-name.s3express-zone-id.region-code.amazonaws.com`.
Path-style requests are not supported. For more information about
endpoints in Availability Zones, see [Regional and Zonal endpoints
for directory buckets in Availability Zones][3] in the *Amazon S3
User Guide*. For more information about endpoints in Local Zones,
see [Available Local Zone for directory buckets][4] in the *Amazon
S3 User Guide*.

  • CopyObject API operation - Unlike other Zonal endpoint API operations, the ‘CopyObject` API operation doesn’t use the temporary security credentials returned from the ‘CreateSession` API operation for authentication and authorization. For information about authentication and authorization of the `CopyObject` API operation on directory buckets, see [CopyObject].

  • HeadBucket API operation - Unlike other Zonal endpoint API operations, the ‘HeadBucket` API operation doesn’t use the temporary security credentials returned from the ‘CreateSession` API operation for authentication and authorization. For information about authentication and authorization of the `HeadBucket` API operation on directory buckets, see [HeadBucket].

</note>

Permissions

: To obtain temporary security credentials, you must create a bucket

policy or an IAM identity-based policy that grants
`s3express:CreateSession` permission to the bucket. In a policy, you
can have the `s3express:SessionMode` condition key to control who
can create a `ReadWrite` or `ReadOnly` session. For more information
about `ReadWrite` or `ReadOnly` sessions, see [
`x-amz-create-session-mode` ][7]. For example policies, see [Example
bucket policies for S3 Express One Zone][8] and [Amazon Web Services
Identity and Access Management (IAM) identity-based policies for S3
Express One Zone][9] in the *Amazon S3 User Guide*.

To grant cross-account access to Zonal endpoint API operations, the
bucket policy should also grant both accounts the
`s3express:CreateSession` permission.

If you want to encrypt objects with SSE-KMS, you must also have the
`kms:GenerateDataKey` and the `kms:Decrypt` permissions in IAM
identity-based policies and KMS key policies for the target KMS key.

Encryption

: For directory buckets, there are only two supported options for

server-side encryption: server-side encryption with Amazon S3
managed keys (SSE-S3) (`AES256`) and server-side encryption with KMS
keys (SSE-KMS) (`aws:kms`). We recommend that the bucket's default
encryption uses the desired encryption configuration and you don't
override the bucket default encryption in your `CreateSession`
requests or `PUT` object requests. Then, new objects are
automatically encrypted with the desired encryption settings. For
more information, see [Protecting data with server-side
encryption][10] in the *Amazon S3 User Guide*. For more information
about the encryption overriding behaviors in directory buckets, see
[Specifying server-side encryption with KMS for new object
uploads][11].

For [Zonal endpoint (object-level) API operations][12] except
[CopyObject][5] and [UploadPartCopy][13], you authenticate and
authorize requests through [CreateSession][14] for low latency. To
encrypt new objects in a directory bucket with SSE-KMS, you must
specify SSE-KMS as the directory bucket's default encryption
configuration with a KMS key (specifically, a [customer managed
key][15]). Then, when a session is created for Zonal endpoint API
operations, new objects are automatically encrypted and decrypted
with SSE-KMS and S3 Bucket Keys during the session.

<note markdown="1"> Only 1 [customer managed key][15] is supported per directory bucket
for the lifetime of the bucket. The [Amazon Web Services managed
key][16] (`aws/s3`) isn't supported. After you specify SSE-KMS as
your bucket's default encryption configuration with a customer
managed key, you can't change the customer managed key for the
bucket's SSE-KMS configuration.

 </note>

In the Zonal endpoint API calls (except [CopyObject][5] and
[UploadPartCopy][13]) using the REST API, you can't override the
values of the encryption settings (`x-amz-server-side-encryption`,
`x-amz-server-side-encryption-aws-kms-key-id`,
`x-amz-server-side-encryption-context`, and
`x-amz-server-side-encryption-bucket-key-enabled`) from the
`CreateSession` request. You don't need to explicitly specify these
encryption settings values in Zonal endpoint API calls, and Amazon
S3 will use the encryption settings values from the `CreateSession`
request to protect new objects in the directory bucket.

<note markdown="1"> When you use the CLI or the Amazon Web Services SDKs, for
`CreateSession`, the session token refreshes automatically to avoid
service interruptions when a session expires. The CLI or the Amazon
Web Services SDKs use the bucket's default encryption configuration
for the `CreateSession` request. It's not supported to override the
encryption settings values in the `CreateSession` request. Also, in
the Zonal endpoint API calls (except [CopyObject][5] and
[UploadPartCopy][13]), it's not supported to override the values of
the encryption settings from the `CreateSession` request.

 </note>

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters [8]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html [9]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html [10]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [11]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html [12]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-differences.html#s3-express-differences-api-operations [13]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [14]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [15]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [16]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

Examples:

Request syntax with placeholder values


resp = client.create_session({
  session_mode: "ReadOnly", # accepts ReadOnly, ReadWrite
  bucket: "BucketName", # required
  server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  bucket_key_enabled: false,
})

Response structure


resp.server_side_encryption #=> String, one of "AES256", "aws:kms", "aws:kms:dsse"
resp.ssekms_key_id #=> String
resp.ssekms_encryption_context #=> String
resp.bucket_key_enabled #=> Boolean
resp.credentials.access_key_id #=> String
resp.credentials.secret_access_key #=> String
resp.credentials.session_token #=> String
resp.credentials.expiration #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :session_mode (String) —

    Specifies the mode of the session that will be created, either ‘ReadWrite` or `ReadOnly`. By default, a `ReadWrite` session is created. A `ReadWrite` session is capable of executing all the Zonal endpoint API operations on a directory bucket. A `ReadOnly` session is constrained to execute the following Zonal endpoint API operations: `GetObject`, `HeadObject`, `ListObjectsV2`, `GetObjectAttributes`, `ListParts`, and `ListMultipartUploads`.

  • :bucket (required, String) —

    The name of the bucket that you create a session for.

  • :server_side_encryption (String) —

    The server-side encryption algorithm to use when you store objects in the directory bucket.

    For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (‘AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). By default, Amazon S3 encrypts data with SSE-S3. For more information, see [Protecting data with server-side encryption] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html

  • :ssekms_key_id (String) —

    If you specify ‘x-amz-server-side-encryption` with `aws:kms`, you must specify the ` x-amz-server-side-encryption-aws-kms-key-id` header with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP `400 Bad Request` error. Only use the key ID or key ARN. The key alias format of the KMS key isn’t supported. Also, if the KMS key doesn’t exist in the same account that’t issuing the command, you must use the full Key ARN not the Key ID.

    Your SSE-KMS configuration can only support 1 [customer managed key] per directory bucket for the lifetime of the bucket. The

    Amazon Web Services managed key][2

    (‘aws/s3`) isn’t supported.

    [1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

  • :ssekms_encryption_context (String) —

    Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future ‘GetObject` operations on this object.

    **General purpose buckets** - This value must be explicitly added during ‘CopyObject` operations if you want an additional encryption context for your object. For more information, see [Encryption context] in the *Amazon S3 User Guide*.

    **Directory buckets** - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context

  • :bucket_key_enabled (Boolean) —

    Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using KMS keys (SSE-KMS).

    S3 Bucket Keys are always enabled for ‘GET` and `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren’t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through [CopyObject], [UploadPartCopy], [the Copy operation in Batch Operations], or [the import jobs]. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job

Returns:

See Also:



3926
3927
3928
3929
 
# File 'lib/aws-sdk-s3/client.rb', line 3926

def create_session(params = {}, options = {})
  req = build_request(:create_session, params)
  req.send_request(options)
end

#delete_bucket(params = {}) ⇒ Struct

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

<note markdown=“1”> * **Directory buckets** - If multipart uploads in a directory bucket

are in progress, you can't delete the bucket until all the
in-progress multipart uploads are aborted or completed.

  • Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

Permissions : * **General purpose bucket permissions** - You must have the

  `s3:DeleteBucket` permission on the specified bucket in a policy.

* **Directory bucket permissions** - You must have the
  `s3express:DeleteBucket` permission in an IAM identity-based
  policy instead of a bucket policy. Cross-account access to this
  API operation isn't supported. This operation can only be
  performed by the Amazon Web Services account that owns the
  resource. For more information about directory bucket policies and
  permissions, see [Amazon Web Services Identity and Access
  Management (IAM) for S3 Express One Zone][3] in the *Amazon S3
  User Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region-code.amazonaws.com`.

The following operations are related to ‘DeleteBucket`:

  • CreateBucket][4
  • DeleteObject][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html

Examples:

Example: To delete a bucket


# The following example deletes the specified bucket.

resp = client.delete_bucket({
  bucket: "forrandall2", 
})

Request syntax with placeholder values


resp = client.delete_bucket({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    Specifies the bucket being deleted.

    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ‘ bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

    <note markdown=“1”> For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code ‘501 Not Implemented`.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4036
4037
4038
4039
 
# File 'lib/aws-sdk-s3/client.rb', line 4036

def delete_bucket(params = {}, options = {})
  req = build_request(:delete_bucket, params)
  req.send_request(options)
end

#delete_bucket_analytics_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the ‘s3:PutAnalyticsConfiguration` action. The 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].

For information about the Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis].

The following operations are related to ‘DeleteBucketAnalyticsConfiguration`:

  • GetBucketAnalyticsConfiguration][4
  • ListBucketAnalyticsConfigurations][5
  • PutBucketAnalyticsConfiguration][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_analytics_configuration({
  bucket: "BucketName", # required
  id: "AnalyticsId", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket from which an analytics configuration is deleted.

  • :id (required, String) —

    The ID that identifies the analytics configuration.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4102
4103
4104
4105
 
# File 'lib/aws-sdk-s3/client.rb', line 4102

def delete_bucket_analytics_configuration(params = {}, options = {})
  req = build_request(:delete_bucket_analytics_configuration, params)
  req.send_request(options)
end

#delete_bucket_cors(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Deletes the ‘cors` configuration information set for the bucket.

To use this operation, you must have permission to perform the ‘s3:PutBucketCORS` action. The bucket owner has this permission by default and can grant this permission to others.

For information about ‘cors`, see [Enabling Cross-Origin Resource Sharing] in the *Amazon S3 User Guide*.

**Related Resources**

  • PutBucketCors][2
  • RESTOPTIONSobject][3

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/cors.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html

Examples:

Example: To delete cors configuration on a bucket.


# The following example deletes CORS configuration on a bucket.

resp = client.delete_bucket_cors({
  bucket: "examplebucket", 
})

Request syntax with placeholder values


resp = client.delete_bucket_cors({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    Specifies the bucket whose ‘cors` configuration is being deleted.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4162
4163
4164
4165
 
# File 'lib/aws-sdk-s3/client.rb', line 4162

def delete_bucket_cors(params = {}, options = {})
  req = build_request(:delete_bucket_cors, params)
  req.send_request(options)
end

#delete_bucket_encryption(params = {}) ⇒ Struct

This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3).

<note markdown=“1”> * **General purpose buckets** - For information about the bucket

default encryption feature, see [Amazon S3 Bucket Default
Encryption][1] in the *Amazon S3 User Guide*.

  • **Directory buckets** - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption configuration in directory buckets, see [Setting default server-side encryption behavior for directory buckets].

</note>

Permissions : * **General purpose bucket permissions** - The

  `s3:PutEncryptionConfiguration` permission is required in a
  policy. The 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
  Operations][3] and [Managing Access Permissions to Your Amazon S3
  Resources][4].

* **Directory bucket permissions** - To grant access to this API
  operation, you must have the
  `s3express:PutEncryptionConfiguration` permission in an IAM
  identity-based policy instead of a bucket policy. Cross-account
  access to this API operation isn't supported. This operation can
  only be performed by the Amazon Web Services account that owns the
  resource. For more information about directory bucket policies and
  permissions, see [Amazon Web Services Identity and Access
  Management (IAM) for S3 Express One Zone][5] in the *Amazon S3
  User Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region-code.amazonaws.com`.

The following operations are related to ‘DeleteBucketEncryption`:

  • PutBucketEncryption][6
  • GetBucketEncryption][7

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_encryption({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket containing the server-side encryption configuration to delete.

    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ‘ bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

    <note markdown=“1”> For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code ‘501 Not Implemented`.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4267
4268
4269
4270
 
# File 'lib/aws-sdk-s3/client.rb', line 4267

def delete_bucket_encryption(params = {}, options = {})
  req = build_request(:delete_bucket_encryption, params)
  req.send_request(options)
end

#delete_bucket_intelligent_tiering_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see [Storage class for automatically optimizing frequently and infrequently accessed objects].

Operations related to ‘DeleteBucketIntelligentTieringConfiguration` include:

  • GetBucketIntelligentTieringConfiguration][2
  • PutBucketIntelligentTieringConfiguration][3
  • ListBucketIntelligentTieringConfigurations][4

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_intelligent_tiering_configuration({
  bucket: "BucketName", # required
  id: "IntelligentTieringId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

  • :id (required, String) —

    The ID used to identify the S3 Intelligent-Tiering configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4334
4335
4336
4337
 
# File 'lib/aws-sdk-s3/client.rb', line 4334

def delete_bucket_intelligent_tiering_configuration(params = {}, options = {})
  req = build_request(:delete_bucket_intelligent_tiering_configuration, params)
  req.send_request(options)
end

#delete_bucket_inventory_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the ‘s3:PutInventoryConfiguration` action. The 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].

For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory].

Operations related to ‘DeleteBucketInventoryConfiguration` include:

  • GetBucketInventoryConfiguration][4
  • PutBucketInventoryConfiguration][5
  • ListBucketInventoryConfigurations][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_inventory_configuration({
  bucket: "BucketName", # required
  id: "InventoryId", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket containing the inventory configuration to delete.

  • :id (required, String) —

    The ID used to identify the inventory configuration.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4399
4400
4401
4402
 
# File 'lib/aws-sdk-s3/client.rb', line 4399

def delete_bucket_inventory_configuration(params = {}, options = {})
  req = build_request(:delete_bucket_inventory_configuration, params)
  req.send_request(options)
end

#delete_bucket_lifecycle(params = {}) ⇒ Struct

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

Permissions : * **General purpose bucket permissions** - By default, all Amazon S3

  resources are private, including buckets, objects, and related
  subresources (for example, lifecycle configuration and website
  configuration). Only the resource owner (that is, the Amazon Web
  Services account that created it) can access the resource. The
  resource owner can optionally grant access permissions to others
  by writing an access policy. For this operation, a user must have
  the `s3:PutLifecycleConfiguration` permission.

  For more information about permissions, see [Managing Access
  Permissions to Your Amazon S3 Resources][1].
^

* **Directory bucket permissions** - You must have the
  `s3express:PutLifecycleConfiguration` permission in an IAM
  identity-based policy to use this operation. Cross-account access
  to this API operation isn't supported. The resource owner can
  optionally grant access permissions to others by creating a role
  or user for them as long as they are within the same account as
  the owner and resource.

  For more information about directory bucket policies and
  permissions, see [Authorizing Regional endpoint APIs with IAM][2]
  in the *Amazon S3 User Guide*.

  <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
  requests for this API operation to the Regional endpoint. These
  endpoints support path-style requests in the format
  `https://s3express-control.region-code.amazonaws.com/bucket-name
  `. Virtual-hosted-style requests aren't supported. For more
  information about endpoints in Availability Zones, see [Regional
  and Zonal endpoints for directory buckets in Availability
  Zones][3] in the *Amazon S3 User Guide*. For more information
  about endpoints in Local Zones, see [Available Local Zone for
  directory buckets][4] in the *Amazon S3 User Guide*.

   </note>

^

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region.amazonaws.com`.

For more information about the object expiration, see [Elements to Describe Lifecycle Actions].

Related actions include:

  • PutBucketLifecycleConfiguration][6
  • GetBucketLifecycleConfiguration][7

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html

Examples:

Example: To delete lifecycle configuration on a bucket.


# The following example deletes lifecycle configuration on a bucket.

resp = client.delete_bucket_lifecycle({
  bucket: "examplebucket", 
})

Request syntax with placeholder values


resp = client.delete_bucket_lifecycle({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name of the lifecycle to delete.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

    <note markdown=“1”> This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4509
4510
4511
4512
 
# File 'lib/aws-sdk-s3/client.rb', line 4509

def delete_bucket_lifecycle(params = {}, options = {})
  req = build_request(:delete_bucket_lifecycle, params)
  req.send_request(options)
end

#delete_bucket_metadata_table_configuration(params = {}) ⇒ Struct

Deletes a metadata table configuration from a general purpose bucket. For more information, see [Accelerating data discovery with S3 Metadata] in the *Amazon S3 User Guide*.

Permissions

: To use this operation, you must have the

`s3:DeleteBucketMetadataTableConfiguration` permission. For more
information, see [Setting up permissions for configuring metadata
tables][2] in the *Amazon S3 User Guide*.

The following operations are related to ‘DeleteBucketMetadataTableConfiguration`:

  • CreateBucketMetadataTableConfiguration][3
  • GetBucketMetadataTableConfiguration][4

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_metadata_table_configuration({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The general purpose bucket that you want to remove the metadata table configuration from.

  • :expected_bucket_owner (String) —

    The expected bucket owner of the general purpose bucket that you want to remove the metadata table configuration from.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4560
4561
4562
4563
 
# File 'lib/aws-sdk-s3/client.rb', line 4560

def delete_bucket_metadata_table_configuration(params = {}, options = {})
  req = build_request(:delete_bucket_metadata_table_configuration, params)
  req.send_request(options)
end

#delete_bucket_metrics_configuration(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn’t include the daily storage metrics.

To use this operation, you must have permissions to perform the ‘s3:PutMetricsConfiguration` action. The 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].

For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch].

The following operations are related to ‘DeleteBucketMetricsConfiguration`:

  • GetBucketMetricsConfiguration][4
  • PutBucketMetricsConfiguration][5
  • ListBucketMetricsConfigurations][6
  • Monitoring Metrics with Amazon CloudWatch][3

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_metrics_configuration({
  bucket: "BucketName", # required
  id: "MetricsId", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket containing the metrics configuration to delete.

  • :id (required, String) —

    The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4630
4631
4632
4633
 
# File 'lib/aws-sdk-s3/client.rb', line 4630

def delete_bucket_metrics_configuration(params = {}, options = {})
  req = build_request(:delete_bucket_metrics_configuration, params)
  req.send_request(options)
end

#delete_bucket_ownership_controls(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Removes ‘OwnershipControls` for an Amazon S3 bucket. To use this operation, you must have the `s3:PutBucketOwnershipControls` permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a Policy].

For information about Amazon S3 Object Ownership, see [Using Object Ownership].

The following operations are related to ‘DeleteBucketOwnershipControls`:

  • GetBucketOwnershipControls

  • PutBucketOwnershipControls

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html

Examples:

Request syntax with placeholder values


resp = client.delete_bucket_ownership_controls({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The Amazon S3 bucket whose ‘OwnershipControls` you want to delete.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4680
4681
4682
4683
 
# File 'lib/aws-sdk-s3/client.rb', line 4680

def delete_bucket_ownership_controls(params = {}, options = {})
  req = build_request(:delete_bucket_ownership_controls, params)
  req.send_request(options)
end

#delete_bucket_policy(params = {}) ⇒ Struct

Deletes the policy of a specified bucket.

<note markdown=“1”> Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

Permissions

: 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
both have the `DeleteBucketPolicy` permissions on the specified
bucket and belong to the bucket owner's account in order to use
this operation.

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.

To ensure that bucket owners don't inadvertently lock themselves
out of their own buckets, the root principal in a bucket owner's
Amazon Web Services account can perform the `GetBucketPolicy`,
`PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if
their bucket policy explicitly denies the root principal's access.
Bucket owner root principals can only be blocked from performing
these API actions by VPC endpoint policies and Amazon Web Services
Organizations policies.

* **General purpose bucket permissions** - The
  `s3:DeleteBucketPolicy` permission is required in a policy. For
  more information about general purpose buckets bucket policies,
  see [Using Bucket Policies and User Policies][3] in the *Amazon S3
  User Guide*.

* **Directory bucket permissions** - To grant access to this API
  operation, you must have the `s3express:DeleteBucketPolicy`
  permission in an IAM identity-based policy instead of a bucket
  policy. Cross-account access to this API operation isn't
  supported. This operation can only be performed by the Amazon Web
  Services account that owns the resource. For more information
  about directory bucket policies and permissions, see [Amazon Web
  Services Identity and Access Management (IAM) for S3 Express One
  Zone][4] in the *Amazon S3 User Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region-code.amazonaws.com`.

The following operations are related to ‘DeleteBucketPolicy`

  • CreateBucket][5
  • DeleteObject][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html

Examples:

Example: To delete bucket policy


# The following example deletes bucket policy on the specified bucket.

resp = client.delete_bucket_policy({
  bucket: "examplebucket", 
})

Request syntax with placeholder values


resp = client.delete_bucket_policy({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name.

    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ‘ bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

    <note markdown=“1”> For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code ‘501 Not Implemented`.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4810
4811
4812
4813
 
# File 'lib/aws-sdk-s3/client.rb', line 4810

def delete_bucket_policy(params = {}, options = {})
  req = build_request(:delete_bucket_policy, params)
  req.send_request(options)
end

#delete_bucket_replication(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the ‘s3:PutReplicationConfiguration` action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].

<note markdown=“1”> It can take a while for the deletion of a replication configuration to fully propagate.

</note>

For information about replication configuration, see [Replication] in the *Amazon S3 User Guide*.

The following operations are related to ‘DeleteBucketReplication`:

  • PutBucketReplication][4
  • GetBucketReplication][5

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/replication.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html

Examples:

Example: To delete bucket replication configuration


# The following example deletes replication configuration set on bucket.

resp = client.delete_bucket_replication({
  bucket: "example", 
})

Request syntax with placeholder values


resp = client.delete_bucket_replication({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4880
4881
4882
4883
 
# File 'lib/aws-sdk-s3/client.rb', line 4880

def delete_bucket_replication(params = {}, options = {})
  req = build_request(:delete_bucket_replication, params)
  req.send_request(options)
end

#delete_bucket_tagging(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Deletes the tags from the bucket.

To use this operation, you must have permission to perform the ‘s3:PutBucketTagging` action. By default, the bucket owner has this permission and can grant this permission to others.

The following operations are related to ‘DeleteBucketTagging`:

  • GetBucketTagging][1
  • PutBucketTagging][2

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html

Examples:

Example: To delete bucket tags


# The following example deletes bucket tags.

resp = client.delete_bucket_tagging({
  bucket: "examplebucket", 
})

Request syntax with placeholder values


resp = client.delete_bucket_tagging({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket that has the tag set to be removed.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4936
4937
4938
4939
 
# File 'lib/aws-sdk-s3/client.rb', line 4936

def delete_bucket_tagging(params = {}, options = {})
  req = build_request(:delete_bucket_tagging, params)
  req.send_request(options)
end

#delete_bucket_website(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

This action removes the website configuration for a bucket. Amazon S3 returns a ‘200 OK` response upon successfully deleting a website configuration on the specified bucket. You will get a `200 OK` response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a `404` response if the bucket specified in the request does not exist.

This DELETE action requires the ‘S3:DeleteBucketWebsite` permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the `S3:DeleteBucketWebsite` permission.

For more information about hosting websites, see [Hosting Websites on Amazon S3].

The following operations are related to ‘DeleteBucketWebsite`:

  • GetBucketWebsite][2
  • PutBucketWebsite][3

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html

Examples:

Example: To delete bucket website configuration


# The following example deletes bucket website configuration.

resp = client.delete_bucket_website({
  bucket: "examplebucket", 
})

Request syntax with placeholder values


resp = client.delete_bucket_website({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name for which you want to remove the website configuration.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5004
5005
5006
5007
 
# File 'lib/aws-sdk-s3/client.rb', line 5004

def delete_bucket_website(params = {}, options = {})
  req = build_request(:delete_bucket_website, params)
  req.send_request(options)
end

#delete_object(params = {}) ⇒ Types::DeleteObjectOutput

Removes an object from a bucket. The behavior depends on the bucket’s versioning state:

  • If bucket versioning is not enabled, the operation permanently deletes the object.

  • If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s ‘versionId` in the request. For more information about versioning-enabled buckets, see [Deleting object versions from a versioning-enabled bucket].

  • If bucket versioning is suspended, the operation removes the object that has a null ‘versionId`, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn’t an object with a null ‘versionId`, and all versions of the object have a `versionId`, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a `versionId`, you must include the object’s `versionId` in the request. For more information about versioning-suspended buckets, see [Deleting objects from versioning-suspended buckets].

<note markdown=“1”> * **Directory buckets** - S3 Versioning isn’t enabled and supported

for directory buckets. For this API operation, only the `null` value
of the version ID is supported by directory buckets. You can only
specify `null` to the `versionId` query parameter in the request.

  • **Directory buckets** - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format ‘bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

To remove a specific version, you must use the ‘versionId` query parameter. Using this query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header `x-amz-delete-marker` to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the ‘x-amz-mfa` request header in the DELETE `versionId` request. Requests that include `x-amz-mfa` must use HTTPS. For more information about MFA Delete, see [Using MFA Delete] in the *Amazon S3 User Guide*. To see sample requests that use versioning, see [Sample Request].

<note markdown=“1”> **Directory buckets** - MFA delete is not supported by directory buckets.

</note>

You can delete objects by explicitly calling DELETE Object or calling ([PutBucketLifecycle]) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the ‘s3:DeleteObject`, `s3:DeleteObjectVersion`, and `s3:PutLifeCycleConfiguration` actions.

<note markdown=“1”> **Directory buckets** - S3 Lifecycle is not supported by directory buckets.

</note>

Permissions : * **General purpose bucket permissions** - The following permissions

  are required in your policies when your `DeleteObjects` request
  includes specific headers.

  * <b> <code>s3:DeleteObject</code> </b> - To delete an object from
    a bucket, you must always have the `s3:DeleteObject` permission.

  * <b> <code>s3:DeleteObjectVersion</code> </b> - To delete a
    specific version of an object from a versioning-enabled bucket,
    you must have the `s3:DeleteObjectVersion` permission.
* **Directory bucket permissions** - To grant access to this API
  operation on a directory bucket, we recommend that you use the [
  `CreateSession` ][8] API operation for session-based
  authorization. Specifically, you grant the
  `s3express:CreateSession` permission to the directory bucket in a
  bucket policy or an IAM identity-based policy. Then, you make the
  `CreateSession` API call on the bucket to obtain a session token.
  With the session token in your request header, you can make API
  requests to this operation. After the session token expires, you
  make another `CreateSession` API call to generate a new session
  token for use. Amazon Web Services CLI or SDKs create session and
  refresh the session token automatically to avoid service
  interruptions when a session expires. For more information about
  authorization, see [ `CreateSession` ][8].

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following action is related to ‘DeleteObject`:

  • PutObject][9

^

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html

Examples:

Example: To delete an object


# The following example deletes an object from an S3 bucket.

resp = client.delete_object({
  bucket: "examplebucket", 
  key: "objectkey.jpg", 
})

resp.to_h outputs the following:
{
}

Example: To delete an object (from a non-versioned bucket)


# The following example deletes an object from a non-versioned bucket.

resp = client.delete_object({
  bucket: "ExampleBucket", 
  key: "HappyFace.jpg", 
})

Request syntax with placeholder values


resp = client.delete_object({
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  mfa: "MFA",
  version_id: "ObjectVersionId",
  request_payer: "requester", # accepts requester
  bypass_governance_retention: false,
  expected_bucket_owner: "AccountId",
  if_match: "IfMatch",
  if_match_last_modified_time: Time.now,
  if_match_size: 1,
})

Response structure


resp.delete_marker #=> Boolean
resp.version_id #=> String
resp.request_charged #=> String, one of "requester"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name of the bucket containing the object.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][3

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :key (required, String) —

    Key name of the object to delete.

  • :mfa (String) —

    The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :version_id (String) —

    Version ID used to reference a specific version of the object.

    <note markdown=“1”> For directory buckets in this API operation, only the ‘null` value of the version ID is supported.

    </note>
  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :bypass_governance_retention (Boolean) —

    Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the ‘s3:BypassGovernanceRetention` permission.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :if_match (String) —

    The ‘If-Match` header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a `412 Precondition Failed` error. If the ETag matches or if the object doesn’t exist, the operation will return a ‘204 Success (No Content) response`.

    For more information about conditional requests, see [RFC 7232].

    <note markdown=“1”> This functionality is only supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/https:/tools.ietf.org/html/rfc7232

  • :if_match_last_modified_time (Time, DateTime, Date, Integer, String) —

    If present, the object is deleted only if its modification times matches the provided ‘Timestamp`. If the `Timestamp` values do not match, the operation returns a `412 Precondition Failed` error. If the `Timestamp` matches or if the object doesn’t exist, the operation returns a `204 Success (No Content)` response.

    <note markdown=“1”> This functionality is only supported for directory buckets.

    </note>
  • :if_match_size (Integer) —

    If present, the object is deleted only if its size matches the provided size in bytes. If the ‘Size` value does not match, the operation returns a `412 Precondition Failed` error. If the `Size` matches or if the object doesn’t exist, the operation returns a `204 Success (No Content)` response.

    <note markdown=“1”> This functionality is only supported for directory buckets.

    </note>

    You can use the ‘If-Match`, `x-amz-if-match-last-modified-time` and `x-amz-if-match-size` conditional headers in conjunction with each-other or individually.

Returns:

See Also:



5320
5321
5322
5323
 
# File 'lib/aws-sdk-s3/client.rb', line 5320

def delete_object(params = {}, options = {})
  req = build_request(:delete_object, params)
  req.send_request(options)
end

#delete_object_tagging(params = {}) ⇒ Types::DeleteObjectTaggingOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Removes the entire tag set from the specified object. For more information about managing object tags, see [ Object Tagging].

To use this operation, you must have permission to perform the ‘s3:DeleteObjectTagging` action.

To delete tags of a specific object version, add the ‘versionId` query parameter in the request. You will need permission for the `s3:DeleteObjectVersionTagging` action.

The following operations are related to ‘DeleteObjectTagging`:

  • PutObjectTagging][2
  • GetObjectTagging][3

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html

Examples:

Example: To remove tag set from an object


# The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
# operation removes tag set from the latest object version.

resp = client.delete_object_tagging({
  bucket: "examplebucket", 
  key: "HappyFace.jpg", 
})

resp.to_h outputs the following:
{
  version_id: "null", 
}

Example: To remove tag set from an object version


# The following example removes tag set associated with the specified object version. The request specifies both the
# object key and object version.

resp = client.delete_object_tagging({
  bucket: "examplebucket", 
  key: "HappyFace.jpg", 
  version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", 
})

resp.to_h outputs the following:
{
  version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", 
}

Request syntax with placeholder values


resp = client.delete_object_tagging({
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  expected_bucket_owner: "AccountId",
})

Response structure


resp.version_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name containing the objects from which to remove the tags.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][2

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :key (required, String) —

    The key that identifies the object in the bucket from which to remove all tags.

  • :version_id (String) —

    The versionId of the object that the tag-set will be removed from.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



5444
5445
5446
5447
 
# File 'lib/aws-sdk-s3/client.rb', line 5444

def delete_object_tagging(params = {}, options = {})
  req = build_request(:delete_object_tagging, params)
  req.send_request(options)
end

#delete_objects(params = {}) ⇒ Types::DeleteObjectsOutput

This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request can contain a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

<note markdown=“1”> * **Directory buckets** - S3 Versioning isn’t enabled and supported

for directory buckets.

  • **Directory buckets** - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format ‘bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion in a quiet mode, the operation does not return any information about the delete in the response body.

When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see [MFA Delete] in the *Amazon S3 User Guide*.

<note markdown=“1”> **Directory buckets** - MFA delete is not supported by directory buckets.

</note>

Permissions : * **General purpose bucket permissions** - The following permissions

  are required in your policies when your `DeleteObjects` request
  includes specific headers.

  * <b> <code>s3:DeleteObject</code> </b> - To delete an object from
    a bucket, you must always specify the `s3:DeleteObject`
    permission.

  * <b> <code>s3:DeleteObjectVersion</code> </b> - To delete a
    specific version of an object from a versioning-enabled bucket,
    you must specify the `s3:DeleteObjectVersion` permission.
* **Directory bucket permissions** - To grant access to this API
  operation on a directory bucket, we recommend that you use the [
  `CreateSession` ][4] API operation for session-based
  authorization. Specifically, you grant the
  `s3express:CreateSession` permission to the directory bucket in a
  bucket policy or an IAM identity-based policy. Then, you make the
  `CreateSession` API call on the bucket to obtain a session token.
  With the session token in your request header, you can make API
  requests to this operation. After the session token expires, you
  make another `CreateSession` API call to generate a new session
  token for use. Amazon Web Services CLI or SDKs create session and
  refresh the session token automatically to avoid service
  interruptions when a session expires. For more information about
  authorization, see [ `CreateSession` ][4].

Content-MD5 request header : * **General purpose bucket** - The Content-MD5 request header is

  required for all Multi-Object Delete requests. Amazon S3 uses the
  header value to ensure that your request body has not been altered
  in transit.

* **Directory bucket** - The Content-MD5 request header or a
  additional checksum request header (including
  `x-amz-checksum-crc32`, `x-amz-checksum-crc32c`,
  `x-amz-checksum-sha1`, or `x-amz-checksum-sha256`) is required for
  all Multi-Object Delete requests.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following operations are related to ‘DeleteObjects`:

  • CreateMultipartUpload][5
  • UploadPart][6
  • CompleteMultipartUpload][7
  • ListParts][8
  • AbortMultipartUpload][9

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html

Examples:

Example: To delete multiple objects from a versioned bucket


# The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
# object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.

resp = client.delete_objects({
  bucket: "examplebucket", 
  delete: {
    objects: [
      {
        key: "objectkey1", 
      }, 
      {
        key: "objectkey2", 
      }, 
    ], 
    quiet: false, 
  }, 
})

resp.to_h outputs the following:
{
  deleted: [
    {
      delete_marker: true, 
      delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", 
      key: "objectkey1", 
    }, 
    {
      delete_marker: true, 
      delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", 
      key: "objectkey2", 
    }, 
  ], 
}

Example: To delete multiple object versions from a versioned bucket


# The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
# versions and returns the key and versions of deleted objects in the response.

resp = client.delete_objects({
  bucket: "examplebucket", 
  delete: {
    objects: [
      {
        key: "HappyFace.jpg", 
        version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b", 
      }, 
      {
        key: "HappyFace.jpg", 
        version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd", 
      }, 
    ], 
    quiet: false, 
  }, 
})

resp.to_h outputs the following:
{
  deleted: [
    {
      key: "HappyFace.jpg", 
      version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd", 
    }, 
    {
      key: "HappyFace.jpg", 
      version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.delete_objects({
  bucket: "BucketName", # required
  delete: { # required
    objects: [ # required
      {
        key: "ObjectKey", # required
        version_id: "ObjectVersionId",
        etag: "ETag",
        last_modified_time: Time.now,
        size: 1,
      },
    ],
    quiet: false,
  },
  mfa: "MFA",
  request_payer: "requester", # accepts requester
  bypass_governance_retention: false,
  expected_bucket_owner: "AccountId",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
})

Response structure


resp.deleted #=> Array
resp.deleted[0].key #=> String
resp.deleted[0].version_id #=> String
resp.deleted[0].delete_marker #=> Boolean
resp.deleted[0].delete_marker_version_id #=> String
resp.request_charged #=> String, one of "requester"
resp.errors #=> Array
resp.errors[0].key #=> String
resp.errors[0].version_id #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name containing the objects to delete.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][3

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :delete (required, Types::Delete) —

    Container for the request.

  • :mfa (String) —

    The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

    When performing the ‘DeleteObjects` operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don’t provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see [ MFA Delete] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete

  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :bypass_governance_retention (Boolean) —

    Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the ‘s3:BypassGovernanceRetention` permission.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :checksum_algorithm (String) —

    Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don’t use the SDK. When you send this header, there must be a corresponding ‘x-amz-checksum-algorithm ` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`.

    For the ‘x-amz-checksum-algorithm ` header, replace ` algorithm ` with the supported algorithm from the following list:

    • ‘CRC32`

    • ‘CRC32C`

    • ‘SHA1`

    • ‘SHA256`

    For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

    If the individual checksum value you provide through ‘x-amz-checksum-algorithm ` doesn’t match the checksum algorithm you set through ‘x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter and uses the checksum algorithm that matches the provided value in `x-amz-checksum-algorithm `.

    If you provide an individual checksum, Amazon S3 ignores any provided ‘ChecksumAlgorithm` parameter.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

See Also:



5824
5825
5826
5827
 
# File 'lib/aws-sdk-s3/client.rb', line 5824

def delete_objects(params = {}, options = {})
  req = build_request(:delete_objects, params)
  req.send_request(options)
end

#delete_public_access_block(params = {}) ⇒ Struct

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Removes the ‘PublicAccessBlock` configuration for an Amazon S3 bucket. To use this operation, you must have the `s3:PutBucketPublicAccessBlock` permission. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].

The following operations are related to ‘DeletePublicAccessBlock`:

  • Using Amazon S3 Block Public Access][3
  • GetPublicAccessBlock][4
  • PutPublicAccessBlock][5
  • GetBucketPolicyStatus][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html

Examples:

Request syntax with placeholder values


resp = client.delete_public_access_block({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The Amazon S3 bucket whose ‘PublicAccessBlock` configuration you want to delete.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5881
5882
5883
5884
 
# File 'lib/aws-sdk-s3/client.rb', line 5881

def delete_public_access_block(params = {}, options = {})
  req = build_request(:delete_public_access_block, params)
  req.send_request(options)
end

#get_bucket_accelerate_configuration(params = {}) ⇒ Types::GetBucketAccelerateConfigurationOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

This implementation of the GET action uses the ‘accelerate` subresource to return the Transfer Acceleration state of a bucket, which is either `Enabled` or `Suspended`. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the ‘s3:GetAccelerateConfiguration` action. The 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] in the *Amazon S3 User Guide*.

You set the Transfer Acceleration state of an existing bucket to ‘Enabled` or `Suspended` by using the

PutBucketAccelerateConfiguration][3

operation.

A GET ‘accelerate` request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see [Transfer Acceleration] in the Amazon S3 User Guide.

The following operations are related to ‘GetBucketAccelerateConfiguration`:

  • PutBucketAccelerateConfiguration][3

^

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_accelerate_configuration({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
  request_payer: "requester", # accepts requester
})

Response structure


resp.status #=> String, one of "Enabled", "Suspended"
resp.request_charged #=> String, one of "requester"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which the accelerate configuration is retrieved.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

See Also:



5977
5978
5979
5980
 
# File 'lib/aws-sdk-s3/client.rb', line 5977

def get_bucket_accelerate_configuration(params = {}, options = {})
  req = build_request(:get_bucket_accelerate_configuration, params)
  req.send_request(options)
end

#get_bucket_acl(params = {}) ⇒ Types::GetBucketAclOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

This implementation of the ‘GET` action uses the `acl` subresource to return the access control list (ACL) of a bucket. To use `GET` to return the ACL of the bucket, you must have the `READ_ACP` access to the bucket. If `READ_ACP` permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

<note markdown=“1”> If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the ‘bucket-owner-full-control` ACL with the owner being the account that created the bucket. For more information, see [ Controlling object ownership and disabling ACLs] in the *Amazon S3 User Guide*.

</note>

The following operations are related to ‘GetBucketAcl`:

  • ListObjects][3

^

[1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_acl({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.owner.display_name #=> String
resp.owner.id #=> String
resp.grants #=> Array
resp.grants[0].grantee.display_name #=> String
resp.grants[0].grantee.email_address #=> String
resp.grants[0].grantee.id #=> String
resp.grants[0].grantee.type #=> String, one of "CanonicalUser", "AmazonCustomerByEmail", "Group"
resp.grants[0].grantee.uri #=> String
resp.grants[0].permission #=> String, one of "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    Specifies the S3 bucket whose ACL is being requested.

    When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

    When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



6073
6074
6075
6076
 
# File 'lib/aws-sdk-s3/client.rb', line 6073

def get_bucket_acl(params = {}, options = {})
  req = build_request(:get_bucket_acl, params)
  req.send_request(options)
end

#get_bucket_analytics_configuration(params = {}) ⇒ Types::GetBucketAnalyticsConfigurationOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the ‘s3:GetAnalyticsConfiguration` action. The 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] in the *Amazon S3 User Guide*.

For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis] in the *Amazon S3 User Guide*.

The following operations are related to ‘GetBucketAnalyticsConfiguration`:

  • DeleteBucketAnalyticsConfiguration][4
  • ListBucketAnalyticsConfigurations][5
  • PutBucketAnalyticsConfiguration][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_analytics_configuration({
  bucket: "BucketName", # required
  id: "AnalyticsId", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.analytics_configuration.id #=> String
resp.analytics_configuration.filter.prefix #=> String
resp.analytics_configuration.filter.tag.key #=> String
resp.analytics_configuration.filter.tag.value #=> String
resp.analytics_configuration.filter.and.prefix #=> String
resp.analytics_configuration.filter.and.tags #=> Array
resp.analytics_configuration.filter.and.tags[0].key #=> String
resp.analytics_configuration.filter.and.tags[0].value #=> String
resp.analytics_configuration.storage_class_analysis.data_export.output_schema_version #=> String, one of "V_1"
resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination.format #=> String, one of "CSV"
resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination. #=> String
resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination.bucket #=> String
resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination.prefix #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket from which an analytics configuration is retrieved.

  • :id (required, String) —

    The ID that identifies the analytics configuration.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



6159
6160
6161
6162
 
# File 'lib/aws-sdk-s3/client.rb', line 6159

def get_bucket_analytics_configuration(params = {}, options = {})
  req = build_request(:get_bucket_analytics_configuration, params)
  req.send_request(options)
end

#get_bucket_cors(params = {}) ⇒ Types::GetBucketCorsOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.

To use this operation, you must have permission to perform the ‘s3:GetBucketCORS` action. By default, the bucket owner has this permission and can grant it to others.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

For more information about CORS, see [ Enabling Cross-Origin Resource Sharing].

The following operations are related to ‘GetBucketCors`:

  • PutBucketCors][3
  • DeleteBucketCors][4

[1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList [2]: docs.aws.amazon.com/AmazonS3/latest/dev/cors.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html

Examples:

Example: To get cors configuration set on a bucket


# The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.

resp = client.get_bucket_cors({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  cors_rules: [
    {
      allowed_headers: [
        "Authorization", 
      ], 
      allowed_methods: [
        "GET", 
      ], 
      allowed_origins: [
        "*", 
      ], 
      max_age_seconds: 3000, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_bucket_cors({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.cors_rules #=> Array
resp.cors_rules[0].id #=> String
resp.cors_rules[0].allowed_headers #=> Array
resp.cors_rules[0].allowed_headers[0] #=> String
resp.cors_rules[0].allowed_methods #=> Array
resp.cors_rules[0].allowed_methods[0] #=> String
resp.cors_rules[0].allowed_origins #=> Array
resp.cors_rules[0].allowed_origins[0] #=> String
resp.cors_rules[0].expose_headers #=> Array
resp.cors_rules[0].expose_headers[0] #=> String
resp.cors_rules[0].max_age_seconds #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name for which to get the cors configuration.

    When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

    When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



6279
6280
6281
6282
 
# File 'lib/aws-sdk-s3/client.rb', line 6279

def get_bucket_cors(params = {}, options = {})
  req = build_request(:get_bucket_cors, params)
  req.send_request(options)
end

#get_bucket_encryption(params = {}) ⇒ Types::GetBucketEncryptionOutput

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).

<note markdown=“1”> * **General purpose buckets** - For information about the bucket

default encryption feature, see [Amazon S3 Bucket Default
Encryption][1] in the *Amazon S3 User Guide*.

  • **Directory buckets** - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption configuration in directory buckets, see [Setting default server-side encryption behavior for directory buckets].

</note>

Permissions : * **General purpose bucket permissions** - The

  `s3:GetEncryptionConfiguration` permission is required in a
  policy. The 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
  Operations][3] and [Managing Access Permissions to Your Amazon S3
  Resources][4].

* **Directory bucket permissions** - To grant access to this API
  operation, you must have the
  `s3express:GetEncryptionConfiguration` permission in an IAM
  identity-based policy instead of a bucket policy. Cross-account
  access to this API operation isn't supported. This operation can
  only be performed by the Amazon Web Services account that owns the
  resource. For more information about directory bucket policies and
  permissions, see [Amazon Web Services Identity and Access
  Management (IAM) for S3 Express One Zone][5] in the *Amazon S3
  User Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region-code.amazonaws.com`.

The following operations are related to ‘GetBucketEncryption`:

  • PutBucketEncryption][6
  • DeleteBucketEncryption][7

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_encryption({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.server_side_encryption_configuration.rules #=> Array
resp.server_side_encryption_configuration.rules[0].apply_server_side_encryption_by_default.sse_algorithm #=> String, one of "AES256", "aws:kms", "aws:kms:dsse"
resp.server_side_encryption_configuration.rules[0].apply_server_side_encryption_by_default.kms_master_key_id #=> String
resp.server_side_encryption_configuration.rules[0].bucket_key_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket from which the server-side encryption configuration is retrieved.

    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ‘ bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

    <note markdown=“1”> For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code ‘501 Not Implemented`.

    </note>

Returns:

See Also:



6393
6394
6395
6396
 
# File 'lib/aws-sdk-s3/client.rb', line 6393

def get_bucket_encryption(params = {}, options = {})
  req = build_request(:get_bucket_encryption, params)
  req.send_request(options)
end

#get_bucket_intelligent_tiering_configuration(params = {}) ⇒ Types::GetBucketIntelligentTieringConfigurationOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see [Storage class for automatically optimizing frequently and infrequently accessed objects].

Operations related to ‘GetBucketIntelligentTieringConfiguration` include:

  • DeleteBucketIntelligentTieringConfiguration][2
  • PutBucketIntelligentTieringConfiguration][3
  • ListBucketIntelligentTieringConfigurations][4

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_intelligent_tiering_configuration({
  bucket: "BucketName", # required
  id: "IntelligentTieringId", # required
})

Response structure


resp.intelligent_tiering_configuration.id #=> String
resp.intelligent_tiering_configuration.filter.prefix #=> String
resp.intelligent_tiering_configuration.filter.tag.key #=> String
resp.intelligent_tiering_configuration.filter.tag.value #=> String
resp.intelligent_tiering_configuration.filter.and.prefix #=> String
resp.intelligent_tiering_configuration.filter.and.tags #=> Array
resp.intelligent_tiering_configuration.filter.and.tags[0].key #=> String
resp.intelligent_tiering_configuration.filter.and.tags[0].value #=> String
resp.intelligent_tiering_configuration.status #=> String, one of "Enabled", "Disabled"
resp.intelligent_tiering_configuration.tierings #=> Array
resp.intelligent_tiering_configuration.tierings[0].days #=> Integer
resp.intelligent_tiering_configuration.tierings[0].access_tier #=> String, one of "ARCHIVE_ACCESS", "DEEP_ARCHIVE_ACCESS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

  • :id (required, String) —

    The ID used to identify the S3 Intelligent-Tiering configuration.

Returns:

See Also:



6477
6478
6479
6480
 
# File 'lib/aws-sdk-s3/client.rb', line 6477

def get_bucket_intelligent_tiering_configuration(params = {}, options = {})
  req = build_request(:get_bucket_intelligent_tiering_configuration, params)
  req.send_request(options)
end

#get_bucket_inventory_configuration(params = {}) ⇒ Types::GetBucketInventoryConfigurationOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the ‘s3:GetInventoryConfiguration` action. The 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].

For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory].

The following operations are related to ‘GetBucketInventoryConfiguration`:

  • DeleteBucketInventoryConfiguration][4
  • ListBucketInventoryConfigurations][5
  • PutBucketInventoryConfiguration][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_inventory_configuration({
  bucket: "BucketName", # required
  id: "InventoryId", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.inventory_configuration.destination.s3_bucket_destination. #=> String
resp.inventory_configuration.destination.s3_bucket_destination.bucket #=> String
resp.inventory_configuration.destination.s3_bucket_destination.format #=> String, one of "CSV", "ORC", "Parquet"
resp.inventory_configuration.destination.s3_bucket_destination.prefix #=> String
resp.inventory_configuration.destination.s3_bucket_destination.encryption.ssekms.key_id #=> String
resp.inventory_configuration.is_enabled #=> Boolean
resp.inventory_configuration.filter.prefix #=> String
resp.inventory_configuration.id #=> String
resp.inventory_configuration.included_object_versions #=> String, one of "All", "Current"
resp.inventory_configuration.optional_fields #=> Array
resp.inventory_configuration.optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus", "ChecksumAlgorithm", "ObjectAccessControlList", "ObjectOwner"
resp.inventory_configuration.schedule.frequency #=> String, one of "Daily", "Weekly"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket containing the inventory configuration to retrieve.

  • :id (required, String) —

    The ID used to identify the inventory configuration.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



6560
6561
6562
6563
 
# File 'lib/aws-sdk-s3/client.rb', line 6560

def get_bucket_inventory_configuration(params = {}, options = {})
  req = build_request(:get_bucket_inventory_configuration, params)
  req.send_request(options)
end

#get_bucket_lifecycle(params = {}) ⇒ Types::GetBucketLifecycleOutput

For an updated version of this API, see [GetBucketLifecycleConfiguration]. If you configured a bucket lifecycle using the ‘filter` element, you should see the updated version of this topic. This topic is provided for backward compatibility.

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see [Object Lifecycle Management].

To use this operation, you must have permission to perform the ‘s3:GetLifecycleConfiguration` action. The 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].

‘GetBucketLifecycle` 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 operations are related to ‘GetBucketLifecycle`:

  • GetBucketLifecycleConfiguration][1
  • PutBucketLifecycle][5
  • DeleteBucketLifecycle][6

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html

Examples:

Example: To get a bucket acl


# The following example gets ACL on the specified bucket.

resp = client.get_bucket_lifecycle({
  bucket: "acl1", 
})

resp.to_h outputs the following:
{
  rules: [
    {
      expiration: {
        days: 1, 
      }, 
      id: "delete logs", 
      prefix: "123/", 
      status: "Enabled", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_bucket_lifecycle({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.rules #=> Array
resp.rules[0].expiration.date #=> Time
resp.rules[0].expiration.days #=> Integer
resp.rules[0].expiration.expired_object_delete_marker #=> Boolean
resp.rules[0].id #=> String
resp.rules[0].prefix #=> String
resp.rules[0].status #=> String, one of "Enabled", "Disabled"
resp.rules[0].transition.date #=> Time
resp.rules[0].transition.days #=> Integer
resp.rules[0].transition.storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "GLACIER_IR"
resp.rules[0].noncurrent_version_transition.noncurrent_days #=> Integer
resp.rules[0].noncurrent_version_transition.storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "GLACIER_IR"
resp.rules[0].noncurrent_version_transition.newer_noncurrent_versions #=> Integer
resp.rules[0].noncurrent_version_expiration.noncurrent_days #=> Integer
resp.rules[0].noncurrent_version_expiration.newer_noncurrent_versions #=> Integer
resp.rules[0].abort_incomplete_multipart_upload.days_after_initiation #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the lifecycle information.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



6678
6679
6680
6681
 
# File 'lib/aws-sdk-s3/client.rb', line 6678

def get_bucket_lifecycle(params = {}, options = {})
  req = build_request(:get_bucket_lifecycle, params)
  req.send_request(options)
end

#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationOutput

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see [Object Lifecycle Management].

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API, which is compatible with the new functionality. The previous version of the API supported filtering based only on an object key name prefix, which is supported for general purpose buckets for backward compatibility. For the related API description, see [GetBucketLifecycle].

<note markdown=“1”> Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters are not supported.

</note>

Permissions : * **General purpose bucket permissions** - By default, all Amazon S3

  resources are private, including buckets, objects, and related
  subresources (for example, lifecycle configuration and website
  configuration). Only the resource owner (that is, the Amazon Web
  Services account that created it) can access the resource. The
  resource owner can optionally grant access permissions to others
  by writing an access policy. For this operation, a user must have
  the `s3:GetLifecycleConfiguration` permission.

  For more information about permissions, see [Managing Access
  Permissions to Your Amazon S3 Resources][3].
^

* **Directory bucket permissions** - You must have the
  `s3express:GetLifecycleConfiguration` permission in an IAM
  identity-based policy to use this operation. Cross-account access
  to this API operation isn't supported. The resource owner can
  optionally grant access permissions to others by creating a role
  or user for them as long as they are within the same account as
  the owner and resource.

  For more information about directory bucket policies and
  permissions, see [Authorizing Regional endpoint APIs with IAM][4]
  in the *Amazon S3 User Guide*.

  <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
  requests for this API operation to the Regional endpoint. These
  endpoints support path-style requests in the format
  `https://s3express-control.region-code.amazonaws.com/bucket-name
  `. Virtual-hosted-style requests aren't supported. For more
  information about endpoints in Availability Zones, see [Regional
  and Zonal endpoints for directory buckets in Availability
  Zones][5] in the *Amazon S3 User Guide*. For more information
  about endpoints in Local Zones, see [Available Local Zone for
  directory buckets][6] in the *Amazon S3 User Guide*.

   </note>

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region.amazonaws.com`.

‘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 operations are related to ‘GetBucketLifecycleConfiguration`:

  • GetBucketLifecycle][2
  • PutBucketLifecycle][7
  • DeleteBucketLifecycle][8

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html

Examples:

Example: To get lifecycle configuration on a bucket


# The following example retrieves lifecycle configuration on set on a bucket. 

resp = client.get_bucket_lifecycle_configuration({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  rules: [
    {
      id: "Rule for TaxDocs/", 
      prefix: "TaxDocs", 
      status: "Enabled", 
      transitions: [
        {
          days: 365, 
          storage_class: "STANDARD_IA", 
        }, 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_bucket_lifecycle_configuration({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.rules #=> Array
resp.rules[0].expiration.date #=> Time
resp.rules[0].expiration.days #=> Integer
resp.rules[0].expiration.expired_object_delete_marker #=> Boolean
resp.rules[0].id #=> String
resp.rules[0].prefix #=> String
resp.rules[0].filter.prefix #=> String
resp.rules[0].filter.tag.key #=> String
resp.rules[0].filter.tag.value #=> String
resp.rules[0].filter.object_size_greater_than #=> Integer
resp.rules[0].filter.object_size_less_than #=> Integer
resp.rules[0].filter.and.prefix #=> String
resp.rules[0].filter.and.tags #=> Array
resp.rules[0].filter.and.tags[0].key #=> String
resp.rules[0].filter.and.tags[0].value #=> String
resp.rules[0].filter.and.object_size_greater_than #=> Integer
resp.rules[0].filter.and.object_size_less_than #=> Integer
resp.rules[0].status #=> String, one of "Enabled", "Disabled"
resp.rules[0].transitions #=> Array
resp.rules[0].transitions[0].date #=> Time
resp.rules[0].transitions[0].days #=> Integer
resp.rules[0].transitions[0].storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "GLACIER_IR"
resp.rules[0].noncurrent_version_transitions #=> Array
resp.rules[0].noncurrent_version_transitions[0].noncurrent_days #=> Integer
resp.rules[0].noncurrent_version_transitions[0].storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "GLACIER_IR"
resp.rules[0].noncurrent_version_transitions[0].newer_noncurrent_versions #=> Integer
resp.rules[0].noncurrent_version_expiration.noncurrent_days #=> Integer
resp.rules[0].noncurrent_version_expiration.newer_noncurrent_versions #=> Integer
resp.rules[0].abort_incomplete_multipart_upload.days_after_initiation #=> Integer
resp.transition_default_minimum_object_size #=> String, one of "varies_by_storage_class", "all_storage_classes_128K"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the lifecycle information.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

    <note markdown=“1”> This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

    </note>

Returns:

See Also:



6864
6865
6866
6867
 
# File 'lib/aws-sdk-s3/client.rb', line 6864

def get_bucket_lifecycle_configuration(params = {}, options = {})
  req = build_request(:get_bucket_lifecycle_configuration, params)
  req.send_request(options)
end

#get_bucket_location(params = {}) ⇒ Types::GetBucketLocationOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the Region the bucket resides in. You set the bucket’s Region using the ‘LocationConstraint` request parameter in a `CreateBucket` request. For more information, see [CreateBucket].

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

<note markdown=“1”> We recommend that you use [HeadBucket] to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

</note>

The following operations are related to ‘GetBucketLocation`:

  • GetObject][4
  • CreateBucket][1

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html

Examples:

Example: To get bucket location


# The following example returns bucket location.

resp = client.get_bucket_location({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  location_constraint: "us-west-2", 
}

Request syntax with placeholder values


resp = client.get_bucket_location({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.location_constraint #=> String, one of "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "cn-north-1", "cn-northwest-1", "EU", "eu-central-1", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the location.

    When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

    When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



6961
6962
6963
6964
 
# File 'lib/aws-sdk-s3/client.rb', line 6961

def get_bucket_location(params = {}, options = {})
  req = build_request(:get_bucket_location, params)
  req.send_request(options)
end

#get_bucket_logging(params = {}) ⇒ Types::GetBucketLoggingOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to ‘GetBucketLogging`:

  • CreateBucket][1
  • PutBucketLogging][2

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_logging({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.logging_enabled.target_bucket #=> String
resp.logging_enabled.target_grants #=> Array
resp.logging_enabled.target_grants[0].grantee.display_name #=> String
resp.logging_enabled.target_grants[0].grantee.email_address #=> String
resp.logging_enabled.target_grants[0].grantee.id #=> String
resp.logging_enabled.target_grants[0].grantee.type #=> String, one of "CanonicalUser", "AmazonCustomerByEmail", "Group"
resp.logging_enabled.target_grants[0].grantee.uri #=> String
resp.logging_enabled.target_grants[0].permission #=> String, one of "FULL_CONTROL", "READ", "WRITE"
resp.logging_enabled.target_prefix #=> String
resp.logging_enabled.target_object_key_format.partitioned_prefix.partition_date_source #=> String, one of "EventTime", "DeliveryTime"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name for which to get the logging information.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7020
7021
7022
7023
 
# File 'lib/aws-sdk-s3/client.rb', line 7020

def get_bucket_logging(params = {}, options = {})
  req = build_request(:get_bucket_logging, params)
  req.send_request(options)
end

#get_bucket_metadata_table_configuration(params = {}) ⇒ Types::GetBucketMetadataTableConfigurationOutput

Retrieves the metadata table configuration for a general purpose bucket. For more information, see [Accelerating data discovery with S3 Metadata] in the *Amazon S3 User Guide*.

Permissions

: To use this operation, you must have the

`s3:GetBucketMetadataTableConfiguration` permission. For more
information, see [Setting up permissions for configuring metadata
tables][2] in the *Amazon S3 User Guide*.

The following operations are related to ‘GetBucketMetadataTableConfiguration`:

  • CreateBucketMetadataTableConfiguration][3
  • DeleteBucketMetadataTableConfiguration][4

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_metadata_table_configuration({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.get_bucket_metadata_table_configuration_result.metadata_table_configuration_result.s3_tables_destination_result.table_bucket_arn #=> String
resp.get_bucket_metadata_table_configuration_result.metadata_table_configuration_result.s3_tables_destination_result.table_name #=> String
resp.get_bucket_metadata_table_configuration_result.metadata_table_configuration_result.s3_tables_destination_result.table_arn #=> String
resp.get_bucket_metadata_table_configuration_result.metadata_table_configuration_result.s3_tables_destination_result.table_namespace #=> String
resp.get_bucket_metadata_table_configuration_result.status #=> String
resp.get_bucket_metadata_table_configuration_result.error.error_code #=> String
resp.get_bucket_metadata_table_configuration_result.error.error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The general purpose bucket that contains the metadata table configuration that you want to retrieve.

  • :expected_bucket_owner (String) —

    The expected owner of the general purpose bucket that you want to retrieve the metadata table configuration from.

Returns:

See Also:



7083
7084
7085
7086
 
# File 'lib/aws-sdk-s3/client.rb', line 7083

def get_bucket_metadata_table_configuration(params = {}, options = {})
  req = build_request(:get_bucket_metadata_table_configuration, params)
  req.send_request(options)
end

#get_bucket_metrics_configuration(params = {}) ⇒ Types::GetBucketMetricsConfigurationOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn’t include the daily storage metrics.

To use this operation, you must have permissions to perform the ‘s3:GetMetricsConfiguration` action. The 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].

For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch].

The following operations are related to ‘GetBucketMetricsConfiguration`:

  • PutBucketMetricsConfiguration][4
  • DeleteBucketMetricsConfiguration][5
  • ListBucketMetricsConfigurations][6
  • Monitoring Metrics with Amazon CloudWatch][3

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_metrics_configuration({
  bucket: "BucketName", # required
  id: "MetricsId", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.metrics_configuration.id #=> String
resp.metrics_configuration.filter.prefix #=> String
resp.metrics_configuration.filter.tag.key #=> String
resp.metrics_configuration.filter.tag.value #=> String
resp.metrics_configuration.filter.access_point_arn #=> String
resp.metrics_configuration.filter.and.prefix #=> String
resp.metrics_configuration.filter.and.tags #=> Array
resp.metrics_configuration.filter.and.tags[0].key #=> String
resp.metrics_configuration.filter.and.tags[0].value #=> String
resp.metrics_configuration.filter.and.access_point_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket containing the metrics configuration to retrieve.

  • :id (required, String) —

    The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7169
7170
7171
7172
 
# File 'lib/aws-sdk-s3/client.rb', line 7169

def get_bucket_metrics_configuration(params = {}, options = {})
  req = build_request(:get_bucket_metrics_configuration, params)
  req.send_request(options)
end

#get_bucket_notification(params = {}) ⇒ Types::NotificationConfigurationDeprecated

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

No longer used, see [GetBucketNotificationConfiguration].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html

Examples:

Example: To get notification configuration set on a bucket


# The following example returns notification configuration set on a bucket.

resp = client.get_bucket_notification({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  queue_configuration: {
    event: "s3:ObjectCreated:Put", 
    events: [
      "s3:ObjectCreated:Put", 
    ], 
    id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", 
    queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue", 
  }, 
  topic_configuration: {
    event: "s3:ObjectCreated:Copy", 
    events: [
      "s3:ObjectCreated:Copy", 
    ], 
    id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", 
    topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic", 
  }, 
}

Example: To get notification configuration set on a bucket


# The following example returns notification configuration set on a bucket.

resp = client.get_bucket_notification({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  queue_configuration: {
    event: "s3:ObjectCreated:Put", 
    events: [
      "s3:ObjectCreated:Put", 
    ], 
    id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx", 
    queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue", 
  }, 
  topic_configuration: {
    event: "s3:ObjectCreated:Copy", 
    events: [
      "s3:ObjectCreated:Copy", 
    ], 
    id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi", 
    topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic", 
  }, 
}

Request syntax with placeholder values


resp = client.get_bucket_notification({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.topic_configuration.id #=> String
resp.topic_configuration.events #=> Array
resp.topic_configuration.events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.topic_configuration.event #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.topic_configuration.topic #=> String
resp.queue_configuration.id #=> String
resp.queue_configuration.event #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.queue_configuration.events #=> Array
resp.queue_configuration.events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.queue_configuration.queue #=> String
resp.cloud_function_configuration.id #=> String
resp.cloud_function_configuration.event #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.cloud_function_configuration.events #=> Array
resp.cloud_function_configuration.events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.cloud_function_configuration.cloud_function #=> String
resp.cloud_function_configuration.invocation_role #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the notification configuration.

    When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

    When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7300
7301
7302
7303
 
# File 'lib/aws-sdk-s3/client.rb', line 7300

def get_bucket_notification(params = {}, options = {})
  req = build_request(:get_bucket_notification, params)
  req.send_request(options)
end

#get_bucket_notification_configuration(params = {}) ⇒ Types::NotificationConfiguration

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty ‘NotificationConfiguration` element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the ‘s3:GetBucketNotification` permission.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

For more information about setting and reading the notification configuration on a bucket, see [Setting Up Notification of Bucket Events]. For more information about bucket policies, see [Using Bucket Policies].

The following action is related to ‘GetBucketNotification`:

  • PutBucketNotification][4

^

[1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList [2]: docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_notification_configuration({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.topic_configurations #=> Array
resp.topic_configurations[0].id #=> String
resp.topic_configurations[0].topic_arn #=> String
resp.topic_configurations[0].events #=> Array
resp.topic_configurations[0].events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.topic_configurations[0].filter.key.filter_rules #=> Array
resp.topic_configurations[0].filter.key.filter_rules[0].name #=> String, one of "prefix", "suffix"
resp.topic_configurations[0].filter.key.filter_rules[0].value #=> String
resp.queue_configurations #=> Array
resp.queue_configurations[0].id #=> String
resp.queue_configurations[0].queue_arn #=> String
resp.queue_configurations[0].events #=> Array
resp.queue_configurations[0].events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.queue_configurations[0].filter.key.filter_rules #=> Array
resp.queue_configurations[0].filter.key.filter_rules[0].name #=> String, one of "prefix", "suffix"
resp.queue_configurations[0].filter.key.filter_rules[0].value #=> String
resp.lambda_function_configurations #=> Array
resp.lambda_function_configurations[0].id #=> String
resp.lambda_function_configurations[0].lambda_function_arn #=> String
resp.lambda_function_configurations[0].events #=> Array
resp.lambda_function_configurations[0].events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold", "s3:ObjectRestore:Delete", "s3:LifecycleTransition", "s3:IntelligentTiering", "s3:ObjectAcl:Put", "s3:LifecycleExpiration:*", "s3:LifecycleExpiration:Delete", "s3:LifecycleExpiration:DeleteMarkerCreated", "s3:ObjectTagging:*", "s3:ObjectTagging:Put", "s3:ObjectTagging:Delete"
resp.lambda_function_configurations[0].filter.key.filter_rules #=> Array
resp.lambda_function_configurations[0].filter.key.filter_rules[0].name #=> String, one of "prefix", "suffix"
resp.lambda_function_configurations[0].filter.key.filter_rules[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the notification configuration.

    When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

    When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7415
7416
7417
7418
 
# File 'lib/aws-sdk-s3/client.rb', line 7415

def get_bucket_notification_configuration(params = {}, options = {})
  req = build_request(:get_bucket_notification_configuration, params)
  req.send_request(options)
end

#get_bucket_ownership_controls(params = {}) ⇒ Types::GetBucketOwnershipControlsOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Retrieves ‘OwnershipControls` for an Amazon S3 bucket. To use this operation, you must have the `s3:GetBucketOwnershipControls` permission. For more information about Amazon S3 permissions, see [Specifying permissions in a policy].

For information about Amazon S3 Object Ownership, see [Using Object Ownership].

The following operations are related to ‘GetBucketOwnershipControls`:

  • PutBucketOwnershipControls

  • DeleteBucketOwnershipControls

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_ownership_controls({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.ownership_controls.rules #=> Array
resp.ownership_controls.rules[0].object_ownership #=> String, one of "BucketOwnerPreferred", "ObjectWriter", "BucketOwnerEnforced"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the Amazon S3 bucket whose ‘OwnershipControls` you want to retrieve.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7472
7473
7474
7475
 
# File 'lib/aws-sdk-s3/client.rb', line 7472

def get_bucket_ownership_controls(params = {}, options = {})
  req = build_request(:get_bucket_ownership_controls, params)
  req.send_request(options)
end

#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyOutput

Returns the policy of a specified bucket.

<note markdown=“1”> Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see [Available Local Zone for directory buckets] in the *Amazon S3 User Guide*.

</note>

Permissions

: 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
both have the `GetBucketPolicy` permissions on the specified bucket
and belong to the bucket owner's account in order to use this
operation.

If you don't have `GetBucketPolicy` 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.

To ensure that bucket owners don't inadvertently lock themselves
out of their own buckets, the root principal in a bucket owner's
Amazon Web Services account can perform the `GetBucketPolicy`,
`PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if
their bucket policy explicitly denies the root principal's access.
Bucket owner root principals can only be blocked from performing
these API actions by VPC endpoint policies and Amazon Web Services
Organizations policies.

* **General purpose bucket permissions** - The `s3:GetBucketPolicy`
  permission is required in a policy. For more information about
  general purpose buckets bucket policies, see [Using Bucket
  Policies and User Policies][3] in the *Amazon S3 User Guide*.

* **Directory bucket permissions** - To grant access to this API
  operation, you must have the `s3express:GetBucketPolicy`
  permission in an IAM identity-based policy instead of a bucket
  policy. Cross-account access to this API operation isn't
  supported. This operation can only be performed by the Amazon Web
  Services account that owns the resource. For more information
  about directory bucket policies and permissions, see [Amazon Web
  Services Identity and Access Management (IAM) for S3 Express One
  Zone][4] in the *Amazon S3 User Guide*.

Example bucket policies

: **General purpose buckets example bucket policies** - See [Bucket

policy examples][5] in the *Amazon S3 User Guide*.

**Directory bucket example bucket policies** - See [Example bucket
policies for S3 Express One Zone][6] in the *Amazon S3 User Guide*.

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is

`s3express-control.region-code.amazonaws.com`.

The following action is related to ‘GetBucketPolicy`:

  • GetObject][7

^

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html

Examples:

Example: To get bucket policy


# The following example returns bucket policy associated with a bucket.

resp = client.get_bucket_policy({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  policy: "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}", 
}

Request syntax with placeholder values


resp = client.get_bucket_policy({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name to get the bucket policy for.

    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ‘ bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

    **Access points** - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

    **Object Lambda access points** - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

    <note markdown=“1”> For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code ‘501 Not Implemented`.

    </note>

Returns:

See Also:



7638
7639
7640
7641
 
# File 'lib/aws-sdk-s3/client.rb', line 7638

def get_bucket_policy(params = {}, options = {}, &block)
  req = build_request(:get_bucket_policy, params)
  req.send_request(options, &block)
end

#get_bucket_policy_status(params = {}) ⇒ Types::GetBucketPolicyStatusOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the ‘s3:GetBucketPolicyStatus` permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a Policy].

For more information about when Amazon S3 considers a bucket public, see [The Meaning of “Public”].

The following operations are related to ‘GetBucketPolicyStatus`:

  • Using Amazon S3 Block Public Access][3
  • GetPublicAccessBlock][4
  • PutPublicAccessBlock][5
  • DeletePublicAccessBlock][6

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status [3]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html

Examples:

Request syntax with placeholder values


resp = client.get_bucket_policy_status({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.policy_status.is_public #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the Amazon S3 bucket whose policy status you want to retrieve.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7703
7704
7705
7706
 
# File 'lib/aws-sdk-s3/client.rb', line 7703

def get_bucket_policy_status(params = {}, options = {})
  req = build_request(:get_bucket_policy_status, params)
  req.send_request(options)
end

#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the replication configuration of a bucket.

<note markdown=“1”> It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

</note>

For information about replication configuration, see [Replication] in the *Amazon S3 User Guide*.

This action requires permissions for the ‘s3:GetReplicationConfiguration` action. For more information about permissions, see [Using Bucket Policies and User Policies].

If you include the ‘Filter` element in a replication configuration, you must also include the `DeleteMarkerReplication` and `Priority` elements. The response also returns those elements.

For information about ‘GetBucketReplication` errors, see [List of replication-related error codes]

The following operations are related to ‘GetBucketReplication`:

  • PutBucketReplication][4
  • DeleteBucketReplication][5

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/replication.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html

Examples:

Example: To get replication configuration set on a bucket


# The following example returns replication configuration set on a bucket.

resp = client.get_bucket_replication({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  replication_configuration: {
    role: "arn:aws:iam::acct-id:role/example-role", 
    rules: [
      {
        destination: {
          bucket: "arn:aws:s3:::destination-bucket", 
        }, 
        id: "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy", 
        prefix: "Tax", 
        status: "Enabled", 
      }, 
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.get_bucket_replication({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.replication_configuration.role #=> String
resp.replication_configuration.rules #=> Array
resp.replication_configuration.rules[0].id #=> String
resp.replication_configuration.rules[0].priority #=> Integer
resp.replication_configuration.rules[0].prefix #=> String
resp.replication_configuration.rules[0].filter.prefix #=> String
resp.replication_configuration.rules[0].filter.tag.key #=> String
resp.replication_configuration.rules[0].filter.tag.value #=> String
resp.replication_configuration.rules[0].filter.and.prefix #=> String
resp.replication_configuration.rules[0].filter.and.tags #=> Array
resp.replication_configuration.rules[0].filter.and.tags[0].key #=> String
resp.replication_configuration.rules[0].filter.and.tags[0].value #=> String
resp.replication_configuration.rules[0].status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].source_selection_criteria.sse_kms_encrypted_objects.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].source_selection_criteria.replica_modifications.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].existing_object_replication.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].destination.bucket #=> String
resp.replication_configuration.rules[0].destination. #=> String
resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE"
resp.replication_configuration.rules[0].destination.access_control_translation.owner #=> String, one of "Destination"
resp.replication_configuration.rules[0].destination.encryption_configuration.replica_kms_key_id #=> String
resp.replication_configuration.rules[0].destination.replication_time.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].destination.replication_time.time.minutes #=> Integer
resp.replication_configuration.rules[0].destination.metrics.status #=> String, one of "Enabled", "Disabled"
resp.replication_configuration.rules[0].destination.metrics.event_threshold.minutes #=> Integer
resp.replication_configuration.rules[0].delete_marker_replication.status #=> String, one of "Enabled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name for which to get the replication information.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7826
7827
7828
7829
 
# File 'lib/aws-sdk-s3/client.rb', line 7826

def get_bucket_replication(params = {}, options = {})
  req = build_request(:get_bucket_replication, params)
  req.send_request(options)
end

#get_bucket_request_payment(params = {}) ⇒ Types::GetBucketRequestPaymentOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see [Requester Pays Buckets].

The following operations are related to ‘GetBucketRequestPayment`:

  • ListObjects][2

^

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html

Examples:

Example: To get bucket versioning configuration


# The following example retrieves bucket versioning configuration.

resp = client.get_bucket_request_payment({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  payer: "BucketOwner", 
}

Request syntax with placeholder values


resp = client.get_bucket_request_payment({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.payer #=> String, one of "Requester", "BucketOwner"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the payment request configuration

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7892
7893
7894
7895
 
# File 'lib/aws-sdk-s3/client.rb', line 7892

def get_bucket_request_payment(params = {}, options = {})
  req = build_request(:get_bucket_request_payment, params)
  req.send_request(options)
end

#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the ‘s3: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: ‘NoSuchTagSet`

    • Description: There is no tag set associated with the bucket.

    ^

The following operations are related to ‘GetBucketTagging`:

  • PutBucketTagging][1
  • DeleteBucketTagging][2

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html

Examples:

Example: To get tag set associated with a bucket


# The following example returns tag set associated with a bucket

resp = client.get_bucket_tagging({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  tag_set: [
    {
      key: "key1", 
      value: "value1", 
    }, 
    {
      key: "key2", 
      value: "value2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_bucket_tagging({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.tag_set #=> Array
resp.tag_set[0].key #=> String
resp.tag_set[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the tagging information.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



7978
7979
7980
7981
 
# File 'lib/aws-sdk-s3/client.rb', line 7978

def get_bucket_tagging(params = {}, options = {})
  req = build_request(:get_bucket_tagging, params)
  req.send_request(options)
end

#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is ‘enabled`, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to ‘GetBucketVersioning`:

  • GetObject][1
  • PutObject][2
  • DeleteObject][3

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html

Examples:

Example: To get bucket versioning configuration


# The following example retrieves bucket versioning configuration.

resp = client.get_bucket_versioning({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  mfa_delete: "Disabled", 
  status: "Enabled", 
}

Request syntax with placeholder values


resp = client.get_bucket_versioning({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.status #=> String, one of "Enabled", "Suspended"
resp.mfa_delete #=> String, one of "Enabled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket for which to get the versioning information.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



8055
8056
8057
8058
 
# File 'lib/aws-sdk-s3/client.rb', line 8055

def get_bucket_versioning(params = {}, options = {})
  req = build_request(:get_bucket_versioning, params)
  req.send_request(options)
end

#get_bucket_website(params = {}) ⇒ Types::GetBucketWebsiteOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see [Hosting Websites on Amazon S3].

This GET action requires the ‘S3:GetBucketWebsite` permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the `S3:GetBucketWebsite` permission.

The following operations are related to ‘GetBucketWebsite`:

  • DeleteBucketWebsite][2
  • PutBucketWebsite][3

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html

Examples:

Example: To get bucket website configuration


# The following example retrieves website configuration of a bucket.

resp = client.get_bucket_website({
  bucket: "examplebucket", 
})

resp.to_h outputs the following:
{
  error_document: {
    key: "error.html", 
  }, 
  index_document: {
    suffix: "index.html", 
  }, 
}

Request syntax with placeholder values


resp = client.get_bucket_website({
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
})

Response structure


resp.redirect_all_requests_to.host_name #=> String
resp.redirect_all_requests_to.protocol #=> String, one of "http", "https"
resp.index_document.suffix #=> String
resp.error_document.key #=> String
resp.routing_rules #=> Array
resp.routing_rules[0].condition.http_error_code_returned_equals #=> String
resp.routing_rules[0].condition.key_prefix_equals #=> String
resp.routing_rules[0].redirect.host_name #=> String
resp.routing_rules[0].redirect.http_redirect_code #=> String
resp.routing_rules[0].redirect.protocol #=> String, one of "http", "https"
resp.routing_rules[0].redirect.replace_key_prefix_with #=> String
resp.routing_rules[0].redirect.replace_key_with #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name for which to get the website configuration.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



8147
8148
8149
8150
 
# File 'lib/aws-sdk-s3/client.rb', line 8147

def get_bucket_website(params = {}, options = {})
  req = build_request(:get_bucket_website, params)
  req.send_request(options)
end

#get_object(params = {}) ⇒ Types::GetObjectOutput

Retrieves an object from Amazon S3.

In the ‘GetObject` request, specify the full key name for the object.

**General purpose buckets** - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object ‘photos/2006/February/sample.jpg`, specify the object key name as `/photos/2006/February/sample.jpg`. For a path-style request example, if you have the object `photos/2006/February/sample.jpg` in the bucket named `examplebucket`, specify the object key name as `/examplebucket/photos/2006/February/sample.jpg`. For more information about request types, see [HTTP Host Header Bucket Specification] in the *Amazon S3 User Guide*.

**Directory buckets** - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object ‘photos/2006/February/sample.jpg` in the bucket named `examplebucket–use1-az5–x-s3`, specify the object key name as `/photos/2006/February/sample.jpg`. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format `bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see

Available Local Zone for directory buckets][3

in the *Amazon S3 User

Guide*.

Permissions : * **General purpose bucket permissions** - You must have the

  required permissions in a policy. To use `GetObject`, you must
  have the `READ` access to the object (or version). If you grant
  `READ` access to the anonymous user, the `GetObject` operation
  returns the object without using an authorization header. For more
  information, see [Specifying permissions in a policy][4] in the
  *Amazon S3 User Guide*.

  If you include a `versionId` in your request header, you must have
  the `s3:GetObjectVersion` permission to access a specific version
  of an object. The `s3:GetObject` permission is not required in
  this scenario.

  If you request the current version of an object without a specific
  `versionId` in the request header, only the `s3:GetObject`
  permission is required. The `s3:GetObjectVersion` permission is
  not required in this scenario.

  If the object that you request doesn’t exist, the error that
  Amazon S3 returns depends on whether you also have the
  `s3:ListBucket` permission.

  * If you have the `s3:ListBucket` permission on the bucket, Amazon
    S3 returns an HTTP status code `404 Not Found` error.

  * If you don’t have the `s3:ListBucket` permission, Amazon S3
    returns an HTTP status code `403 Access Denied` error.
* **Directory bucket permissions** - To grant access to this API
  operation on a directory bucket, we recommend that you use the [
  `CreateSession` ][5] API operation for session-based
  authorization. Specifically, you grant the
  `s3express:CreateSession` permission to the directory bucket in a
  bucket policy or an IAM identity-based policy. Then, you make the
  `CreateSession` API call on the bucket to obtain a session token.
  With the session token in your request header, you can make API
  requests to this operation. After the session token expires, you
  make another `CreateSession` API call to generate a new session
  token for use. Amazon Web Services CLI or SDKs create session and
  refresh the session token automatically to avoid service
  interruptions when a session expires. For more information about
  authorization, see [ `CreateSession` ][5].

  If the object is encrypted using SSE-KMS, you must also have the
  `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
  identity-based policies and KMS key policies for the KMS key.

Storage classes

: If the object you are retrieving is stored in the S3 Glacier

Flexible Retrieval storage class, the S3 Glacier Deep Archive
storage class, the S3 Intelligent-Tiering Archive Access tier, or
the S3 Intelligent-Tiering Deep Archive Access tier, before you can
retrieve the object you must first restore a copy using
[RestoreObject][6]. Otherwise, this operation returns an
`InvalidObjectState` error. For information about restoring archived
objects, see [Restoring Archived Objects][7] in the *Amazon S3 User
Guide*.

<b>Directory buckets </b> - For directory buckets, only the S3
Express One Zone storage class is supported to store newly created
objects. Unsupported storage class values won't write a destination
object and will respond with the HTTP status code `400 Bad Request`.

Encryption

: Encryption request headers, like ‘x-amz-server-side-encryption`,

should not be sent for the `GetObject` requests, if your object uses
server-side encryption with Amazon S3 managed encryption keys
(SSE-S3), server-side encryption with Key Management Service (KMS)
keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web
Services KMS keys (DSSE-KMS). If you include the header in your
`GetObject` requests for the object that uses these types of keys,
you’ll get an HTTP `400 Bad Request` error.

**Directory buckets** - For directory buckets, there are only two
supported options for server-side encryption: SSE-S3 and SSE-KMS.
SSE-C isn't supported. For more information, see [Protecting data
with server-side encryption][8] in the *Amazon S3 User Guide*.

Overriding response header values through the request

: There are times when you want to override certain response header

values of a `GetObject` response. For example, you might override
the `Content-Disposition` response header value through your
`GetObject` request.

You can override values for a set of response headers. These
modified response header values are included only in a successful
response, that is, when the HTTP status code `200 OK` is returned.
The headers you can override using the following query parameters in
the request are a subset of the headers that Amazon S3 accepts when
you create an object.

The response headers that you can override for the `GetObject`
response are `Cache-Control`, `Content-Disposition`,
`Content-Encoding`, `Content-Language`, `Content-Type`, and
`Expires`.

To override values for a set of response headers in the `GetObject`
response, you can use the following query parameters in the request.

* `response-cache-control`

* `response-content-disposition`

* `response-content-encoding`

* `response-content-language`

* `response-content-type`

* `response-expires`

<note markdown="1"> When you use these parameters, you must sign the request by using
either an Authorization header or a presigned URL. These parameters
cannot be used with an unsigned (anonymous) request.

 </note>

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following operations are related to ‘GetObject`:

  • ListBuckets][9
  • GetObjectAcl][10

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html [8]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html

Examples:

Example: To retrieve a byte range of an object


# The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
# specific byte range.

resp = client.get_object({
  bucket: "examplebucket", 
  key: "SampleFile.txt", 
  range: "bytes=0-9", 
})

resp.to_h outputs the following:
{
  accept_ranges: "bytes", 
  content_length: 10, 
  content_range: "bytes 0-9/43", 
  content_type: "text/plain", 
  etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"", 
  last_modified: Time.parse("2014-10-09T22:57:28.000Z"), 
  metadata: {
  }, 
  version_id: "null", 
}

Example: To retrieve an object


# The following example retrieves an object for an S3 bucket.

resp = client.get_object({
  bucket: "examplebucket", 
  key: "HappyFace.jpg", 
})

resp.to_h outputs the following:
{
  accept_ranges: "bytes", 
  content_length: 3191, 
  content_type: "image/jpeg", 
  etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
  last_modified: Time.parse("2016-12-15T01:19:41.000Z"), 
  metadata: {
  }, 
  tag_count: 2, 
  version_id: "null", 
}

Download an object to disk

# stream object directly to disk
resp = s3.get_object(
  response_target: '/path/to/file',
  bucket: 'bucket-name',
  key: 'object-key')

# you can still access other response data
resp.metadata #=> { ... }
resp.etag #=> "..."

Download object into memory

# omit :response_target to download to a StringIO in memory
resp = s3.get_object(bucket: 'bucket-name', key: 'object-key')

# call #read or #string on the response body
resp.body.read
#=> '...'

Streaming data to a block

# WARNING: yielding data to a block disables retries of networking errors
# However truncation of the body will be retried automatically using a range request
File.open('/path/to/file', 'wb') do |file|
  s3.get_object(bucket: 'bucket-name', key: 'object-key') do |chunk, headers|
    # headers['content-length']
    file.write(chunk)
  end
end

Request syntax with placeholder values


resp = client.get_object({
  bucket: "BucketName", # required
  if_match: "IfMatch",
  if_modified_since: Time.now,
  if_none_match: "IfNoneMatch",
  if_unmodified_since: Time.now,
  key: "ObjectKey", # required
  range: "Range",
  response_cache_control: "ResponseCacheControl",
  response_content_disposition: "ResponseContentDisposition",
  response_content_encoding: "ResponseContentEncoding",
  response_content_language: "ResponseContentLanguage",
  response_content_type: "ResponseContentType",
  response_expires: Time.now,
  version_id: "ObjectVersionId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  part_number: 1,
  expected_bucket_owner: "AccountId",
  checksum_mode: "ENABLED", # accepts ENABLED
})

Response structure


resp.body #=> IO
resp.delete_marker #=> Boolean
resp.accept_ranges #=> String
resp.expiration #=> String
resp.restore #=> String
resp.last_modified #=> Time
resp.content_length #=> Integer
resp.etag #=> String
resp.checksum_crc32 #=> String
resp.checksum_crc32c #=> String
resp.checksum_sha1 #=> String
resp.checksum_sha256 #=> String
resp.missing_meta #=> Integer
resp.version_id #=> String
resp.cache_control #=> String
resp.content_disposition #=> String
resp.content_encoding #=> String
resp.content_language #=> String
resp.content_range #=> String
resp.content_type #=> String
resp.expires #=> Time
resp.expires_string #=> String
resp.website_redirect_location #=> String
resp.server_side_encryption #=> String, one of "AES256", "aws:kms", "aws:kms:dsse"
resp.metadata #=> Hash
resp.metadata["MetadataKey"] #=> String
resp.sse_customer_algorithm #=> String
resp.sse_customer_key_md5 #=> String
resp.ssekms_key_id #=> String
resp.bucket_key_enabled #=> Boolean
resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE"
resp.request_charged #=> String, one of "requester"
resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA", "COMPLETED"
resp.parts_count #=> Integer
resp.tag_count #=> Integer
resp.object_lock_mode #=> String, one of "GOVERNANCE", "COMPLIANCE"
resp.object_lock_retain_until_date #=> Time
resp.object_lock_legal_hold_status #=> String, one of "ON", "OFF"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :response_target (String, IO) —

    Where to write response data, file path, or IO object.

  • :bucket (required, String) —

    The bucket name containing the object.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    **Object Lambda access points** - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

    <note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

    </note>

    **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

    What is S3 on Outposts?][3

    in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

  • :if_match (String) —

    Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a ‘412 Precondition Failed` error.

    If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows: `If-Match` condition evaluates to `true`, and; `If-Unmodified-Since` condition evaluates to `false`; then, S3 returns `200 OK` and the data requested.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :if_modified_since (Time, DateTime, Date, Integer, String) —

    Return the object only if it has been modified since the specified time; otherwise, return a ‘304 Not Modified` error.

    If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:` If-None-Match` condition evaluates to `false`, and; `If-Modified-Since` condition evaluates to `true`; then, S3 returns `304 Not Modified` status code.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :if_none_match (String) —

    Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a ‘304 Not Modified` error.

    If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:` If-None-Match` condition evaluates to `false`, and; `If-Modified-Since` condition evaluates to `true`; then, S3 returns `304 Not Modified` HTTP status code.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :if_unmodified_since (Time, DateTime, Date, Integer, String) —

    Return the object only if it has not been modified since the specified time; otherwise, return a ‘412 Precondition Failed` error.

    If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows: `If-Match` condition evaluates to `true`, and; `If-Unmodified-Since` condition evaluates to `false`; then, S3 returns `200 OK` and the data requested.

    For more information about conditional requests, see [RFC 7232].

    [1]: tools.ietf.org/html/rfc7232

  • :key (required, String) —

    Key of the object to get.

  • :range (String) —

    Downloads the specified byte range of an object. For more information about the HTTP Range header, see [www.rfc-editor.org/rfc/rfc9110.html#name-range][1].

    <note markdown=“1”> Amazon S3 doesn’t support retrieving multiple ranges of data per ‘GET` request.

    </note>

    [1]: www.rfc-editor.org/rfc/rfc9110.html#name-range

  • :response_cache_control (String) —

    Sets the ‘Cache-Control` header of the response.

  • :response_content_disposition (String) —

    Sets the ‘Content-Disposition` header of the response.

  • :response_content_encoding (String) —

    Sets the ‘Content-Encoding` header of the response.

  • :response_content_language (String) —

    Sets the ‘Content-Language` header of the response.

  • :response_content_type (String) —

    Sets the ‘Content-Type` header of the response.

  • :response_expires (Time, DateTime, Date, Integer, String) —

    Sets the ‘Expires` header of the response.

  • :version_id (String) —

    Version ID used to reference a specific version of the object.

    By default, the ‘GetObject` operation returns the current version of an object. To return a different version, use the `versionId` subresource.

    <note markdown=“1”> * If you include a ‘versionId` in your request header, you must have

    the `s3:GetObjectVersion` permission to access a specific version of
an object. The `s3:GetObject` permission is not required in this
scenario.

    • If you request the current version of an object without a specific ‘versionId` in the request header, only the `s3:GetObject` permission is required. The `s3:GetObjectVersion` permission is not required in this scenario.

    • **Directory buckets** - S3 Versioning isn’t enabled and supported for directory buckets. For this API operation, only the ‘null` value of the version ID is supported by directory buckets. You can only specify `null` to the `versionId` query parameter in the request.

    </note>

    For more information about versioning, see [PutBucketVersioning].

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html

  • :sse_customer_algorithm (String) —

    Specifies the algorithm to use when decrypting the object (for example, ‘AES256`).

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    • ‘x-amz-server-side-encryption-customer-algorithm`

    • ‘x-amz-server-side-encryption-customer-key`

    • ‘x-amz-server-side-encryption-customer-key-MD5`

    For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :sse_customer_key (String) —

    Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    • ‘x-amz-server-side-encryption-customer-algorithm`

    • ‘x-amz-server-side-encryption-customer-key`

    • ‘x-amz-server-side-encryption-customer-key-MD5`

    For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :sse_customer_key_md5 (String) —

    Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    • ‘x-amz-server-side-encryption-customer-algorithm`

    • ‘x-amz-server-side-encryption-customer-key`

    • ‘x-amz-server-side-encryption-customer-key-MD5`

    For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :part_number (Integer) —

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ GET request for the part specified. Useful for downloading just a part of an object.

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

  • :checksum_mode (String) —

    To retrieve the checksum, this mode must be enabled.

    **General purpose buckets** - In addition, if you enable checksum mode and the object is uploaded with a [checksum] and encrypted with an Key Management Service (KMS) key, you must have permission to use the ‘kms:Decrypt` action to retrieve the checksum.

    [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html

Returns:

See Also:



8817
8818
8819
8820
 
# File 'lib/aws-sdk-s3/client.rb', line 8817

def get_object(params = {}, options = {}, &block)
  req = build_request(:get_object, params)
  req.send_request(options, &block)
end

#get_object_acl(params = {}) ⇒ Types::GetObjectAclOutput

<note markdown=“1”> This operation is not supported for directory buckets.

</note>

Returns the access control list (ACL) of an object. To use this operation, you must have ‘s3:GetObjectAcl` permissions or `READ_ACP` access to the object. For more information, see [Mapping of ACL permissions and access policy permissions] in the *Amazon S3 User Guide*

This functionality is not supported for Amazon S3 on Outposts.

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

<note markdown=“1”> If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the ‘bucket-owner-full-control` ACL with the owner being the account that created the bucket. For more information, see [ Controlling object ownership and disabling ACLs] in the *Amazon S3 User Guide*.

</note>

The following operations are related to ‘GetObjectAcl`:

  • GetObject][3
  • GetObjectAttributes][4
  • DeleteObject][5
  • PutObject][6

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html

Examples:

Example: To retrieve object ACL


# The following example retrieves access control list (ACL) of an object.

resp = client.get_object_acl({
  bucket: "examplebucket", 
  key: "HappyFace.jpg", 
})

resp.to_h outputs the following:
{
  grants: [
    {
      grantee: {
        display_name: "owner-display-name", 
        id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
        type: "CanonicalUser", 
      }, 
      permission: "WRITE", 
    }, 
    {
      grantee: {
        display_name: "owner-display-name", 
        id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
        type: "CanonicalUser", 
      }, 
      permission: "WRITE_ACP", 
    }, 
    {
      grantee: {
        display_name: "owner-display-name", 
        id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
        type: "CanonicalUser", 
      }, 
      permission: "READ", 
    }, 
    {
      grantee: {
        display_name: "owner-display-name", 
        id: "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
        type: "CanonicalUser", 
      }, 
      permission: "READ_ACP", 
    }, 
  ], 
  owner: {
    display_name: "owner-display-name", 
    id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc", 
  }, 
}

Request syntax with placeholder values


resp = client.get_object_acl({
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
})

Response structure


resp.owner.display_name #=> String
resp.owner.id #=> String
resp.grants #=> Array
resp.grants[0].grantee.display_name #=> String
resp.grants[0].grantee.email_address #=> String
resp.grants[0].grantee.id #=> String
resp.grants[0].grantee.type #=> String, one of "CanonicalUser", "AmazonCustomerByEmail", "Group"
resp.grants[0].grantee.uri #=> String
resp.grants[0].permission #=> String, one of "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP"
resp.request_charged #=> String, one of "requester"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The bucket name that contains the object for which to get the ACL information.

    **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html

  • :key (required, String) —

    The key of the object for which to get the ACL information.

  • :version_id (String) —

    Version ID used to reference a specific version of the object.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>
  • :request_payer (String) —

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

    <note markdown=“1”> This functionality is not supported for directory buckets.

    </note>

    [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

  • :expected_bucket_owner (String) —

    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

See Also:



9001
9002
9003
9004
 
# File 'lib/aws-sdk-s3/client.rb', line 9001

def get_object_acl(params = {}, options = {})
  req = build_request(:get_object_acl, params)
  req.send_request(options)
end

#get_object_attributes(params = {}) ⇒ Types::GetObjectAttributesOutput

Retrieves all the metadata from an object without returning the object itself. This operation is useful if you’re interested only in an object’s metadata.

‘GetObjectAttributes` combines the functionality of `HeadObject` and `ListParts`. All of the data returned with each of those individual calls can be returned with a single call to `GetObjectAttributes`.

<note markdown=“1”> **Directory buckets** - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format ‘bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name `. Path-style requests are not supported. For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability Zones] in the *Amazon S3 User Guide*. For more information about endpoints in Local Zones, see

Available Local Zone for directory buckets][2

in the *Amazon S3 User

Guide*.

</note>

Permissions : * **General purpose bucket permissions** - To use

  `GetObjectAttributes`, you must have READ access to the object.
  The permissions that you need to use this operation depend on
  whether the bucket is versioned. If the bucket is versioned, you
  need both the `s3:GetObjectVersion` and
  `s3:GetObjectVersionAttributes` permissions for this operation. If
  the bucket is not versioned, you need the `s3:GetObject` and
  `s3:GetObjectAttributes` permissions. For more information, see
  [Specifying Permissions in a Policy][3] in the *Amazon S3 User
  Guide*. If the object that you request does not exist, the error
  Amazon S3 returns depends on whether you also have the
  `s3:ListBucket` permission.

  * If you have the `s3:ListBucket` permission on the bucket, Amazon
    S3 returns an HTTP status code `404 Not Found` ("no such key")
    error.

  * If you don't have the `s3:ListBucket` permission, Amazon S3
    returns an HTTP status code `403 Forbidden` ("access denied")
    error.
* **Directory bucket permissions** - To grant access to this API
  operation on a directory bucket, we recommend that you use the [
  `CreateSession` ][4] API operation for session-based
  authorization. Specifically, you grant the
  `s3express:CreateSession` permission to the directory bucket in a
  bucket policy or an IAM identity-based policy. Then, you make the
  `CreateSession` API call on the bucket to obtain a session token.
  With the session token in your request header, you can make API
  requests to this operation. After the session token expires, you
  make another `CreateSession` API call to generate a new session
  token for use. Amazon Web Services CLI or SDKs create session and
  refresh the session token automatically to avoid service
  interruptions when a session expires. For more information about
  authorization, see [ `CreateSession` ][4].

  If the object is encrypted with SSE-KMS, you must also have the
  `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
  identity-based policies and KMS key policies for the KMS key.

Encryption : <note markdown=“1”> Encryption request headers, like ‘x-amz-server-side-encryption`,

should not be sent for `HEAD` requests if your object uses
server-side encryption with Key Management Service (KMS) keys
(SSE-KMS), dual-layer server-side encryption with Amazon Web
Services KMS keys (DSSE-KMS), or server-side encryption with Amazon
S3 managed encryption keys (SSE-S3). The
`x-amz-server-side-encryption` header is used when you `PUT` an
object to S3 and want to specify the encryption method. If you
include this header in a `GET` request for an object that uses these
types of keys, you’ll get an HTTP `400 Bad Request` error. It's
because the encryption method can't be changed when you retrieve
the object.

 </note>

If you encrypt an object by using server-side encryption with
customer-provided encryption keys (SSE-C) when you store the object
in Amazon S3, then when you retrieve the metadata from the object,
you must use the following headers to provide the encryption key for
the server to be able to retrieve the object's metadata. The
headers are:

* `x-amz-server-side-encryption-customer-algorithm`

* `x-amz-server-side-encryption-customer-key`

* `x-amz-server-side-encryption-customer-key-MD5`

For more information about SSE-C, see [Server-Side Encryption (Using
Customer-Provided Encryption Keys)][5] in the *Amazon S3 User
Guide*.

<note markdown="1"> **Directory bucket permissions** - For directory buckets, there are
only two supported options for server-side encryption: server-side
encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and
server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We
recommend that the bucket's default encryption uses the desired
encryption configuration and you don't override the bucket default
encryption in your `CreateSession` requests or `PUT` object
requests. Then, new objects are automatically encrypted with the
desired encryption settings. For more information, see [Protecting
data with server-side encryption][6] in the *Amazon S3 User Guide*.
For more information about the encryption overriding behaviors in
directory buckets, see [Specifying server-side encryption with KMS
for new object uploads][7].

 </note>

Versioning

: **Directory buckets** - S3 Versioning isn’t enabled and supported

for directory buckets. For this API operation, only the `null` value
of the version ID is supported by directory buckets. You can only
specify `null` to the `versionId` query parameter in the request.

Conditional request headers

: Consider the following when using request headers:

* If both of the `If-Match` and `If-Unmodified-Since` headers are
  present in the request as follows, then Amazon S3 returns the HTTP
  status code `200 OK` and the data requested:

  * `If-Match` condition evaluates to `true`.

  * `If-Unmodified-Since` condition evaluates to `false`.
  For more information about conditional requests, see [RFC
  7232][8].

* If both of the `If-None-Match` and `If-Modified-Since` headers are
  present in the request as follows, then Amazon S3 returns the HTTP
  status code `304 Not Modified`:

  * `If-None-Match` condition evaluates to `false`.

  * `If-Modified-Since` condition evaluates to `true`.
  For more information about conditional requests, see [RFC
  7232][8].

HTTP Host header syntax

: Directory buckets - The HTTP Host header syntax is ‘

Bucket-name.s3express-zone-id.region-code.amazonaws.com`.

The following actions are related to ‘GetObjectAttributes`:

  • GetObject][9
  • GetObjectAcl][10
  • GetObjectLegalHold][11
  • GetObjectLockConfiguration][12
  • GetObjectRetention][13
  • GetObjectTagging][14
  • HeadObject][15
  • ListParts][16

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html [8]: tools.ietf.org/html/rfc7232 [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html [12]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html [13]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html [14]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html [15]: docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html [16]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html

Examples:

Request syntax with placeholder values


resp = client.get_object_attributes({
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  max_parts: 1,
  part_number_marker: 1,
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  object_attributes: ["ETag"], # required, accepts ETag, Checksum, ObjectParts, StorageClass, ObjectSize
})

Response structure


resp.delete_marker #=> Boolean
resp.last_modified #=> Time
resp.version_id #=> String
resp.request_charged #=> String, one of "requester"
resp.etag #=> String
resp.checksum.checksum_crc32 #=> String
resp.checksum.checksum_crc32c #=> String
resp.checksum.checksum_sha1 #=> String
resp.checksum.checksum_sha256 #=> String
resp.object_parts.total_parts_count #=> Integer
resp.object_parts.part_number_marker #=> Integer
resp.object_parts.next_part_number_marker #=> Integer
resp.object_parts.max_parts #=> Integer
resp.object_parts.is_truncated #=> Boolean
resp.object_parts.parts #=> Array
resp.object_parts.parts[0].part_number #=> Integer
resp.object_parts.parts[0].size #=> Integer
resp.object_parts.parts[0].checksum_crc32 #=> String
resp.object_parts.parts[0].checksum_crc32c #=> String
resp.object_parts.parts[0].checksum_sha1 #=> String
resp.object_parts.parts[0].checksum_sha256 #=> String
resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE"
resp.object_size #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bucket (required, String) —

    The name of the bucket that contains the object.

    **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ‘ Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

    **Access points** - When you use this action with an access