aws-sdk-s3 1.120.1 → 1.121.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +16 -19
- data/lib/aws-sdk-s3/client.rb +555 -637
- data/lib/aws-sdk-s3/object.rb +40 -45
- data/lib/aws-sdk-s3/object_summary.rb +31 -37
- data/lib/aws-sdk-s3/object_version.rb +4 -6
- data/lib/aws-sdk-s3/types.rb +222 -284
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -501,14 +501,14 @@ module Aws::S3
|
|
501
501
|
# name. For more information about access point ARNs, see [Using access
|
502
502
|
# points][1] in the *Amazon S3 User Guide*.
|
503
503
|
#
|
504
|
-
# When
|
504
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
505
505
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
506
506
|
# takes the form `
|
507
507
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
508
|
-
# When
|
509
|
-
# Services SDKs, you provide the Outposts
|
510
|
-
#
|
511
|
-
# [
|
508
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
509
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
510
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
511
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
512
512
|
#
|
513
513
|
#
|
514
514
|
#
|
@@ -596,17 +596,10 @@ module Aws::S3
|
|
596
596
|
# minutes to complete. After Amazon S3 begins processing the request, it
|
597
597
|
# sends an HTTP response header that specifies a 200 OK response. While
|
598
598
|
# processing is in progress, Amazon S3 periodically sends white space
|
599
|
-
# characters to keep the connection from timing out.
|
600
|
-
# fail after the initial 200 OK response has been sent
|
601
|
-
#
|
602
|
-
#
|
603
|
-
# parse the contents of the response and handle it appropriately. If you
|
604
|
-
# use Amazon Web Services SDKs, SDKs handle this condition. The SDKs
|
605
|
-
# detect the embedded error and apply error handling per your
|
606
|
-
# configuration settings (including automatically retrying the request
|
607
|
-
# as appropriate). If the condition persists, the SDKs throws an
|
608
|
-
# exception (or, for the SDKs that don't use exceptions, they return
|
609
|
-
# the error).
|
599
|
+
# characters to keep the connection from timing out. Because a request
|
600
|
+
# could fail after the initial 200 OK response has been sent, it is
|
601
|
+
# important that you check the response body to determine whether the
|
602
|
+
# request succeeded.
|
610
603
|
#
|
611
604
|
# Note that if `CompleteMultipartUpload` fails, applications should be
|
612
605
|
# prepared to retry the failed requests. For more information, see
|
@@ -690,14 +683,14 @@ module Aws::S3
|
|
690
683
|
# name. For more information about access point ARNs, see [Using access
|
691
684
|
# points][1] in the *Amazon S3 User Guide*.
|
692
685
|
#
|
693
|
-
# When
|
686
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
694
687
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
695
688
|
# takes the form `
|
696
689
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
697
|
-
# When
|
698
|
-
# Services SDKs, you provide the Outposts
|
699
|
-
#
|
700
|
-
# [
|
690
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
691
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
692
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
693
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
701
694
|
#
|
702
695
|
#
|
703
696
|
#
|
@@ -929,14 +922,8 @@ module Aws::S3
|
|
929
922
|
# before the copy action starts, you receive a standard Amazon S3 error.
|
930
923
|
# If the error occurs during the copy operation, the error response is
|
931
924
|
# embedded in the `200 OK` response. This means that a `200 OK` response
|
932
|
-
# can contain either a success or an error.
|
933
|
-
#
|
934
|
-
# of the response and handle it appropriately. If you use Amazon Web
|
935
|
-
# Services SDKs, SDKs handle this condition. The SDKs detect the
|
936
|
-
# embedded error and apply error handling per your configuration
|
937
|
-
# settings (including automatically retrying the request as
|
938
|
-
# appropriate). If the condition persists, the SDKs throws an exception
|
939
|
-
# (or, for the SDKs that don't use exceptions, they return the error).
|
925
|
+
# can contain either a success or an error. Design your application to
|
926
|
+
# parse the contents of the response and handle it appropriately.
|
940
927
|
#
|
941
928
|
# If the copy is successful, you receive a response with information
|
942
929
|
# about the copied object.
|
@@ -974,11 +961,6 @@ module Aws::S3
|
|
974
961
|
# condition keys, see [Actions, Resources, and Condition Keys for Amazon
|
975
962
|
# S3][7].
|
976
963
|
#
|
977
|
-
# <note markdown="1"> `x-amz-website-redirect-location` is unique to each object and must be
|
978
|
-
# specified in the request headers to copy the value.
|
979
|
-
#
|
980
|
-
# </note>
|
981
|
-
#
|
982
964
|
# **x-amz-copy-source-if Headers**
|
983
965
|
#
|
984
966
|
# To only copy an object under certain conditions, such as whether the
|
@@ -1018,30 +1000,14 @@ module Aws::S3
|
|
1018
1000
|
#
|
1019
1001
|
# **Server-side encryption**
|
1020
1002
|
#
|
1021
|
-
#
|
1022
|
-
#
|
1023
|
-
#
|
1024
|
-
#
|
1025
|
-
#
|
1026
|
-
#
|
1027
|
-
#
|
1028
|
-
#
|
1029
|
-
# Management Service (KMS) key (SSE-KMS), or a customer-provided
|
1030
|
-
# encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a
|
1031
|
-
# customer-provided key to encrypt the target object copy. When you
|
1032
|
-
# perform a CopyObject operation, if you want to use a different type of
|
1033
|
-
# encryption setting for the target object, you can use other
|
1034
|
-
# appropriate encryption-related headers to encrypt the target object
|
1035
|
-
# with a KMS key, an Amazon S3 managed key, or a customer-provided key.
|
1036
|
-
# With server-side encryption, Amazon S3 encrypts your data as it writes
|
1037
|
-
# it to disks in its data centers and decrypts the data when you access
|
1038
|
-
# it. If the encryption setting in your request is different from the
|
1039
|
-
# default encryption configuration of the destination bucket, the
|
1040
|
-
# encryption setting in your request takes precedence. If the source
|
1041
|
-
# object for the copy is stored in Amazon S3 using SSE-C, you must
|
1042
|
-
# provide the necessary encryption information in your request so that
|
1043
|
-
# Amazon S3 can decrypt the object for copying. For more information
|
1044
|
-
# about server-side encryption, see [Using Server-Side Encryption][8].
|
1003
|
+
# When you perform a CopyObject operation, you can optionally use the
|
1004
|
+
# appropriate encryption-related headers to encrypt the object using
|
1005
|
+
# server-side encryption with Amazon Web Services managed encryption
|
1006
|
+
# keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With
|
1007
|
+
# server-side encryption, Amazon S3 encrypts your data as it writes it
|
1008
|
+
# to disks in its data centers and decrypts the data when you access it.
|
1009
|
+
# For more information about server-side encryption, see [Using
|
1010
|
+
# Server-Side Encryption][8].
|
1045
1011
|
#
|
1046
1012
|
# If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
|
1047
1013
|
# the object. For more information, see [Amazon S3 Bucket Keys][9] in
|
@@ -1153,14 +1119,14 @@ module Aws::S3
|
|
1153
1119
|
# name. For more information about access point ARNs, see [Using access
|
1154
1120
|
# points][1] in the *Amazon S3 User Guide*.
|
1155
1121
|
#
|
1156
|
-
# When
|
1122
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
1157
1123
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1158
1124
|
# takes the form `
|
1159
1125
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1160
|
-
# When
|
1161
|
-
# Services SDKs, you provide the Outposts
|
1162
|
-
#
|
1163
|
-
# [
|
1126
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
1127
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
1128
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
1129
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
1164
1130
|
#
|
1165
1131
|
#
|
1166
1132
|
#
|
@@ -1294,7 +1260,7 @@ module Aws::S3
|
|
1294
1260
|
#
|
1295
1261
|
# @option params [String] :server_side_encryption
|
1296
1262
|
# The server-side encryption algorithm used when storing this object in
|
1297
|
-
# Amazon S3 (for example, AES256,
|
1263
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
1298
1264
|
#
|
1299
1265
|
# @option params [String] :storage_class
|
1300
1266
|
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
@@ -1311,10 +1277,7 @@ module Aws::S3
|
|
1311
1277
|
# @option params [String] :website_redirect_location
|
1312
1278
|
# If the bucket is configured as a website, redirects requests for this
|
1313
1279
|
# object to another object in the same bucket or to an external URL.
|
1314
|
-
# Amazon S3 stores the value of this header in the object metadata.
|
1315
|
-
# value is unique to each object and is not copied when using the
|
1316
|
-
# `x-amz-metadata-directive` header. Instead, you may opt to provide
|
1317
|
-
# this header in combination with the directive.
|
1280
|
+
# Amazon S3 stores the value of this header in the object metadata.
|
1318
1281
|
#
|
1319
1282
|
# @option params [String] :sse_customer_algorithm
|
1320
1283
|
# Specifies the algorithm to use to when encrypting the object (for
|
@@ -1470,7 +1433,7 @@ module Aws::S3
|
|
1470
1433
|
# metadata_directive: "COPY", # accepts COPY, REPLACE
|
1471
1434
|
# tagging_directive: "COPY", # accepts COPY, REPLACE
|
1472
1435
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
1473
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
|
1436
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW
|
1474
1437
|
# website_redirect_location: "WebsiteRedirectLocation",
|
1475
1438
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
1476
1439
|
# sse_customer_key: "SSECustomerKey",
|
@@ -1811,42 +1774,22 @@ module Aws::S3
|
|
1811
1774
|
#
|
1812
1775
|
# </note>
|
1813
1776
|
#
|
1814
|
-
#
|
1815
|
-
# encrypts your data as it writes it to disks in
|
1816
|
-
# decrypts it when you access it.
|
1817
|
-
#
|
1818
|
-
#
|
1819
|
-
#
|
1820
|
-
#
|
1821
|
-
#
|
1822
|
-
#
|
1823
|
-
#
|
1824
|
-
# server-side encryption with an Key Management Service (KMS) key
|
1825
|
-
# (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3
|
1826
|
-
# uses the corresponding KMS key, or a customer-provided key to encrypt
|
1827
|
-
# the uploaded parts. When you perform a CreateMultipartUpload
|
1828
|
-
# operation, if you want to use a different type of encryption setting
|
1829
|
-
# for the uploaded parts, you can request that Amazon S3 encrypts the
|
1830
|
-
# object with a KMS key, an Amazon S3 managed key, or a
|
1831
|
-
# customer-provided key. If the encryption setting in your request is
|
1832
|
-
# different from the default encryption configuration of the destination
|
1833
|
-
# bucket, the encryption setting in your request takes precedence. If
|
1834
|
-
# you choose to provide your own encryption key, the request headers you
|
1835
|
-
# provide in [UploadPart][1] and [UploadPartCopy][6] requests must match
|
1836
|
-
# the headers you used in the request to initiate the upload by using
|
1837
|
-
# `CreateMultipartUpload`. you can request that Amazon S3 save the
|
1838
|
-
# uploaded parts encrypted with server-side encryption with an Amazon S3
|
1839
|
-
# managed key (SSE-S3), an Key Management Service (KMS) key (SSE-KMS),
|
1840
|
-
# or a customer-provided encryption key (SSE-C).
|
1841
|
-
#
|
1842
|
-
# To perform a multipart upload with encryption by using an Amazon Web
|
1777
|
+
# You can optionally request server-side encryption. For server-side
|
1778
|
+
# encryption, Amazon S3 encrypts your data as it writes it to disks in
|
1779
|
+
# its data centers and decrypts it when you access it. You can provide
|
1780
|
+
# your own encryption key, or use Amazon Web Services KMS keys or Amazon
|
1781
|
+
# S3-managed encryption keys. If you choose to provide your own
|
1782
|
+
# encryption key, the request headers you provide in [UploadPart][1] and
|
1783
|
+
# [UploadPartCopy][6] requests must match the headers you used in the
|
1784
|
+
# request to initiate the upload by using `CreateMultipartUpload`.
|
1785
|
+
#
|
1786
|
+
# To perform a multipart upload with encryption using an Amazon Web
|
1843
1787
|
# Services KMS key, the requester must have permission to the
|
1844
1788
|
# `kms:Decrypt` and `kms:GenerateDataKey*` actions on the key. These
|
1845
1789
|
# permissions are required because Amazon S3 must decrypt and read data
|
1846
1790
|
# from the encrypted file parts before it completes the multipart
|
1847
1791
|
# upload. For more information, see [Multipart upload API and
|
1848
|
-
# permissions][7]
|
1849
|
-
# Amazon Web Services KMS][8] in the *Amazon S3 User Guide*.
|
1792
|
+
# permissions][7] in the *Amazon S3 User Guide*.
|
1850
1793
|
#
|
1851
1794
|
# If your Identity and Access Management (IAM) user or role is in the
|
1852
1795
|
# same Amazon Web Services account as the KMS key, then you must have
|
@@ -1855,7 +1798,7 @@ module Aws::S3
|
|
1855
1798
|
# permissions on both the key policy and your IAM user or role.
|
1856
1799
|
#
|
1857
1800
|
# For more information, see [Protecting Data Using Server-Side
|
1858
|
-
# Encryption][
|
1801
|
+
# Encryption][8].
|
1859
1802
|
#
|
1860
1803
|
# Access Permissions
|
1861
1804
|
#
|
@@ -1865,33 +1808,31 @@ module Aws::S3
|
|
1865
1808
|
# request headers:
|
1866
1809
|
#
|
1867
1810
|
# * Specify a canned ACL with the `x-amz-acl` request header. For more
|
1868
|
-
# information, see [Canned ACL][
|
1811
|
+
# information, see [Canned ACL][9].
|
1869
1812
|
#
|
1870
1813
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
1871
1814
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
1872
1815
|
# `x-amz-grant-full-control` headers. These parameters map to the
|
1873
1816
|
# set of permissions that Amazon S3 supports in an ACL. For more
|
1874
|
-
# information, see [Access Control List (ACL) Overview][
|
1817
|
+
# information, see [Access Control List (ACL) Overview][10].
|
1875
1818
|
#
|
1876
1819
|
# You can use either a canned ACL or specify access permissions
|
1877
1820
|
# explicitly. You cannot do both.
|
1878
1821
|
#
|
1879
1822
|
# Server-Side- Encryption-Specific Request Headers
|
1880
1823
|
#
|
1881
|
-
# : Amazon S3
|
1882
|
-
#
|
1883
|
-
#
|
1884
|
-
#
|
1885
|
-
#
|
1886
|
-
#
|
1887
|
-
#
|
1888
|
-
#
|
1889
|
-
#
|
1890
|
-
#
|
1891
|
-
#
|
1892
|
-
#
|
1893
|
-
# manage the keys used to encrypt data, specify the following
|
1894
|
-
# headers in the request.
|
1824
|
+
# : You can optionally tell Amazon S3 to encrypt data at rest using
|
1825
|
+
# server-side encryption. Server-side encryption is for data
|
1826
|
+
# encryption at rest. Amazon S3 encrypts your data as it writes it to
|
1827
|
+
# disks in its data centers and decrypts it when you access it. The
|
1828
|
+
# option you use depends on whether you want to use Amazon Web
|
1829
|
+
# Services managed encryption keys or provide your own encryption key.
|
1830
|
+
#
|
1831
|
+
# * Use encryption keys managed by Amazon S3 or customer managed key
|
1832
|
+
# stored in Amazon Web Services Key Management Service (Amazon Web
|
1833
|
+
# Services KMS) – If you want Amazon Web Services to manage the keys
|
1834
|
+
# used to encrypt data, specify the following headers in the
|
1835
|
+
# request.
|
1895
1836
|
#
|
1896
1837
|
# * `x-amz-server-side-encryption`
|
1897
1838
|
#
|
@@ -1901,22 +1842,22 @@ module Aws::S3
|
|
1901
1842
|
#
|
1902
1843
|
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
|
1903
1844
|
# provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
|
1904
|
-
# uses the Amazon Web Services managed key
|
1905
|
-
# protect the data.
|
1845
|
+
# uses the Amazon Web Services managed key in Amazon Web Services
|
1846
|
+
# KMS to protect the data.
|
1906
1847
|
#
|
1907
1848
|
# </note>
|
1908
1849
|
#
|
1909
|
-
# All
|
1910
|
-
# if you don't make them
|
1911
|
-
#
|
1850
|
+
# All GET and PUT requests for an object protected by Amazon Web
|
1851
|
+
# Services KMS fail if you don't make them with SSL or by using
|
1852
|
+
# SigV4.
|
1912
1853
|
#
|
1913
|
-
# For more information about server-side encryption with KMS
|
1854
|
+
# For more information about server-side encryption with KMS key
|
1914
1855
|
# (SSE-KMS), see [Protecting Data Using Server-Side Encryption with
|
1915
|
-
# KMS keys][
|
1856
|
+
# KMS keys][11].
|
1916
1857
|
#
|
1917
|
-
# * Use customer-provided encryption keys
|
1918
|
-
#
|
1919
|
-
#
|
1858
|
+
# * Use customer-provided encryption keys – If you want to manage your
|
1859
|
+
# own encryption keys, provide all the following headers in the
|
1860
|
+
# request.
|
1920
1861
|
#
|
1921
1862
|
# * `x-amz-server-side-encryption-customer-algorithm`
|
1922
1863
|
#
|
@@ -1924,10 +1865,9 @@ module Aws::S3
|
|
1924
1865
|
#
|
1925
1866
|
# * `x-amz-server-side-encryption-customer-key-MD5`
|
1926
1867
|
#
|
1927
|
-
# For more information about server-side encryption with
|
1928
|
-
#
|
1929
|
-
#
|
1930
|
-
# keys (SSE-C)][12].
|
1868
|
+
# For more information about server-side encryption with KMS keys
|
1869
|
+
# (SSE-KMS), see [Protecting Data Using Server-Side Encryption with
|
1870
|
+
# KMS keys][11].
|
1931
1871
|
#
|
1932
1872
|
# Access-Control-List (ACL)-Specific Request Headers
|
1933
1873
|
#
|
@@ -1937,19 +1877,19 @@ module Aws::S3
|
|
1937
1877
|
# permissions to individual Amazon Web Services accounts or to
|
1938
1878
|
# predefined groups defined by Amazon S3. These permissions are then
|
1939
1879
|
# added to the access control list (ACL) on the object. For more
|
1940
|
-
# information, see [Using ACLs][
|
1880
|
+
# information, see [Using ACLs][12]. With this operation, you can
|
1941
1881
|
# grant access permissions using one of the following two methods:
|
1942
1882
|
#
|
1943
1883
|
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
1944
1884
|
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
|
1945
1885
|
# predefined set of grantees and permissions. For more information,
|
1946
|
-
# see [Canned ACL][
|
1886
|
+
# see [Canned ACL][9].
|
1947
1887
|
#
|
1948
1888
|
# * Specify access permissions explicitly — To explicitly grant access
|
1949
1889
|
# permissions to specific Amazon Web Services accounts or groups,
|
1950
1890
|
# use the following headers. Each header maps to specific
|
1951
1891
|
# permissions that Amazon S3 supports in an ACL. For more
|
1952
|
-
# information, see [Access Control List (ACL) Overview][
|
1892
|
+
# information, see [Access Control List (ACL) Overview][10]. In the
|
1953
1893
|
# header, you specify a list of grantees who get the specific
|
1954
1894
|
# permission. To grant permissions explicitly, use:
|
1955
1895
|
#
|
@@ -1994,7 +1934,7 @@ module Aws::S3
|
|
1994
1934
|
# * South America (São Paulo)
|
1995
1935
|
#
|
1996
1936
|
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1997
|
-
# see [Regions and Endpoints][
|
1937
|
+
# see [Regions and Endpoints][13] in the Amazon Web Services
|
1998
1938
|
# General Reference.
|
1999
1939
|
#
|
2000
1940
|
# </note>
|
@@ -2009,13 +1949,13 @@ module Aws::S3
|
|
2009
1949
|
#
|
2010
1950
|
# * [UploadPart][1]
|
2011
1951
|
#
|
2012
|
-
# * [CompleteMultipartUpload][
|
1952
|
+
# * [CompleteMultipartUpload][14]
|
2013
1953
|
#
|
2014
|
-
# * [AbortMultipartUpload][
|
1954
|
+
# * [AbortMultipartUpload][15]
|
2015
1955
|
#
|
2016
|
-
# * [ListParts][
|
1956
|
+
# * [ListParts][16]
|
2017
1957
|
#
|
2018
|
-
# * [ListMultipartUploads][
|
1958
|
+
# * [ListMultipartUploads][17]
|
2019
1959
|
#
|
2020
1960
|
#
|
2021
1961
|
#
|
@@ -2026,17 +1966,16 @@ module Aws::S3
|
|
2026
1966
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
2027
1967
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
2028
1968
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions
|
2029
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2030
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
2031
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
2032
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
2033
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2034
|
-
# [13]: https://docs.aws.amazon.com/
|
2035
|
-
# [14]: https://docs.aws.amazon.com/
|
2036
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2037
|
-
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2038
|
-
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2039
|
-
# [18]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
1969
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
1970
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1971
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1972
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
|
1973
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
1974
|
+
# [13]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1975
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
1976
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
1977
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
1978
|
+
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
2040
1979
|
#
|
2041
1980
|
# @option params [String] :acl
|
2042
1981
|
# The canned ACL to apply to the object.
|
@@ -2054,14 +1993,14 @@ module Aws::S3
|
|
2054
1993
|
# name. For more information about access point ARNs, see [Using access
|
2055
1994
|
# points][1] in the *Amazon S3 User Guide*.
|
2056
1995
|
#
|
2057
|
-
# When
|
1996
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2058
1997
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2059
1998
|
# takes the form `
|
2060
1999
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
2061
|
-
# When
|
2062
|
-
# Services SDKs, you provide the Outposts
|
2063
|
-
#
|
2064
|
-
# [
|
2000
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
2001
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
2002
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
2003
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2065
2004
|
#
|
2066
2005
|
#
|
2067
2006
|
#
|
@@ -2117,7 +2056,7 @@ module Aws::S3
|
|
2117
2056
|
#
|
2118
2057
|
# @option params [String] :server_side_encryption
|
2119
2058
|
# The server-side encryption algorithm used when storing this object in
|
2120
|
-
# Amazon S3 (for example, AES256,
|
2059
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
2121
2060
|
#
|
2122
2061
|
# @option params [String] :storage_class
|
2123
2062
|
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
@@ -2153,13 +2092,13 @@ module Aws::S3
|
|
2153
2092
|
# ensure that the encryption key was transmitted without error.
|
2154
2093
|
#
|
2155
2094
|
# @option params [String] :ssekms_key_id
|
2156
|
-
# Specifies the ID of the symmetric
|
2157
|
-
#
|
2158
|
-
#
|
2159
|
-
#
|
2160
|
-
#
|
2161
|
-
#
|
2162
|
-
#
|
2095
|
+
# Specifies the ID of the symmetric customer managed key to use for
|
2096
|
+
# object encryption. All GET and PUT requests for an object protected by
|
2097
|
+
# Amazon Web Services KMS will fail if not made via SSL or using SigV4.
|
2098
|
+
# For information about configuring using any of the officially
|
2099
|
+
# supported Amazon Web Services SDKs and Amazon Web Services CLI, see
|
2100
|
+
# [Specifying the Signature Version in Request Authentication][1] in the
|
2101
|
+
# *Amazon S3 User Guide*.
|
2163
2102
|
#
|
2164
2103
|
#
|
2165
2104
|
#
|
@@ -2272,7 +2211,7 @@ module Aws::S3
|
|
2272
2211
|
# "MetadataKey" => "MetadataValue",
|
2273
2212
|
# },
|
2274
2213
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
2275
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
|
2214
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW
|
2276
2215
|
# website_redirect_location: "WebsiteRedirectLocation",
|
2277
2216
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
2278
2217
|
# sse_customer_key: "SSECustomerKey",
|
@@ -2482,11 +2421,10 @@ module Aws::S3
|
|
2482
2421
|
req.send_request(options)
|
2483
2422
|
end
|
2484
2423
|
|
2485
|
-
# This implementation of the DELETE action
|
2486
|
-
#
|
2487
|
-
#
|
2488
|
-
#
|
2489
|
-
# Guide*.
|
2424
|
+
# This implementation of the DELETE action removes default encryption
|
2425
|
+
# from the bucket. For information about the Amazon S3 default
|
2426
|
+
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
2427
|
+
# the *Amazon S3 User Guide*.
|
2490
2428
|
#
|
2491
2429
|
# To use this operation, you must have permissions to perform the
|
2492
2430
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
@@ -2763,9 +2701,7 @@ module Aws::S3
|
|
2763
2701
|
# The name of the bucket containing the metrics configuration to delete.
|
2764
2702
|
#
|
2765
2703
|
# @option params [required, String] :id
|
2766
|
-
# The ID used to identify the metrics configuration.
|
2767
|
-
# character limit and can only contain letters, numbers, periods,
|
2768
|
-
# dashes, and underscores.
|
2704
|
+
# The ID used to identify the metrics configuration.
|
2769
2705
|
#
|
2770
2706
|
# @option params [String] :expected_bucket_owner
|
2771
2707
|
# The account ID of the expected bucket owner. If the bucket is owned by
|
@@ -3091,10 +3027,11 @@ module Aws::S3
|
|
3091
3027
|
# there isn't a null version, Amazon S3 does not remove any objects but
|
3092
3028
|
# will still respond that the command was successful.
|
3093
3029
|
#
|
3094
|
-
# To remove a specific version, you must
|
3095
|
-
#
|
3096
|
-
#
|
3097
|
-
# `x-amz-delete-marker`, to
|
3030
|
+
# To remove a specific version, you must be the bucket owner and you
|
3031
|
+
# must use the version Id subresource. Using this subresource
|
3032
|
+
# permanently deletes the version. If the object deleted is a delete
|
3033
|
+
# marker, Amazon S3 sets the response header, `x-amz-delete-marker`, to
|
3034
|
+
# true.
|
3098
3035
|
#
|
3099
3036
|
# If the object you want to delete is in a bucket where the bucket
|
3100
3037
|
# versioning configuration is MFA Delete enabled, you must include the
|
@@ -3135,14 +3072,14 @@ module Aws::S3
|
|
3135
3072
|
# name. For more information about access point ARNs, see [Using access
|
3136
3073
|
# points][1] in the *Amazon S3 User Guide*.
|
3137
3074
|
#
|
3138
|
-
# When
|
3075
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
3139
3076
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
3140
3077
|
# takes the form `
|
3141
3078
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
3142
|
-
# When
|
3143
|
-
# Services SDKs, you provide the Outposts
|
3144
|
-
#
|
3145
|
-
# [
|
3079
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
3080
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
3081
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
3082
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3146
3083
|
#
|
3147
3084
|
#
|
3148
3085
|
#
|
@@ -3189,15 +3126,6 @@ module Aws::S3
|
|
3189
3126
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
3190
3127
|
#
|
3191
3128
|
#
|
3192
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
3193
|
-
#
|
3194
|
-
# # The following example deletes an object from a non-versioned bucket.
|
3195
|
-
#
|
3196
|
-
# resp = client.delete_object({
|
3197
|
-
# bucket: "ExampleBucket",
|
3198
|
-
# key: "HappyFace.jpg",
|
3199
|
-
# })
|
3200
|
-
#
|
3201
3129
|
# @example Example: To delete an object
|
3202
3130
|
#
|
3203
3131
|
# # The following example deletes an object from an S3 bucket.
|
@@ -3211,6 +3139,15 @@ module Aws::S3
|
|
3211
3139
|
# {
|
3212
3140
|
# }
|
3213
3141
|
#
|
3142
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
3143
|
+
#
|
3144
|
+
# # The following example deletes an object from a non-versioned bucket.
|
3145
|
+
#
|
3146
|
+
# resp = client.delete_object({
|
3147
|
+
# bucket: "ExampleBucket",
|
3148
|
+
# key: "HappyFace.jpg",
|
3149
|
+
# })
|
3150
|
+
#
|
3214
3151
|
# @example Request syntax with placeholder values
|
3215
3152
|
#
|
3216
3153
|
# resp = client.delete_object({
|
@@ -3248,7 +3185,8 @@ module Aws::S3
|
|
3248
3185
|
# parameter in the request. You will need permission for the
|
3249
3186
|
# `s3:DeleteObjectVersionTagging` action.
|
3250
3187
|
#
|
3251
|
-
# The following operations are related to
|
3188
|
+
# The following operations are related to
|
3189
|
+
# `DeleteBucketMetricsConfiguration`:
|
3252
3190
|
#
|
3253
3191
|
# * [PutObjectTagging][2]
|
3254
3192
|
#
|
@@ -3271,14 +3209,14 @@ module Aws::S3
|
|
3271
3209
|
# name. For more information about access point ARNs, see [Using access
|
3272
3210
|
# points][1] in the *Amazon S3 User Guide*.
|
3273
3211
|
#
|
3274
|
-
# When
|
3212
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
3275
3213
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
3276
3214
|
# takes the form `
|
3277
3215
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
3278
|
-
# When
|
3279
|
-
# Services SDKs, you provide the Outposts
|
3280
|
-
#
|
3281
|
-
# [
|
3216
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
3217
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
3218
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
3219
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3282
3220
|
#
|
3283
3221
|
#
|
3284
3222
|
#
|
@@ -3302,35 +3240,35 @@ module Aws::S3
|
|
3302
3240
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
3303
3241
|
#
|
3304
3242
|
#
|
3305
|
-
# @example Example: To remove tag set from an object
|
3243
|
+
# @example Example: To remove tag set from an object
|
3306
3244
|
#
|
3307
|
-
# # The following example removes tag set associated with the specified object
|
3308
|
-
# #
|
3245
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
3246
|
+
# # operation removes tag set from the latest object version.
|
3309
3247
|
#
|
3310
3248
|
# resp = client.delete_object_tagging({
|
3311
3249
|
# bucket: "examplebucket",
|
3312
3250
|
# key: "HappyFace.jpg",
|
3313
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
3314
3251
|
# })
|
3315
3252
|
#
|
3316
3253
|
# resp.to_h outputs the following:
|
3317
3254
|
# {
|
3318
|
-
# version_id: "
|
3255
|
+
# version_id: "null",
|
3319
3256
|
# }
|
3320
3257
|
#
|
3321
|
-
# @example Example: To remove tag set from an object
|
3258
|
+
# @example Example: To remove tag set from an object version
|
3322
3259
|
#
|
3323
|
-
# # The following example removes tag set associated with the specified object.
|
3324
|
-
# #
|
3260
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
3261
|
+
# # object key and object version.
|
3325
3262
|
#
|
3326
3263
|
# resp = client.delete_object_tagging({
|
3327
3264
|
# bucket: "examplebucket",
|
3328
3265
|
# key: "HappyFace.jpg",
|
3266
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
3329
3267
|
# })
|
3330
3268
|
#
|
3331
3269
|
# resp.to_h outputs the following:
|
3332
3270
|
# {
|
3333
|
-
# version_id: "
|
3271
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
3334
3272
|
# }
|
3335
3273
|
#
|
3336
3274
|
# @example Request syntax with placeholder values
|
@@ -3419,14 +3357,14 @@ module Aws::S3
|
|
3419
3357
|
# name. For more information about access point ARNs, see [Using access
|
3420
3358
|
# points][1] in the *Amazon S3 User Guide*.
|
3421
3359
|
#
|
3422
|
-
# When
|
3360
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
3423
3361
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
3424
3362
|
# takes the form `
|
3425
3363
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
3426
|
-
# When
|
3427
|
-
# Services SDKs, you provide the Outposts
|
3428
|
-
#
|
3429
|
-
# [
|
3364
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
3365
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
3366
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
3367
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3430
3368
|
#
|
3431
3369
|
#
|
3432
3370
|
#
|
@@ -3735,9 +3673,6 @@ module Aws::S3
|
|
3735
3673
|
# can return the ACL of the bucket without using an authorization
|
3736
3674
|
# header.
|
3737
3675
|
#
|
3738
|
-
# To use this API against an access point, provide the alias of the
|
3739
|
-
# access point in place of the bucket name.
|
3740
|
-
#
|
3741
3676
|
# <note markdown="1"> If your bucket uses the bucket owner enforced setting for S3 Object
|
3742
3677
|
# Ownership, requests to read ACLs are still supported and return the
|
3743
3678
|
# `bucket-owner-full-control` ACL with the owner being the account that
|
@@ -3886,9 +3821,6 @@ module Aws::S3
|
|
3886
3821
|
# `s3:GetBucketCORS` action. By default, the bucket owner has this
|
3887
3822
|
# permission and can grant it to others.
|
3888
3823
|
#
|
3889
|
-
# To use this API against an access point, provide the alias of the
|
3890
|
-
# access point in place of the bucket name.
|
3891
|
-
#
|
3892
3824
|
# For more information about CORS, see [ Enabling Cross-Origin Resource
|
3893
3825
|
# Sharing][1].
|
3894
3826
|
#
|
@@ -3974,10 +3906,12 @@ module Aws::S3
|
|
3974
3906
|
end
|
3975
3907
|
|
3976
3908
|
# Returns the default encryption configuration for an Amazon S3 bucket.
|
3977
|
-
#
|
3978
|
-
#
|
3979
|
-
#
|
3980
|
-
#
|
3909
|
+
# If the bucket does not have a default encryption configuration,
|
3910
|
+
# GetBucketEncryption returns
|
3911
|
+
# `ServerSideEncryptionConfigurationNotFoundError`.
|
3912
|
+
#
|
3913
|
+
# For information about the Amazon S3 default encryption feature, see
|
3914
|
+
# [Amazon S3 Default Bucket Encryption][1].
|
3981
3915
|
#
|
3982
3916
|
# To use this operation, you must have permission to perform the
|
3983
3917
|
# `s3:GetEncryptionConfiguration` action. The bucket owner has this
|
@@ -4455,23 +4389,16 @@ module Aws::S3
|
|
4455
4389
|
# To use this API against an access point, provide the alias of the
|
4456
4390
|
# access point in place of the bucket name.
|
4457
4391
|
#
|
4458
|
-
# <note markdown="1"> For requests made using Amazon Web Services Signature Version 4
|
4459
|
-
# (SigV4), we recommend that you use [HeadBucket][2] to return the
|
4460
|
-
# bucket Region instead of GetBucketLocation.
|
4461
|
-
#
|
4462
|
-
# </note>
|
4463
|
-
#
|
4464
4392
|
# The following operations are related to `GetBucketLocation`:
|
4465
4393
|
#
|
4466
|
-
# * [GetObject][
|
4394
|
+
# * [GetObject][2]
|
4467
4395
|
#
|
4468
4396
|
# * [CreateBucket][1]
|
4469
4397
|
#
|
4470
4398
|
#
|
4471
4399
|
#
|
4472
4400
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
4473
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
4474
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
4401
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
4475
4402
|
#
|
4476
4403
|
# @option params [required, String] :bucket
|
4477
4404
|
# The name of the bucket for which to get the location.
|
@@ -4520,7 +4447,8 @@ module Aws::S3
|
|
4520
4447
|
end
|
4521
4448
|
|
4522
4449
|
# Returns the logging status of a bucket and the permissions users have
|
4523
|
-
# to view and modify that status.
|
4450
|
+
# to view and modify that status. To use GET, you must be the bucket
|
4451
|
+
# owner.
|
4524
4452
|
#
|
4525
4453
|
# The following operations are related to `GetBucketLogging`:
|
4526
4454
|
#
|
@@ -4612,9 +4540,7 @@ module Aws::S3
|
|
4612
4540
|
# retrieve.
|
4613
4541
|
#
|
4614
4542
|
# @option params [required, String] :id
|
4615
|
-
# The ID used to identify the metrics configuration.
|
4616
|
-
# character limit and can only contain letters, numbers, periods,
|
4617
|
-
# dashes, and underscores.
|
4543
|
+
# The ID used to identify the metrics configuration.
|
4618
4544
|
#
|
4619
4545
|
# @option params [String] :expected_bucket_owner
|
4620
4546
|
# The account ID of the expected bucket owner. If the bucket is owned by
|
@@ -4778,9 +4704,6 @@ module Aws::S3
|
|
4778
4704
|
# policy to grant permission to other users to read this configuration
|
4779
4705
|
# with the `s3:GetBucketNotification` permission.
|
4780
4706
|
#
|
4781
|
-
# To use this API against an access point, provide the alias of the
|
4782
|
-
# access point in place of the bucket name.
|
4783
|
-
#
|
4784
4707
|
# For more information about setting and reading the notification
|
4785
4708
|
# configuration on a bucket, see [Setting Up Notification of Bucket
|
4786
4709
|
# Events][1]. For more information about bucket policies, see [Using
|
@@ -4926,9 +4849,6 @@ module Aws::S3
|
|
4926
4849
|
# policy explicitly denies the root user the ability to perform this
|
4927
4850
|
# action.
|
4928
4851
|
#
|
4929
|
-
# To use this API against an access point, provide the alias of the
|
4930
|
-
# access point in place of the bucket name.
|
4931
|
-
#
|
4932
4852
|
# For more information about bucket policies, see [Using Bucket Policies
|
4933
4853
|
# and User Policies][1].
|
4934
4854
|
#
|
@@ -5151,7 +5071,7 @@ module Aws::S3
|
|
5151
5071
|
# resp.replication_configuration.rules[0].existing_object_replication.status #=> String, one of "Enabled", "Disabled"
|
5152
5072
|
# resp.replication_configuration.rules[0].destination.bucket #=> String
|
5153
5073
|
# resp.replication_configuration.rules[0].destination.account #=> String
|
5154
|
-
# 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"
|
5074
|
+
# 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"
|
5155
5075
|
# resp.replication_configuration.rules[0].destination.access_control_translation.owner #=> String, one of "Destination"
|
5156
5076
|
# resp.replication_configuration.rules[0].destination.encryption_configuration.replica_kms_key_id #=> String
|
5157
5077
|
# resp.replication_configuration.rules[0].destination.replication_time.status #=> String, one of "Enabled", "Disabled"
|
@@ -5501,7 +5421,7 @@ module Aws::S3
|
|
5501
5421
|
# Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive
|
5502
5422
|
# or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve
|
5503
5423
|
# the object you must first restore a copy using [RestoreObject][3].
|
5504
|
-
# Otherwise, this action returns an `
|
5424
|
+
# Otherwise, this action returns an `InvalidObjectStateError` error. For
|
5505
5425
|
# information about restoring archived objects, see [Restoring Archived
|
5506
5426
|
# Objects][4].
|
5507
5427
|
#
|
@@ -5553,9 +5473,7 @@ module Aws::S3
|
|
5553
5473
|
# <note markdown="1"> * If you supply a `versionId`, you need the `s3:GetObjectVersion`
|
5554
5474
|
# permission to access a specific version of an object. If you request
|
5555
5475
|
# a specific version, you do not need to have the `s3:GetObject`
|
5556
|
-
# permission.
|
5557
|
-
# version ID, only `s3:GetObject` permission is required.
|
5558
|
-
# `s3:GetObjectVersion` permission won't be required.
|
5476
|
+
# permission.
|
5559
5477
|
#
|
5560
5478
|
# * If the current version of the object is a delete marker, Amazon S3
|
5561
5479
|
# behaves as if the object was deleted and includes
|
@@ -5650,14 +5568,14 @@ module Aws::S3
|
|
5650
5568
|
# When using an Object Lambda access point the hostname takes the form
|
5651
5569
|
# *AccessPointName*-*AccountId*.s3-object-lambda.*Region*.amazonaws.com.
|
5652
5570
|
#
|
5653
|
-
# When
|
5571
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5654
5572
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5655
5573
|
# takes the form `
|
5656
5574
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5657
|
-
# When
|
5658
|
-
# Services SDKs, you provide the Outposts
|
5659
|
-
#
|
5660
|
-
# [
|
5575
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
5576
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
5577
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
5578
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5661
5579
|
#
|
5662
5580
|
#
|
5663
5581
|
#
|
@@ -5686,7 +5604,7 @@ module Aws::S3
|
|
5686
5604
|
# @option params [String] :range
|
5687
5605
|
# Downloads the specified range bytes of an object. For more information
|
5688
5606
|
# about the HTTP Range header, see
|
5689
|
-
# [https://www.
|
5607
|
+
# [https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1].
|
5690
5608
|
#
|
5691
5609
|
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
|
5692
5610
|
# `GET` request.
|
@@ -5695,7 +5613,7 @@ module Aws::S3
|
|
5695
5613
|
#
|
5696
5614
|
#
|
5697
5615
|
#
|
5698
|
-
# [1]: https://www.
|
5616
|
+
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
|
5699
5617
|
#
|
5700
5618
|
# @option params [String] :response_cache_control
|
5701
5619
|
# Sets the `Cache-Control` header of the response.
|
@@ -5933,7 +5851,7 @@ module Aws::S3
|
|
5933
5851
|
# resp.sse_customer_key_md5 #=> String
|
5934
5852
|
# resp.ssekms_key_id #=> String
|
5935
5853
|
# resp.bucket_key_enabled #=> Boolean
|
5936
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
|
5854
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
5937
5855
|
# resp.request_charged #=> String, one of "requester"
|
5938
5856
|
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
|
5939
5857
|
# resp.parts_count #=> Integer
|
@@ -6125,7 +6043,9 @@ module Aws::S3
|
|
6125
6043
|
# object's metadata. To use `GetObjectAttributes`, you must have READ
|
6126
6044
|
# access to the object.
|
6127
6045
|
#
|
6128
|
-
# `GetObjectAttributes` combines the functionality of `
|
6046
|
+
# `GetObjectAttributes` combines the functionality of `GetObjectAcl`,
|
6047
|
+
# `GetObjectLegalHold`, `GetObjectLockConfiguration`,
|
6048
|
+
# `GetObjectRetention`, `GetObjectTagging`, `HeadObject`, and
|
6129
6049
|
# `ListParts`. All of the data returned with each of those individual
|
6130
6050
|
# calls can be returned with a single call to `GetObjectAttributes`.
|
6131
6051
|
#
|
@@ -6147,8 +6067,9 @@ module Aws::S3
|
|
6147
6067
|
# should not be sent for GET requests if your object uses server-side
|
6148
6068
|
# encryption with Amazon Web Services KMS keys stored in Amazon Web
|
6149
6069
|
# Services Key Management Service (SSE-KMS) or server-side encryption
|
6150
|
-
# with Amazon S3 managed keys (SSE-S3). If your object does
|
6151
|
-
# types of keys, you'll get an HTTP `400 Bad Request`
|
6070
|
+
# with Amazon S3 managed encryption keys (SSE-S3). If your object does
|
6071
|
+
# use these types of keys, you'll get an HTTP `400 Bad Request`
|
6072
|
+
# error.
|
6152
6073
|
#
|
6153
6074
|
# * The last modified property in this case is the creation date of the
|
6154
6075
|
# object.
|
@@ -6236,14 +6157,14 @@ module Aws::S3
|
|
6236
6157
|
# name. For more information about access point ARNs, see [Using access
|
6237
6158
|
# points][1] in the *Amazon S3 User Guide*.
|
6238
6159
|
#
|
6239
|
-
# When
|
6160
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6240
6161
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6241
6162
|
# takes the form `
|
6242
6163
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
6243
|
-
# When
|
6244
|
-
# Services SDKs, you provide the Outposts
|
6245
|
-
#
|
6246
|
-
# [
|
6164
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
6165
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
6166
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
6167
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6247
6168
|
#
|
6248
6169
|
#
|
6249
6170
|
#
|
@@ -6351,7 +6272,7 @@ module Aws::S3
|
|
6351
6272
|
# resp.object_parts.parts[0].checksum_crc32c #=> String
|
6352
6273
|
# resp.object_parts.parts[0].checksum_sha1 #=> String
|
6353
6274
|
# resp.object_parts.parts[0].checksum_sha256 #=> String
|
6354
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
|
6275
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
6355
6276
|
# resp.object_size #=> Integer
|
6356
6277
|
#
|
6357
6278
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributes AWS API Documentation
|
@@ -6636,14 +6557,14 @@ module Aws::S3
|
|
6636
6557
|
# name. For more information about access point ARNs, see [Using access
|
6637
6558
|
# points][1] in the *Amazon S3 User Guide*.
|
6638
6559
|
#
|
6639
|
-
# When
|
6560
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6640
6561
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6641
6562
|
# takes the form `
|
6642
6563
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
6643
|
-
# When
|
6644
|
-
# Services SDKs, you provide the Outposts
|
6645
|
-
#
|
6646
|
-
# [
|
6564
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
6565
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
6566
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
6567
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6647
6568
|
#
|
6648
6569
|
#
|
6649
6570
|
#
|
@@ -6750,7 +6671,8 @@ module Aws::S3
|
|
6750
6671
|
end
|
6751
6672
|
|
6752
6673
|
# Returns torrent files from a bucket. BitTorrent can save you bandwidth
|
6753
|
-
# when you're distributing large files.
|
6674
|
+
# when you're distributing large files. For more information about
|
6675
|
+
# BitTorrent, see [Using BitTorrent with Amazon S3][1].
|
6754
6676
|
#
|
6755
6677
|
# <note markdown="1"> You can get torrent only for objects that are less than 5 GB in size,
|
6756
6678
|
# and that are not encrypted using server-side encryption with a
|
@@ -6764,13 +6686,14 @@ module Aws::S3
|
|
6764
6686
|
#
|
6765
6687
|
# The following action is related to `GetObjectTorrent`:
|
6766
6688
|
#
|
6767
|
-
# * [GetObject][
|
6689
|
+
# * [GetObject][2]
|
6768
6690
|
#
|
6769
6691
|
# ^
|
6770
6692
|
#
|
6771
6693
|
#
|
6772
6694
|
#
|
6773
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6695
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html
|
6696
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
6774
6697
|
#
|
6775
6698
|
# @option params [String, IO] :response_target
|
6776
6699
|
# Where to write response data, file path, or IO object.
|
@@ -6916,9 +6839,9 @@ module Aws::S3
|
|
6916
6839
|
# exists and you have permission to access it.
|
6917
6840
|
#
|
6918
6841
|
# If the bucket does not exist or you do not have permission to access
|
6919
|
-
# it, the `HEAD` request returns a generic `
|
6920
|
-
# Forbidden`
|
6921
|
-
#
|
6842
|
+
# it, the `HEAD` request returns a generic `404 Not Found` or `403
|
6843
|
+
# Forbidden` code. A message body is not included, so you cannot
|
6844
|
+
# determine the exception beyond these error codes.
|
6922
6845
|
#
|
6923
6846
|
# To use this operation, you must have permissions to perform the
|
6924
6847
|
# `s3:ListBucket` action. The bucket owner has this permission by
|
@@ -6952,14 +6875,14 @@ module Aws::S3
|
|
6952
6875
|
# name. For more information about access point ARNs, see [Using access
|
6953
6876
|
# points][1] in the *Amazon S3 User Guide*.
|
6954
6877
|
#
|
6955
|
-
# When
|
6878
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6956
6879
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6957
6880
|
# takes the form `
|
6958
6881
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
6959
|
-
# When
|
6960
|
-
# Services SDKs, you provide the Outposts
|
6961
|
-
#
|
6962
|
-
# [
|
6882
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
6883
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
6884
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
6885
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6963
6886
|
#
|
6964
6887
|
#
|
6965
6888
|
#
|
@@ -7012,9 +6935,9 @@ module Aws::S3
|
|
7012
6935
|
# A `HEAD` request has the same options as a `GET` action on an object.
|
7013
6936
|
# The response is identical to the `GET` response except that there is
|
7014
6937
|
# no response body. Because of this, if the `HEAD` request generates an
|
7015
|
-
# error, it returns a generic `
|
7016
|
-
#
|
7017
|
-
#
|
6938
|
+
# error, it returns a generic `404 Not Found` or `403 Forbidden` code.
|
6939
|
+
# It is not possible to retrieve the exact exception beyond these error
|
6940
|
+
# codes.
|
7018
6941
|
#
|
7019
6942
|
# If you encrypt an object by using server-side encryption with
|
7020
6943
|
# customer-provided encryption keys (SSE-C) when you store the object in
|
@@ -7106,14 +7029,14 @@ module Aws::S3
|
|
7106
7029
|
# name. For more information about access point ARNs, see [Using access
|
7107
7030
|
# points][1] in the *Amazon S3 User Guide*.
|
7108
7031
|
#
|
7109
|
-
# When
|
7032
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7110
7033
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7111
7034
|
# takes the form `
|
7112
7035
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7113
|
-
# When
|
7114
|
-
# Services SDKs, you provide the Outposts
|
7115
|
-
#
|
7116
|
-
# [
|
7036
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
7037
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
7038
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
7039
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7117
7040
|
#
|
7118
7041
|
#
|
7119
7042
|
#
|
@@ -7140,10 +7063,8 @@ module Aws::S3
|
|
7140
7063
|
# The object key.
|
7141
7064
|
#
|
7142
7065
|
# @option params [String] :range
|
7143
|
-
# HeadObject returns only the metadata for an object
|
7144
|
-
#
|
7145
|
-
# the Range is not satisfiable, S3 returns a `416 - Requested Range Not
|
7146
|
-
# Satisfiable` error.
|
7066
|
+
# Because `HeadObject` returns only the metadata for an object, this
|
7067
|
+
# parameter has no effect.
|
7147
7068
|
#
|
7148
7069
|
# @option params [String] :version_id
|
7149
7070
|
# VersionId used to reference a specific version of the object.
|
@@ -7305,7 +7226,7 @@ module Aws::S3
|
|
7305
7226
|
# resp.sse_customer_key_md5 #=> String
|
7306
7227
|
# resp.ssekms_key_id #=> String
|
7307
7228
|
# resp.bucket_key_enabled #=> Boolean
|
7308
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
|
7229
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
7309
7230
|
# resp.request_charged #=> String, one of "requester"
|
7310
7231
|
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
|
7311
7232
|
# resp.parts_count #=> Integer
|
@@ -7713,22 +7634,17 @@ module Aws::S3
|
|
7713
7634
|
# request. To use this operation, you must have the
|
7714
7635
|
# `s3:ListAllMyBuckets` permission.
|
7715
7636
|
#
|
7716
|
-
# For information about Amazon S3 buckets, see [Creating, configuring,
|
7717
|
-
# and working with Amazon S3 buckets][1].
|
7718
|
-
#
|
7719
|
-
#
|
7720
|
-
#
|
7721
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html
|
7722
|
-
#
|
7723
7637
|
# @return [Types::ListBucketsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7724
7638
|
#
|
7725
7639
|
# * {Types::ListBucketsOutput#buckets #buckets} => Array<Types::Bucket>
|
7726
7640
|
# * {Types::ListBucketsOutput#owner #owner} => Types::Owner
|
7727
7641
|
#
|
7728
7642
|
#
|
7729
|
-
# @example Example: To list
|
7643
|
+
# @example Example: To list object versions
|
7730
7644
|
#
|
7731
|
-
# # The following example
|
7645
|
+
# # The following example return versions of an object with specific key name prefix. The request limits the number of items
|
7646
|
+
# # returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify
|
7647
|
+
# # this token value in your next request to fetch next set of object versions.
|
7732
7648
|
#
|
7733
7649
|
# resp = client.list_buckets({
|
7734
7650
|
# })
|
@@ -7737,15 +7653,15 @@ module Aws::S3
|
|
7737
7653
|
# {
|
7738
7654
|
# buckets: [
|
7739
7655
|
# {
|
7740
|
-
# creation_date: Time.parse("2012-02-15T21:03:02.000Z"),
|
7656
|
+
# creation_date: Time.parse("2012-02-15T21: 03: 02.000Z"),
|
7741
7657
|
# name: "examplebucket",
|
7742
7658
|
# },
|
7743
7659
|
# {
|
7744
|
-
# creation_date: Time.parse("2011-07-24T19:33:50.000Z"),
|
7660
|
+
# creation_date: Time.parse("2011-07-24T19: 33: 50.000Z"),
|
7745
7661
|
# name: "examplebucket2",
|
7746
7662
|
# },
|
7747
7663
|
# {
|
7748
|
-
# creation_date: Time.parse("2010-12-17T00:56:49.000Z"),
|
7664
|
+
# creation_date: Time.parse("2010-12-17T00: 56: 49.000Z"),
|
7749
7665
|
# name: "examplebucket3",
|
7750
7666
|
# },
|
7751
7667
|
# ],
|
@@ -7831,14 +7747,14 @@ module Aws::S3
|
|
7831
7747
|
# name. For more information about access point ARNs, see [Using access
|
7832
7748
|
# points][1] in the *Amazon S3 User Guide*.
|
7833
7749
|
#
|
7834
|
-
# When
|
7750
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7835
7751
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7836
7752
|
# takes the form `
|
7837
7753
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7838
|
-
# When
|
7839
|
-
# Services SDKs, you provide the Outposts
|
7840
|
-
#
|
7841
|
-
# [
|
7754
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
7755
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
7756
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
7757
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7842
7758
|
#
|
7843
7759
|
#
|
7844
7760
|
#
|
@@ -8041,7 +7957,7 @@ module Aws::S3
|
|
8041
7957
|
# resp.uploads[0].upload_id #=> String
|
8042
7958
|
# resp.uploads[0].key #=> String
|
8043
7959
|
# resp.uploads[0].initiated #=> Time
|
8044
|
-
# resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
|
7960
|
+
# resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8045
7961
|
# resp.uploads[0].owner.display_name #=> String
|
8046
7962
|
# resp.uploads[0].owner.id #=> String
|
8047
7963
|
# resp.uploads[0].initiator.id #=> String
|
@@ -8299,14 +8215,14 @@ module Aws::S3
|
|
8299
8215
|
# name. For more information about access point ARNs, see [Using access
|
8300
8216
|
# points][1] in the *Amazon S3 User Guide*.
|
8301
8217
|
#
|
8302
|
-
# When
|
8218
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
8303
8219
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8304
8220
|
# takes the form `
|
8305
8221
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8306
|
-
# When
|
8307
|
-
# Services SDKs, you provide the Outposts
|
8308
|
-
#
|
8309
|
-
# [
|
8222
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
8223
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
8224
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
8225
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8310
8226
|
#
|
8311
8227
|
#
|
8312
8228
|
#
|
@@ -8426,7 +8342,7 @@ module Aws::S3
|
|
8426
8342
|
# resp.contents[0].checksum_algorithm #=> Array
|
8427
8343
|
# resp.contents[0].checksum_algorithm[0] #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256"
|
8428
8344
|
# resp.contents[0].size #=> Integer
|
8429
|
-
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
|
8345
|
+
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8430
8346
|
# resp.contents[0].owner.display_name #=> String
|
8431
8347
|
# resp.contents[0].owner.id #=> String
|
8432
8348
|
# resp.name #=> String
|
@@ -8501,14 +8417,14 @@ module Aws::S3
|
|
8501
8417
|
# name. For more information about access point ARNs, see [Using access
|
8502
8418
|
# points][1] in the *Amazon S3 User Guide*.
|
8503
8419
|
#
|
8504
|
-
# When
|
8420
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
8505
8421
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8506
8422
|
# takes the form `
|
8507
8423
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8508
|
-
# When
|
8509
|
-
# Services SDKs, you provide the Outposts
|
8510
|
-
#
|
8511
|
-
# [
|
8424
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
8425
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
8426
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
8427
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8512
8428
|
#
|
8513
8429
|
#
|
8514
8430
|
#
|
@@ -8578,7 +8494,7 @@ module Aws::S3
|
|
8578
8494
|
# # keys.
|
8579
8495
|
#
|
8580
8496
|
# resp = client.list_objects_v2({
|
8581
|
-
# bucket: "
|
8497
|
+
# bucket: "examplebucket",
|
8582
8498
|
# max_keys: 2,
|
8583
8499
|
# })
|
8584
8500
|
#
|
@@ -8603,7 +8519,7 @@ module Aws::S3
|
|
8603
8519
|
# is_truncated: true,
|
8604
8520
|
# key_count: 2,
|
8605
8521
|
# max_keys: 2,
|
8606
|
-
# name: "
|
8522
|
+
# name: "examplebucket",
|
8607
8523
|
# next_continuation_token: "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==",
|
8608
8524
|
# prefix: "",
|
8609
8525
|
# }
|
@@ -8633,7 +8549,7 @@ module Aws::S3
|
|
8633
8549
|
# resp.contents[0].checksum_algorithm #=> Array
|
8634
8550
|
# resp.contents[0].checksum_algorithm[0] #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256"
|
8635
8551
|
# resp.contents[0].size #=> Integer
|
8636
|
-
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
|
8552
|
+
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8637
8553
|
# resp.contents[0].owner.display_name #=> String
|
8638
8554
|
# resp.contents[0].owner.id #=> String
|
8639
8555
|
# resp.name #=> String
|
@@ -8716,14 +8632,14 @@ module Aws::S3
|
|
8716
8632
|
# name. For more information about access point ARNs, see [Using access
|
8717
8633
|
# points][1] in the *Amazon S3 User Guide*.
|
8718
8634
|
#
|
8719
|
-
# When
|
8635
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
8720
8636
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8721
8637
|
# takes the form `
|
8722
8638
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8723
|
-
# When
|
8724
|
-
# Services SDKs, you provide the Outposts
|
8725
|
-
#
|
8726
|
-
# [
|
8639
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
8640
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
8641
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
8642
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8727
8643
|
#
|
8728
8644
|
#
|
8729
8645
|
#
|
@@ -8887,7 +8803,7 @@ module Aws::S3
|
|
8887
8803
|
# resp.initiator.display_name #=> String
|
8888
8804
|
# resp.owner.display_name #=> String
|
8889
8805
|
# resp.owner.id #=> String
|
8890
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR"
|
8806
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8891
8807
|
# resp.request_charged #=> String, one of "requester"
|
8892
8808
|
# resp.checksum_algorithm #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256"
|
8893
8809
|
#
|
@@ -9114,7 +9030,7 @@ module Aws::S3
|
|
9114
9030
|
# * By Email address:
|
9115
9031
|
#
|
9116
9032
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
9117
|
-
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress
|
9033
|
+
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
9118
9034
|
#
|
9119
9035
|
# The grantee is resolved to the CanonicalUser and, in a response to a
|
9120
9036
|
# GET Object acl request, appears as the CanonicalUser.
|
@@ -9592,18 +9508,18 @@ module Aws::S3
|
|
9592
9508
|
end
|
9593
9509
|
|
9594
9510
|
# This action uses the `encryption` subresource to configure default
|
9595
|
-
# encryption and Amazon S3 Bucket
|
9596
|
-
#
|
9597
|
-
#
|
9598
|
-
#
|
9599
|
-
#
|
9600
|
-
#
|
9601
|
-
#
|
9602
|
-
#
|
9603
|
-
# information about
|
9604
|
-
# default encryption][1] in the *Amazon S3 User
|
9605
|
-
# information about S3 Bucket Keys, see [Amazon S3
|
9606
|
-
# the *Amazon S3 User Guide*.
|
9511
|
+
# encryption and Amazon S3 Bucket Key for an existing bucket.
|
9512
|
+
#
|
9513
|
+
# Default encryption for a bucket can use server-side encryption with
|
9514
|
+
# Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If
|
9515
|
+
# you specify default encryption using SSE-KMS, you can also configure
|
9516
|
+
# Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you
|
9517
|
+
# upload an object to the bucket and do not specify the KMS key to use
|
9518
|
+
# for encryption, Amazon S3 uses the default Amazon Web Services managed
|
9519
|
+
# KMS key for your account. For information about default encryption,
|
9520
|
+
# see [Amazon S3 default bucket encryption][1] in the *Amazon S3 User
|
9521
|
+
# Guide*. For more information about S3 Bucket Keys, see [Amazon S3
|
9522
|
+
# Bucket Keys][2] in the *Amazon S3 User Guide*.
|
9607
9523
|
#
|
9608
9524
|
# This action requires Amazon Web Services Signature Version 4. For more
|
9609
9525
|
# information, see [ Authenticating Requests (Amazon Web Services
|
@@ -9614,8 +9530,8 @@ module Aws::S3
|
|
9614
9530
|
# permission by default. The bucket owner can grant this permission to
|
9615
9531
|
# others. For more information about permissions, see [Permissions
|
9616
9532
|
# Related to Bucket Subresource Operations][4] and [Managing Access
|
9617
|
-
# Permissions to Your Amazon S3 Resources][5] in the
|
9618
|
-
# Guide
|
9533
|
+
# Permissions to Your Amazon S3 Resources][5] in the Amazon S3 User
|
9534
|
+
# Guide.
|
9619
9535
|
#
|
9620
9536
|
# **Related Resources**
|
9621
9537
|
#
|
@@ -9635,13 +9551,10 @@ module Aws::S3
|
|
9635
9551
|
#
|
9636
9552
|
# @option params [required, String] :bucket
|
9637
9553
|
# Specifies default encryption for a bucket using server-side encryption
|
9638
|
-
# with
|
9639
|
-
#
|
9640
|
-
#
|
9641
|
-
#
|
9642
|
-
# Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For
|
9643
|
-
# information about the bucket default encryption feature, see [Amazon
|
9644
|
-
# S3 Bucket Default Encryption][1] in the *Amazon S3 User Guide*.
|
9554
|
+
# with Amazon S3-managed keys (SSE-S3) or customer managed keys
|
9555
|
+
# (SSE-KMS). For information about the Amazon S3 default encryption
|
9556
|
+
# feature, see [Amazon S3 Default Bucket Encryption][1] in the *Amazon
|
9557
|
+
# S3 User Guide*.
|
9645
9558
|
#
|
9646
9559
|
#
|
9647
9560
|
#
|
@@ -9855,26 +9768,12 @@ module Aws::S3
|
|
9855
9768
|
# location. For an example policy, see [ Granting Permissions for Amazon
|
9856
9769
|
# S3 Inventory and Storage Class Analysis][2].
|
9857
9770
|
#
|
9858
|
-
#
|
9859
|
-
#
|
9860
|
-
# To use this operation, you must have permission to perform the
|
9771
|
+
# To use this operation, you must have permissions to perform the
|
9861
9772
|
# `s3:PutInventoryConfiguration` action. The bucket owner has this
|
9862
|
-
# permission by default and can grant this permission to others.
|
9863
|
-
#
|
9864
|
-
#
|
9865
|
-
#
|
9866
|
-
# available and to specify the destination bucket to store the
|
9867
|
-
# inventory. A user with read access to objects in the destination
|
9868
|
-
# bucket can also access all object metadata fields that are available
|
9869
|
-
# in the inventory report.
|
9870
|
-
#
|
9871
|
-
# To restrict access to an inventory report, see [Restricting access to
|
9872
|
-
# an Amazon S3 Inventory report][4] in the *Amazon S3 User Guide*. For
|
9873
|
-
# more information about the metadata fields available in S3 Inventory,
|
9874
|
-
# see [Amazon S3 Inventory lists][5] in the *Amazon S3 User Guide*. For
|
9875
|
-
# more information about permissions, see [Permissions related to bucket
|
9876
|
-
# subresource operations][6] and [Identity and access management in
|
9877
|
-
# Amazon S3][7] in the *Amazon S3 User Guide*.
|
9773
|
+
# permission by default and can grant this permission to others. For
|
9774
|
+
# more information about permissions, see [Permissions Related to Bucket
|
9775
|
+
# Subresource Operations][3] and [Managing Access Permissions to Your
|
9776
|
+
# Amazon S3 Resources][4] in the Amazon S3 User Guide.
|
9878
9777
|
#
|
9879
9778
|
# **Special Errors**
|
9880
9779
|
#
|
@@ -9901,24 +9800,21 @@ module Aws::S3
|
|
9901
9800
|
#
|
9902
9801
|
# **Related Resources**
|
9903
9802
|
#
|
9904
|
-
# * [GetBucketInventoryConfiguration][
|
9803
|
+
# * [GetBucketInventoryConfiguration][5]
|
9905
9804
|
#
|
9906
|
-
# * [DeleteBucketInventoryConfiguration][
|
9805
|
+
# * [DeleteBucketInventoryConfiguration][6]
|
9907
9806
|
#
|
9908
|
-
# * [ListBucketInventoryConfigurations][
|
9807
|
+
# * [ListBucketInventoryConfigurations][7]
|
9909
9808
|
#
|
9910
9809
|
#
|
9911
9810
|
#
|
9912
9811
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
9913
9812
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
9914
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
9915
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
9916
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9917
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9918
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9919
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
9920
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
9921
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
9813
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9814
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9815
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
9816
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
9817
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
9922
9818
|
#
|
9923
9819
|
# @option params [required, String] :bucket
|
9924
9820
|
# The name of the bucket where the inventory configuration will be
|
@@ -10563,9 +10459,7 @@ module Aws::S3
|
|
10563
10459
|
# The name of the bucket for which the metrics configuration is set.
|
10564
10460
|
#
|
10565
10461
|
# @option params [required, String] :id
|
10566
|
-
# The ID used to identify the metrics configuration.
|
10567
|
-
# character limit and can only contain letters, numbers, periods,
|
10568
|
-
# dashes, and underscores.
|
10462
|
+
# The ID used to identify the metrics configuration.
|
10569
10463
|
#
|
10570
10464
|
# @option params [required, Types::MetricsConfiguration] :metrics_configuration
|
10571
10465
|
# Specifies the metrics configuration.
|
@@ -11236,7 +11130,7 @@ module Aws::S3
|
|
11236
11130
|
# destination: { # required
|
11237
11131
|
# bucket: "BucketName", # required
|
11238
11132
|
# account: "AccountId",
|
11239
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
|
11133
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW
|
11240
11134
|
# access_control_translation: {
|
11241
11135
|
# owner: "Destination", # required, accepts Destination
|
11242
11136
|
# },
|
@@ -11840,18 +11734,14 @@ module Aws::S3
|
|
11840
11734
|
# Adds an object to a bucket. You must have WRITE permissions on a
|
11841
11735
|
# bucket to add an object to it.
|
11842
11736
|
#
|
11843
|
-
#
|
11844
|
-
# response, Amazon S3 added the entire object to the bucket.
|
11845
|
-
# use `PutObject` to only update a single piece of metadata for an
|
11846
|
-
# existing object. You must put the entire object with updated metadata
|
11847
|
-
# if you want to update some values.
|
11848
|
-
#
|
11849
|
-
# </note>
|
11737
|
+
# Amazon S3 never adds partial objects; if you receive a success
|
11738
|
+
# response, Amazon S3 added the entire object to the bucket.
|
11850
11739
|
#
|
11851
11740
|
# Amazon S3 is a distributed system. If it receives multiple write
|
11852
11741
|
# requests for the same object simultaneously, it overwrites all but the
|
11853
|
-
# last object written.
|
11854
|
-
#
|
11742
|
+
# last object written. Amazon S3 does not provide object locking; if you
|
11743
|
+
# need this, make sure to build it into your application layer or use
|
11744
|
+
# versioning instead.
|
11855
11745
|
#
|
11856
11746
|
# To ensure that data is not corrupted traversing the network, use the
|
11857
11747
|
# `Content-MD5` header. When you use this header, Amazon S3 checks the
|
@@ -11866,33 +11756,36 @@ module Aws::S3
|
|
11866
11756
|
# * To successfully change the objects acl of your `PutObject` request,
|
11867
11757
|
# you must have the `s3:PutObjectAcl` in your IAM permissions.
|
11868
11758
|
#
|
11869
|
-
# * To successfully set the tag-set with your `PutObject` request, you
|
11870
|
-
# must have the `s3:PutObjectTagging` in your IAM permissions.
|
11871
|
-
#
|
11872
11759
|
# * The `Content-MD5` header is required for any request to upload an
|
11873
11760
|
# object with a retention period configured using Amazon S3 Object
|
11874
11761
|
# Lock. For more information about Amazon S3 Object Lock, see [Amazon
|
11875
|
-
# S3 Object Lock Overview][
|
11762
|
+
# S3 Object Lock Overview][1] in the *Amazon S3 User Guide*.
|
11876
11763
|
#
|
11877
11764
|
# </note>
|
11878
11765
|
#
|
11879
|
-
#
|
11880
|
-
#
|
11881
|
-
#
|
11882
|
-
#
|
11883
|
-
#
|
11884
|
-
#
|
11885
|
-
#
|
11886
|
-
#
|
11887
|
-
#
|
11888
|
-
#
|
11889
|
-
#
|
11890
|
-
#
|
11891
|
-
#
|
11892
|
-
#
|
11893
|
-
#
|
11894
|
-
#
|
11895
|
-
#
|
11766
|
+
# **Server-side Encryption**
|
11767
|
+
#
|
11768
|
+
# You can optionally request server-side encryption. With server-side
|
11769
|
+
# encryption, Amazon S3 encrypts your data as it writes it to disks in
|
11770
|
+
# its data centers and decrypts the data when you access it. You have
|
11771
|
+
# the option to provide your own encryption key or use Amazon Web
|
11772
|
+
# Services managed encryption keys (SSE-S3 or SSE-KMS). For more
|
11773
|
+
# information, see [Using Server-Side Encryption][2].
|
11774
|
+
#
|
11775
|
+
# If you request server-side encryption using Amazon Web Services Key
|
11776
|
+
# Management Service (SSE-KMS), you can enable an S3 Bucket Key at the
|
11777
|
+
# object-level. For more information, see [Amazon S3 Bucket Keys][3] in
|
11778
|
+
# the *Amazon S3 User Guide*.
|
11779
|
+
#
|
11780
|
+
# **Access Control List (ACL)-Specific Request Headers**
|
11781
|
+
#
|
11782
|
+
# You can use headers to grant ACL- based permissions. By default, all
|
11783
|
+
# objects are private. Only the owner has full access control. When
|
11784
|
+
# adding a new object, you can grant permissions to individual Amazon
|
11785
|
+
# Web Services accounts or to predefined groups defined by Amazon S3.
|
11786
|
+
# These permissions are then added to the ACL on the object. For more
|
11787
|
+
# information, see [Access Control List (ACL) Overview][4] and [Managing
|
11788
|
+
# ACLs Using the REST API][5].
|
11896
11789
|
#
|
11897
11790
|
# If the bucket that you're uploading objects to uses the bucket owner
|
11898
11791
|
# enforced setting for S3 Object Ownership, ACLs are disabled and no
|
@@ -11903,9 +11796,10 @@ module Aws::S3
|
|
11903
11796
|
# ACL expressed in the XML format. PUT requests that contain other ACLs
|
11904
11797
|
# (for example, custom grants to certain Amazon Web Services accounts)
|
11905
11798
|
# fail and return a `400` error with the error code
|
11906
|
-
# `AccessControlListNotSupported`.
|
11907
|
-
#
|
11908
|
-
#
|
11799
|
+
# `AccessControlListNotSupported`.
|
11800
|
+
#
|
11801
|
+
# For more information, see [ Controlling ownership of objects and
|
11802
|
+
# disabling ACLs][6] in the *Amazon S3 User Guide*.
|
11909
11803
|
#
|
11910
11804
|
# <note markdown="1"> If your bucket uses the bucket owner enforced setting for Object
|
11911
11805
|
# Ownership, all objects written to the bucket by any account will be
|
@@ -11913,6 +11807,8 @@ module Aws::S3
|
|
11913
11807
|
#
|
11914
11808
|
# </note>
|
11915
11809
|
#
|
11810
|
+
# **Storage Class Options**
|
11811
|
+
#
|
11916
11812
|
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
11917
11813
|
# created objects. The STANDARD storage class provides high durability
|
11918
11814
|
# and high availability. Depending on performance needs, you can specify
|
@@ -11920,16 +11816,19 @@ module Aws::S3
|
|
11920
11816
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][7]
|
11921
11817
|
# in the *Amazon S3 User Guide*.
|
11922
11818
|
#
|
11819
|
+
# **Versioning**
|
11820
|
+
#
|
11923
11821
|
# If you enable versioning for a bucket, Amazon S3 automatically
|
11924
11822
|
# generates a unique version ID for the object being stored. Amazon S3
|
11925
11823
|
# returns this ID in the response. When you enable versioning for a
|
11926
11824
|
# bucket, if Amazon S3 receives multiple write requests for the same
|
11927
|
-
# object simultaneously, it stores all of the objects.
|
11928
|
-
# information about versioning, see [Adding Objects to Versioning
|
11929
|
-
# Enabled Buckets][8]. For information about returning the versioning
|
11930
|
-
# state of a bucket, see [GetBucketVersioning][9].
|
11825
|
+
# object simultaneously, it stores all of the objects.
|
11931
11826
|
#
|
11932
|
-
# For more information about
|
11827
|
+
# For more information about versioning, see [Adding Objects to
|
11828
|
+
# Versioning Enabled Buckets][8]. For information about returning the
|
11829
|
+
# versioning state of a bucket, see [GetBucketVersioning][9].
|
11830
|
+
#
|
11831
|
+
# **Related Resources**
|
11933
11832
|
#
|
11934
11833
|
# * [CopyObject][10]
|
11935
11834
|
#
|
@@ -11937,9 +11836,9 @@ module Aws::S3
|
|
11937
11836
|
#
|
11938
11837
|
#
|
11939
11838
|
#
|
11940
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11941
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11942
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11839
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html
|
11840
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
|
11841
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
11943
11842
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
11944
11843
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
11945
11844
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
@@ -11973,14 +11872,14 @@ module Aws::S3
|
|
11973
11872
|
# name. For more information about access point ARNs, see [Using access
|
11974
11873
|
# points][1] in the *Amazon S3 User Guide*.
|
11975
11874
|
#
|
11976
|
-
# When
|
11875
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11977
11876
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11978
11877
|
# takes the form `
|
11979
11878
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
11980
|
-
# When
|
11981
|
-
# Services SDKs, you provide the Outposts
|
11982
|
-
#
|
11983
|
-
# [
|
11879
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
11880
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
11881
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
11882
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
11984
11883
|
#
|
11985
11884
|
#
|
11986
11885
|
#
|
@@ -11999,21 +11898,21 @@ module Aws::S3
|
|
11999
11898
|
# @option params [String] :content_disposition
|
12000
11899
|
# Specifies presentational information for the object. For more
|
12001
11900
|
# information, see
|
12002
|
-
# [
|
11901
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1][1].
|
12003
11902
|
#
|
12004
11903
|
#
|
12005
11904
|
#
|
12006
|
-
# [1]:
|
11905
|
+
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
|
12007
11906
|
#
|
12008
11907
|
# @option params [String] :content_encoding
|
12009
11908
|
# Specifies what content encodings have been applied to the object and
|
12010
11909
|
# thus what decoding mechanisms must be applied to obtain the media-type
|
12011
11910
|
# referenced by the Content-Type header field. For more information, see
|
12012
|
-
# [
|
11911
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11][1].
|
12013
11912
|
#
|
12014
11913
|
#
|
12015
11914
|
#
|
12016
|
-
# [1]:
|
11915
|
+
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
|
12017
11916
|
#
|
12018
11917
|
# @option params [String] :content_language
|
12019
11918
|
# The language the content is in.
|
@@ -12021,11 +11920,11 @@ module Aws::S3
|
|
12021
11920
|
# @option params [Integer] :content_length
|
12022
11921
|
# Size of the body in bytes. This parameter is useful when the size of
|
12023
11922
|
# the body cannot be determined automatically. For more information, see
|
12024
|
-
# [
|
11923
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13][1].
|
12025
11924
|
#
|
12026
11925
|
#
|
12027
11926
|
#
|
12028
|
-
# [1]:
|
11927
|
+
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
|
12029
11928
|
#
|
12030
11929
|
# @option params [String] :content_md5
|
12031
11930
|
# The base64-encoded 128-bit MD5 digest of the message (without the
|
@@ -12043,11 +11942,11 @@ module Aws::S3
|
|
12043
11942
|
# @option params [String] :content_type
|
12044
11943
|
# A standard MIME type describing the format of the contents. For more
|
12045
11944
|
# information, see
|
12046
|
-
# [
|
11945
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17][1].
|
12047
11946
|
#
|
12048
11947
|
#
|
12049
11948
|
#
|
12050
|
-
# [1]:
|
11949
|
+
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
|
12051
11950
|
#
|
12052
11951
|
# @option params [String] :checksum_algorithm
|
12053
11952
|
# Indicates the algorithm used to create the checksum for the object
|
@@ -12112,11 +12011,11 @@ module Aws::S3
|
|
12112
12011
|
# @option params [Time,DateTime,Date,Integer,String] :expires
|
12113
12012
|
# The date and time at which the object is no longer cacheable. For more
|
12114
12013
|
# information, see
|
12115
|
-
# [
|
12014
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21][1].
|
12116
12015
|
#
|
12117
12016
|
#
|
12118
12017
|
#
|
12119
|
-
# [1]:
|
12018
|
+
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21
|
12120
12019
|
#
|
12121
12020
|
# @option params [String] :grant_full_control
|
12122
12021
|
# Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
|
@@ -12147,7 +12046,7 @@ module Aws::S3
|
|
12147
12046
|
#
|
12148
12047
|
# @option params [String] :server_side_encryption
|
12149
12048
|
# The server-side encryption algorithm used when storing this object in
|
12150
|
-
# Amazon S3 (for example, AES256,
|
12049
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
12151
12050
|
#
|
12152
12051
|
# @option params [String] :storage_class
|
12153
12052
|
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
@@ -12204,9 +12103,9 @@ module Aws::S3
|
|
12204
12103
|
# ensure that the encryption key was transmitted without error.
|
12205
12104
|
#
|
12206
12105
|
# @option params [String] :ssekms_key_id
|
12207
|
-
# If `x-amz-server-side-encryption` has
|
12208
|
-
# header specifies the ID of the Amazon Web Services Key
|
12209
|
-
# Service (Amazon Web Services KMS)
|
12106
|
+
# If `x-amz-server-side-encryption` is present and has the value of
|
12107
|
+
# `aws:kms`, this header specifies the ID of the Amazon Web Services Key
|
12108
|
+
# Management Service (Amazon Web Services KMS) symmetrical customer
|
12210
12109
|
# managed key that was used for the object. If you specify
|
12211
12110
|
# `x-amz-server-side-encryption:aws:kms`, but do not provide`
|
12212
12111
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
@@ -12217,10 +12116,7 @@ module Aws::S3
|
|
12217
12116
|
# @option params [String] :ssekms_encryption_context
|
12218
12117
|
# Specifies the Amazon Web Services KMS Encryption Context to use for
|
12219
12118
|
# object encryption. The value of this header is a base64-encoded UTF-8
|
12220
|
-
# string holding JSON with the encryption context key-value pairs.
|
12221
|
-
# value is stored as object metadata and automatically gets passed on to
|
12222
|
-
# Amazon Web Services KMS for future `GetObject` or `CopyObject`
|
12223
|
-
# operations on this object.
|
12119
|
+
# string holding JSON with the encryption context key-value pairs.
|
12224
12120
|
#
|
12225
12121
|
# @option params [Boolean] :bucket_key_enabled
|
12226
12122
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
@@ -12284,27 +12180,6 @@ module Aws::S3
|
|
12284
12180
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
12285
12181
|
#
|
12286
12182
|
#
|
12287
|
-
# @example Example: To upload object and specify user-defined metadata
|
12288
|
-
#
|
12289
|
-
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
12290
|
-
# # enabled, S3 returns version ID in response.
|
12291
|
-
#
|
12292
|
-
# resp = client.put_object({
|
12293
|
-
# body: "filetoupload",
|
12294
|
-
# bucket: "examplebucket",
|
12295
|
-
# key: "exampleobject",
|
12296
|
-
# metadata: {
|
12297
|
-
# "metadata1" => "value1",
|
12298
|
-
# "metadata2" => "value2",
|
12299
|
-
# },
|
12300
|
-
# })
|
12301
|
-
#
|
12302
|
-
# resp.to_h outputs the following:
|
12303
|
-
# {
|
12304
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12305
|
-
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
12306
|
-
# }
|
12307
|
-
#
|
12308
12183
|
# @example Example: To upload an object and specify optional tags
|
12309
12184
|
#
|
12310
12185
|
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
@@ -12323,55 +12198,62 @@ module Aws::S3
|
|
12323
12198
|
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
12324
12199
|
# }
|
12325
12200
|
#
|
12326
|
-
# @example Example: To upload an object
|
12201
|
+
# @example Example: To upload an object
|
12327
12202
|
#
|
12328
|
-
# # The following example uploads
|
12329
|
-
# #
|
12203
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
12204
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
12330
12205
|
#
|
12331
12206
|
# resp = client.put_object({
|
12332
|
-
#
|
12333
|
-
# body: "filetoupload",
|
12207
|
+
# body: "HappyFace.jpg",
|
12334
12208
|
# bucket: "examplebucket",
|
12335
|
-
# key: "
|
12209
|
+
# key: "HappyFace.jpg",
|
12336
12210
|
# })
|
12337
12211
|
#
|
12338
12212
|
# resp.to_h outputs the following:
|
12339
12213
|
# {
|
12340
12214
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12341
|
-
# version_id: "
|
12215
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
12342
12216
|
# }
|
12343
12217
|
#
|
12344
|
-
# @example Example: To
|
12218
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
12345
12219
|
#
|
12346
|
-
# # The following example
|
12220
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
12221
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
12347
12222
|
#
|
12348
12223
|
# resp = client.put_object({
|
12349
12224
|
# body: "filetoupload",
|
12350
12225
|
# bucket: "examplebucket",
|
12351
|
-
# key: "
|
12226
|
+
# key: "exampleobject",
|
12227
|
+
# server_side_encryption: "AES256",
|
12228
|
+
# tagging: "key1=value1&key2=value2",
|
12352
12229
|
# })
|
12353
12230
|
#
|
12354
12231
|
# resp.to_h outputs the following:
|
12355
12232
|
# {
|
12356
12233
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12357
|
-
#
|
12234
|
+
# server_side_encryption: "AES256",
|
12235
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
12358
12236
|
# }
|
12359
12237
|
#
|
12360
|
-
# @example Example: To upload
|
12238
|
+
# @example Example: To upload object and specify user-defined metadata
|
12361
12239
|
#
|
12362
|
-
# # The following example
|
12363
|
-
# #
|
12240
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
12241
|
+
# # enabled, S3 returns version ID in response.
|
12364
12242
|
#
|
12365
12243
|
# resp = client.put_object({
|
12366
|
-
# body: "
|
12244
|
+
# body: "filetoupload",
|
12367
12245
|
# bucket: "examplebucket",
|
12368
|
-
# key: "
|
12246
|
+
# key: "exampleobject",
|
12247
|
+
# metadata: {
|
12248
|
+
# "metadata1" => "value1",
|
12249
|
+
# "metadata2" => "value2",
|
12250
|
+
# },
|
12369
12251
|
# })
|
12370
12252
|
#
|
12371
12253
|
# resp.to_h outputs the following:
|
12372
12254
|
# {
|
12373
12255
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12374
|
-
# version_id: "
|
12256
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
12375
12257
|
# }
|
12376
12258
|
#
|
12377
12259
|
# @example Example: To upload an object (specify optional headers)
|
@@ -12394,24 +12276,38 @@ module Aws::S3
|
|
12394
12276
|
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
12395
12277
|
# }
|
12396
12278
|
#
|
12397
|
-
# @example Example: To upload an object and specify
|
12279
|
+
# @example Example: To upload an object and specify canned ACL.
|
12398
12280
|
#
|
12399
|
-
# # The following example uploads
|
12400
|
-
# #
|
12281
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
12282
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
12401
12283
|
#
|
12402
12284
|
# resp = client.put_object({
|
12285
|
+
# acl: "authenticated-read",
|
12403
12286
|
# body: "filetoupload",
|
12404
12287
|
# bucket: "examplebucket",
|
12405
12288
|
# key: "exampleobject",
|
12406
|
-
# server_side_encryption: "AES256",
|
12407
|
-
# tagging: "key1=value1&key2=value2",
|
12408
12289
|
# })
|
12409
12290
|
#
|
12410
12291
|
# resp.to_h outputs the following:
|
12411
12292
|
# {
|
12412
12293
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12413
|
-
#
|
12414
|
-
#
|
12294
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
12295
|
+
# }
|
12296
|
+
#
|
12297
|
+
# @example Example: To create an object.
|
12298
|
+
#
|
12299
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
12300
|
+
#
|
12301
|
+
# resp = client.put_object({
|
12302
|
+
# body: "filetoupload",
|
12303
|
+
# bucket: "examplebucket",
|
12304
|
+
# key: "objectkey",
|
12305
|
+
# })
|
12306
|
+
#
|
12307
|
+
# resp.to_h outputs the following:
|
12308
|
+
# {
|
12309
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12310
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
12415
12311
|
# }
|
12416
12312
|
#
|
12417
12313
|
# @example Streaming a file from disk
|
@@ -12448,7 +12344,7 @@ module Aws::S3
|
|
12448
12344
|
# "MetadataKey" => "MetadataValue",
|
12449
12345
|
# },
|
12450
12346
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
12451
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
|
12347
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW
|
12452
12348
|
# website_redirect_location: "WebsiteRedirectLocation",
|
12453
12349
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
12454
12350
|
# sse_customer_key: "SSECustomerKey",
|
@@ -12749,14 +12645,14 @@ module Aws::S3
|
|
12749
12645
|
# name. For more information about access point ARNs, see [Using access
|
12750
12646
|
# points][1] in the *Amazon S3 User Guide*.
|
12751
12647
|
#
|
12752
|
-
# When
|
12648
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
12753
12649
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12754
12650
|
# takes the form `
|
12755
12651
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
12756
|
-
# When
|
12757
|
-
# Services SDKs, you provide the Outposts
|
12758
|
-
#
|
12759
|
-
# [
|
12652
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
12653
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
12654
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
12655
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
12760
12656
|
#
|
12761
12657
|
#
|
12762
12658
|
#
|
@@ -13253,14 +13149,14 @@ module Aws::S3
|
|
13253
13149
|
# name. For more information about access point ARNs, see [Using access
|
13254
13150
|
# points][1] in the *Amazon S3 User Guide*.
|
13255
13151
|
#
|
13256
|
-
# When
|
13152
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13257
13153
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13258
13154
|
# takes the form `
|
13259
13155
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
13260
|
-
# When
|
13261
|
-
# Services SDKs, you provide the Outposts
|
13262
|
-
#
|
13263
|
-
# [
|
13156
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
13157
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
13158
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
13159
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13264
13160
|
#
|
13265
13161
|
#
|
13266
13162
|
#
|
@@ -13500,14 +13396,35 @@ module Aws::S3
|
|
13500
13396
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
13501
13397
|
# Resources][2] in the *Amazon S3 User Guide*.
|
13502
13398
|
#
|
13503
|
-
#
|
13504
|
-
#
|
13399
|
+
# **Querying Archives with Select Requests**
|
13400
|
+
#
|
13401
|
+
# You use a select type of request to perform SQL queries on archived
|
13402
|
+
# objects. The archived objects that are being queried by the select
|
13403
|
+
# request must be formatted as uncompressed comma-separated values (CSV)
|
13404
|
+
# files. You can run queries and custom analytics on your archived data
|
13405
|
+
# without having to restore your data to a hotter Amazon S3 tier. For an
|
13406
|
+
# overview about select requests, see [Querying Archived Objects][3] in
|
13407
|
+
# the *Amazon S3 User Guide*.
|
13408
|
+
#
|
13409
|
+
# When making a select request, do the following:
|
13505
13410
|
#
|
13506
|
-
# *
|
13411
|
+
# * Define an output location for the select query's output. This must
|
13412
|
+
# be an Amazon S3 bucket in the same Amazon Web Services Region as the
|
13413
|
+
# bucket that contains the archive object that is being queried. The
|
13414
|
+
# Amazon Web Services account that initiates the job must have
|
13415
|
+
# permissions to write to the S3 bucket. You can specify the storage
|
13416
|
+
# class and encryption for the output objects stored in the bucket.
|
13417
|
+
# For more information about output, see [Querying Archived
|
13418
|
+
# Objects][3] in the *Amazon S3 User Guide*.
|
13507
13419
|
#
|
13508
|
-
#
|
13420
|
+
# For more information about the `S3` structure in the request body,
|
13421
|
+
# see the following:
|
13509
13422
|
#
|
13510
|
-
# * [
|
13423
|
+
# * [PutObject][4]
|
13424
|
+
#
|
13425
|
+
# * [Managing Access with ACLs][5] in the *Amazon S3 User Guide*
|
13426
|
+
#
|
13427
|
+
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
13511
13428
|
# S3 User Guide*
|
13512
13429
|
#
|
13513
13430
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
@@ -13532,6 +13449,10 @@ module Aws::S3
|
|
13532
13449
|
#
|
13533
13450
|
# `SELECT s.Id, s.FirstName, s.SSN FROM S3Object s`
|
13534
13451
|
#
|
13452
|
+
# For more information about using SQL with S3 Glacier Select restore,
|
13453
|
+
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
13454
|
+
# the *Amazon S3 User Guide*.
|
13455
|
+
#
|
13535
13456
|
# When making a select request, you can also do the following:
|
13536
13457
|
#
|
13537
13458
|
# * To expedite your queries, specify the `Expedited` tier. For more
|
@@ -13549,7 +13470,7 @@ module Aws::S3
|
|
13549
13470
|
# through a lifecycle policy.
|
13550
13471
|
#
|
13551
13472
|
# * You can issue more than one select request on the same Amazon S3
|
13552
|
-
# object. Amazon S3 doesn't
|
13473
|
+
# object. Amazon S3 doesn't deduplicate requests, so avoid issuing
|
13553
13474
|
# duplicate requests.
|
13554
13475
|
#
|
13555
13476
|
# * Amazon S3 accepts a select request even if the object has already
|
@@ -13557,30 +13478,27 @@ module Aws::S3
|
|
13557
13478
|
#
|
13558
13479
|
# **Restoring objects**
|
13559
13480
|
#
|
13560
|
-
# Objects that you archive to the S3 Glacier
|
13561
|
-
#
|
13562
|
-
#
|
13563
|
-
#
|
13564
|
-
# Glacier Deep Archive storage classes, you must first initiate a
|
13565
|
-
# restore request, and then wait until a temporary copy of the object is
|
13566
|
-
# available. If you want a permanent copy of the object, create a copy
|
13567
|
-
# of it in the Amazon S3 Standard storage class in your S3 bucket. To
|
13568
|
-
# access an archived object, you must restore the object for the
|
13569
|
-
# duration (number of days) that you specify. For objects in the Archive
|
13570
|
-
# Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you
|
13481
|
+
# Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive
|
13482
|
+
# storage class, and S3 Intelligent-Tiering Archive or S3
|
13483
|
+
# Intelligent-Tiering Deep Archive tiers are not accessible in real
|
13484
|
+
# time. For objects in Archive Access or Deep Archive Access tiers you
|
13571
13485
|
# must first initiate a restore request, and then wait until the object
|
13572
|
-
# is moved into the Frequent Access tier.
|
13486
|
+
# is moved into the Frequent Access tier. For objects in S3 Glacier or
|
13487
|
+
# S3 Glacier Deep Archive storage classes you must first initiate a
|
13488
|
+
# restore request, and then wait until a temporary copy of the object is
|
13489
|
+
# available. To access an archived object, you must restore the object
|
13490
|
+
# for the duration (number of days) that you specify.
|
13573
13491
|
#
|
13574
13492
|
# To restore a specific object version, you can provide a version ID. If
|
13575
13493
|
# you don't provide a version ID, Amazon S3 restores the current
|
13576
13494
|
# version.
|
13577
13495
|
#
|
13578
|
-
# When restoring an archived object
|
13579
|
-
# following data access tier options in the `Tier`
|
13580
|
-
# request body:
|
13496
|
+
# When restoring an archived object (or using a select request), you can
|
13497
|
+
# specify one of the following data access tier options in the `Tier`
|
13498
|
+
# element of the request body:
|
13581
13499
|
#
|
13582
13500
|
# * `Expedited` - Expedited retrievals allow you to quickly access your
|
13583
|
-
# data stored in the S3 Glacier
|
13501
|
+
# data stored in the S3 Glacier storage class or S3
|
13584
13502
|
# Intelligent-Tiering Archive tier when occasional urgent requests for
|
13585
13503
|
# a subset of archives are required. For all but the largest archived
|
13586
13504
|
# objects (250 MB+), data accessed using Expedited retrievals is
|
@@ -13594,30 +13512,28 @@ module Aws::S3
|
|
13594
13512
|
# archived objects within several hours. This is the default option
|
13595
13513
|
# for retrieval requests that do not specify the retrieval option.
|
13596
13514
|
# Standard retrievals typically finish within 3–5 hours for objects
|
13597
|
-
# stored in the S3 Glacier
|
13598
|
-
#
|
13599
|
-
# hours for objects stored in the S3 Glacier Deep Archive storage
|
13600
|
-
# class or S3 Intelligent-Tiering Deep Archive tier. Standard
|
13601
|
-
# retrievals are free for objects stored in S3 Intelligent-Tiering.
|
13602
|
-
#
|
13603
|
-
# * `Bulk` - Bulk retrievals free for objects stored in the S3 Glacier
|
13604
|
-
# Flexible Retrieval and S3 Intelligent-Tiering storage classes,
|
13605
|
-
# enabling you to retrieve large amounts, even petabytes, of data at
|
13606
|
-
# no cost. Bulk retrievals typically finish within 5–12 hours for
|
13607
|
-
# objects stored in the S3 Glacier Flexible Retrieval storage class or
|
13608
|
-
# S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the
|
13609
|
-
# lowest-cost retrieval option when restoring objects from S3 Glacier
|
13610
|
-
# Deep Archive. They typically finish within 48 hours for objects
|
13515
|
+
# stored in the S3 Glacier storage class or S3 Intelligent-Tiering
|
13516
|
+
# Archive tier. They typically finish within 12 hours for objects
|
13611
13517
|
# stored in the S3 Glacier Deep Archive storage class or S3
|
13612
|
-
# Intelligent-Tiering Deep Archive tier.
|
13518
|
+
# Intelligent-Tiering Deep Archive tier. Standard retrievals are free
|
13519
|
+
# for objects stored in S3 Intelligent-Tiering.
|
13520
|
+
#
|
13521
|
+
# * `Bulk` - Bulk retrievals are the lowest-cost retrieval option in S3
|
13522
|
+
# Glacier, enabling you to retrieve large amounts, even petabytes, of
|
13523
|
+
# data inexpensively. Bulk retrievals typically finish within 5–12
|
13524
|
+
# hours for objects stored in the S3 Glacier storage class or S3
|
13525
|
+
# Intelligent-Tiering Archive tier. They typically finish within 48
|
13526
|
+
# hours for objects stored in the S3 Glacier Deep Archive storage
|
13527
|
+
# class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals
|
13528
|
+
# are free for objects stored in S3 Intelligent-Tiering.
|
13613
13529
|
#
|
13614
13530
|
# For more information about archive retrieval options and provisioned
|
13615
13531
|
# capacity for `Expedited` data access, see [Restoring Archived
|
13616
|
-
# Objects][
|
13532
|
+
# Objects][8] in the *Amazon S3 User Guide*.
|
13617
13533
|
#
|
13618
13534
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
13619
13535
|
# speed to a faster speed while it is in progress. For more information,
|
13620
|
-
# see [ Upgrading the speed of an in-progress restore][
|
13536
|
+
# see [ Upgrading the speed of an in-progress restore][9] in the *Amazon
|
13621
13537
|
# S3 User Guide*.
|
13622
13538
|
#
|
13623
13539
|
# To get the status of object restoration, you can send a `HEAD`
|
@@ -13625,7 +13541,7 @@ module Aws::S3
|
|
13625
13541
|
# information about the restoration status, in the response. You can use
|
13626
13542
|
# Amazon S3 event notifications to notify you when a restore is
|
13627
13543
|
# initiated or completed. For more information, see [Configuring Amazon
|
13628
|
-
# S3 Event Notifications][
|
13544
|
+
# S3 Event Notifications][10] in the *Amazon S3 User Guide*.
|
13629
13545
|
#
|
13630
13546
|
# After restoring an archived object, you can update the restoration
|
13631
13547
|
# period by reissuing the request with a new period. Amazon S3 updates
|
@@ -13640,8 +13556,8 @@ module Aws::S3
|
|
13640
13556
|
# object copy for 10 days, but the object is scheduled to expire in 3
|
13641
13557
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
13642
13558
|
# about lifecycle configuration, see
|
13643
|
-
# [PutBucketLifecycleConfiguration][
|
13644
|
-
# Management][
|
13559
|
+
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
13560
|
+
# Management][12] in *Amazon S3 User Guide*.
|
13645
13561
|
#
|
13646
13562
|
# **Responses**
|
13647
13563
|
#
|
@@ -13678,23 +13594,28 @@ module Aws::S3
|
|
13678
13594
|
#
|
13679
13595
|
# **Related Resources**
|
13680
13596
|
#
|
13681
|
-
# * [PutBucketLifecycleConfiguration][
|
13597
|
+
# * [PutBucketLifecycleConfiguration][11]
|
13682
13598
|
#
|
13683
|
-
# * [GetBucketNotificationConfiguration][
|
13599
|
+
# * [GetBucketNotificationConfiguration][13]
|
13600
|
+
#
|
13601
|
+
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
13602
|
+
# the *Amazon S3 User Guide*
|
13684
13603
|
#
|
13685
13604
|
#
|
13686
13605
|
#
|
13687
13606
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
13688
13607
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
13689
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13690
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13691
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
13692
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
13693
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
13694
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
13695
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13696
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
13697
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
13608
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
|
13609
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
13610
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
13611
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
13612
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html
|
13613
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html
|
13614
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html
|
13615
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
|
13616
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
13617
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
13618
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html
|
13698
13619
|
#
|
13699
13620
|
# @option params [required, String] :bucket
|
13700
13621
|
# The bucket name containing the object to restore.
|
@@ -13707,14 +13628,14 @@ module Aws::S3
|
|
13707
13628
|
# name. For more information about access point ARNs, see [Using access
|
13708
13629
|
# points][1] in the *Amazon S3 User Guide*.
|
13709
13630
|
#
|
13710
|
-
# When
|
13631
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13711
13632
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13712
13633
|
# takes the form `
|
13713
13634
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
13714
|
-
# When
|
13715
|
-
# Services SDKs, you provide the Outposts
|
13716
|
-
#
|
13717
|
-
# [
|
13635
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
13636
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
13637
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
13638
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13718
13639
|
#
|
13719
13640
|
#
|
13720
13641
|
#
|
@@ -13870,7 +13791,7 @@ module Aws::S3
|
|
13870
13791
|
# value: "MetadataValue",
|
13871
13792
|
# },
|
13872
13793
|
# ],
|
13873
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
|
13794
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW
|
13874
13795
|
# },
|
13875
13796
|
# },
|
13876
13797
|
# },
|
@@ -13907,13 +13828,17 @@ module Aws::S3
|
|
13907
13828
|
# from Objects][1] and [SELECT Command][2] in the *Amazon S3 User
|
13908
13829
|
# Guide*.
|
13909
13830
|
#
|
13831
|
+
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
13832
|
+
# Reference for Amazon S3 Select and S3 Glacier Select][3] in the
|
13833
|
+
# *Amazon S3 User Guide*.
|
13834
|
+
#
|
13910
13835
|
#
|
13911
13836
|
#
|
13912
13837
|
# **Permissions**
|
13913
13838
|
#
|
13914
13839
|
# You must have `s3:GetObject` permission for this operation. Amazon S3
|
13915
13840
|
# Select does not support anonymous access. For more information about
|
13916
|
-
# permissions, see [Specifying Permissions in a Policy][
|
13841
|
+
# permissions, see [Specifying Permissions in a Policy][4] in the
|
13917
13842
|
# *Amazon S3 User Guide*.
|
13918
13843
|
#
|
13919
13844
|
#
|
@@ -13940,70 +13865,71 @@ module Aws::S3
|
|
13940
13865
|
#
|
13941
13866
|
# For objects that are encrypted with customer-provided encryption
|
13942
13867
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
13943
|
-
# are documented in the [GetObject][
|
13868
|
+
# are documented in the [GetObject][5]. For more information about
|
13944
13869
|
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
13945
|
-
# Encryption Keys)][
|
13870
|
+
# Encryption Keys)][6] in the *Amazon S3 User Guide*.
|
13946
13871
|
#
|
13947
|
-
# For objects that are encrypted with Amazon S3 managed
|
13948
|
-
# and Amazon Web Services KMS keys (SSE-KMS),
|
13949
|
-
# is handled transparently, so you don't need
|
13950
|
-
# For more information about server-side
|
13951
|
-
# and SSE-KMS, see [Protecting Data Using
|
13952
|
-
# in the *Amazon S3 User Guide*.
|
13872
|
+
# For objects that are encrypted with Amazon S3 managed encryption
|
13873
|
+
# keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS),
|
13874
|
+
# server-side encryption is handled transparently, so you don't need
|
13875
|
+
# to specify anything. For more information about server-side
|
13876
|
+
# encryption, including SSE-S3 and SSE-KMS, see [Protecting Data Using
|
13877
|
+
# Server-Side Encryption][7] in the *Amazon S3 User Guide*.
|
13953
13878
|
#
|
13954
13879
|
# **Working with the Response Body**
|
13955
13880
|
#
|
13956
13881
|
# Given the response size is unknown, Amazon S3 Select streams the
|
13957
13882
|
# response as a series of messages and includes a `Transfer-Encoding`
|
13958
13883
|
# header with `chunked` as its value in the response. For more
|
13959
|
-
# information, see [Appendix: SelectObjectContent Response][
|
13884
|
+
# information, see [Appendix: SelectObjectContent Response][8].
|
13960
13885
|
#
|
13961
13886
|
#
|
13962
13887
|
#
|
13963
13888
|
# **GetObject Support**
|
13964
13889
|
#
|
13965
13890
|
# The `SelectObjectContent` action does not support the following
|
13966
|
-
# `GetObject` functionality. For more information, see [GetObject][
|
13891
|
+
# `GetObject` functionality. For more information, see [GetObject][5].
|
13967
13892
|
#
|
13968
13893
|
# * `Range`: Although you can specify a scan range for an Amazon S3
|
13969
|
-
# Select request (see [SelectObjectContentRequest - ScanRange][
|
13894
|
+
# Select request (see [SelectObjectContentRequest - ScanRange][9] in
|
13970
13895
|
# the request parameters), you cannot specify the range of bytes of an
|
13971
13896
|
# object to return.
|
13972
13897
|
#
|
13973
13898
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
13974
13899
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
13975
13900
|
# storage classes. For more information, about storage classes see
|
13976
|
-
# [Storage Classes][
|
13901
|
+
# [Storage Classes][10] in the *Amazon S3 User Guide*.
|
13977
13902
|
#
|
13978
13903
|
#
|
13979
13904
|
#
|
13980
13905
|
# **Special Errors**
|
13981
13906
|
#
|
13982
13907
|
# For a list of special errors for this operation, see [List of SELECT
|
13983
|
-
# Object Content Error Codes][
|
13908
|
+
# Object Content Error Codes][11]
|
13984
13909
|
#
|
13985
13910
|
# **Related Resources**
|
13986
13911
|
#
|
13987
|
-
# * [GetObject][
|
13912
|
+
# * [GetObject][5]
|
13988
13913
|
#
|
13989
|
-
# * [GetBucketLifecycleConfiguration][
|
13914
|
+
# * [GetBucketLifecycleConfiguration][12]
|
13990
13915
|
#
|
13991
|
-
# * [PutBucketLifecycleConfiguration][
|
13916
|
+
# * [PutBucketLifecycleConfiguration][13]
|
13992
13917
|
#
|
13993
13918
|
#
|
13994
13919
|
#
|
13995
13920
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html
|
13996
13921
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html
|
13997
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
13998
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13999
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14000
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
14001
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14002
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
14003
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14004
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14005
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
14006
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
13922
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html
|
13923
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
13924
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
13925
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
13926
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
13927
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html
|
13928
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange
|
13929
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro
|
13930
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList
|
13931
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
13932
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
14007
13933
|
#
|
14008
13934
|
# @option params [required, String] :bucket
|
14009
13935
|
# The S3 bucket.
|
@@ -14353,35 +14279,27 @@ module Aws::S3
|
|
14353
14279
|
# upload API, go to [Multipart Upload and Permissions][6] in the *Amazon
|
14354
14280
|
# S3 User Guide*.
|
14355
14281
|
#
|
14356
|
-
#
|
14282
|
+
# You can optionally request server-side encryption where Amazon S3
|
14357
14283
|
# encrypts your data as it writes it to disks in its data centers and
|
14358
|
-
# decrypts it when you access it. You have
|
14359
|
-
#
|
14360
|
-
#
|
14361
|
-
# Specifically, the encryption key options are Amazon S3 managed keys
|
14362
|
-
# (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and
|
14363
|
-
# Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with
|
14364
|
-
# server-side encryption using Amazon S3 managed keys (SSE-S3) by
|
14365
|
-
# default. You can optionally tell Amazon S3 to encrypt data at rest
|
14366
|
-
# using server-side encryption with other key options. The option you
|
14367
|
-
# use depends on whether you want to use KMS keys (SSE-KMS) or provide
|
14368
|
-
# your own encryption key (SSE-C). If you choose to provide your own
|
14284
|
+
# decrypts it for you when you access it. You have the option of
|
14285
|
+
# providing your own encryption key, or you can use the Amazon Web
|
14286
|
+
# Services managed encryption keys. If you choose to provide your own
|
14369
14287
|
# encryption key, the request headers you provide in the request must
|
14370
14288
|
# match the headers you used in the request to initiate the upload by
|
14371
14289
|
# using [CreateMultipartUpload][2]. For more information, go to [Using
|
14372
14290
|
# Server-Side Encryption][7] in the *Amazon S3 User Guide*.
|
14373
14291
|
#
|
14374
14292
|
# Server-side encryption is supported by the S3 Multipart Upload
|
14375
|
-
# actions. Unless you are using a customer-provided encryption key
|
14376
|
-
#
|
14377
|
-
#
|
14378
|
-
#
|
14379
|
-
#
|
14293
|
+
# actions. Unless you are using a customer-provided encryption key, you
|
14294
|
+
# don't need to specify the encryption parameters in each UploadPart
|
14295
|
+
# request. Instead, you only need to specify the server-side encryption
|
14296
|
+
# parameters in the initial Initiate Multipart request. For more
|
14297
|
+
# information, see [CreateMultipartUpload][2].
|
14380
14298
|
#
|
14381
14299
|
# If you requested server-side encryption using a customer-provided
|
14382
|
-
# encryption key
|
14383
|
-
#
|
14384
|
-
#
|
14300
|
+
# encryption key in your initiate multipart upload request, you must
|
14301
|
+
# provide identical encryption information in each part upload using the
|
14302
|
+
# following headers.
|
14385
14303
|
#
|
14386
14304
|
# * x-amz-server-side-encryption-customer-algorithm
|
14387
14305
|
#
|
@@ -14441,14 +14359,14 @@ module Aws::S3
|
|
14441
14359
|
# name. For more information about access point ARNs, see [Using access
|
14442
14360
|
# points][1] in the *Amazon S3 User Guide*.
|
14443
14361
|
#
|
14444
|
-
# When
|
14362
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
14445
14363
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
14446
14364
|
# takes the form `
|
14447
14365
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
14448
|
-
# When
|
14449
|
-
# Services SDKs, you provide the Outposts
|
14450
|
-
#
|
14451
|
-
# [
|
14366
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
14367
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
14368
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
14369
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
14452
14370
|
#
|
14453
14371
|
#
|
14454
14372
|
#
|
@@ -14791,14 +14709,14 @@ module Aws::S3
|
|
14791
14709
|
# name. For more information about access point ARNs, see [Using access
|
14792
14710
|
# points][1] in the *Amazon S3 User Guide*.
|
14793
14711
|
#
|
14794
|
-
# When
|
14712
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
14795
14713
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
14796
14714
|
# takes the form `
|
14797
14715
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
14798
|
-
# When
|
14799
|
-
# Services SDKs, you provide the Outposts
|
14800
|
-
#
|
14801
|
-
# [
|
14716
|
+
# When using this action with S3 on Outposts through the Amazon Web
|
14717
|
+
# Services SDKs, you provide the Outposts bucket ARN in place of the
|
14718
|
+
# bucket name. For more information about S3 on Outposts ARNs, see
|
14719
|
+
# [Using Amazon S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
14802
14720
|
#
|
14803
14721
|
#
|
14804
14722
|
#
|
@@ -14948,45 +14866,45 @@ module Aws::S3
|
|
14948
14866
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
14949
14867
|
#
|
14950
14868
|
#
|
14951
|
-
# @example Example: To upload a part by copying
|
14869
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
14952
14870
|
#
|
14953
|
-
# # The following example uploads a part of a multipart upload by copying
|
14871
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
14872
|
+
# # data source.
|
14954
14873
|
#
|
14955
14874
|
# resp = client.upload_part_copy({
|
14956
14875
|
# bucket: "examplebucket",
|
14957
14876
|
# copy_source: "/bucketname/sourceobjectkey",
|
14877
|
+
# copy_source_range: "bytes=1-100000",
|
14958
14878
|
# key: "examplelargeobject",
|
14959
|
-
# part_number:
|
14879
|
+
# part_number: 2,
|
14960
14880
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
14961
14881
|
# })
|
14962
14882
|
#
|
14963
14883
|
# resp.to_h outputs the following:
|
14964
14884
|
# {
|
14965
14885
|
# copy_part_result: {
|
14966
|
-
# etag: "\"
|
14967
|
-
# last_modified: Time.parse("2016-12-29T21:
|
14886
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
14887
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
14968
14888
|
# },
|
14969
14889
|
# }
|
14970
14890
|
#
|
14971
|
-
# @example Example: To upload a part by copying
|
14891
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
14972
14892
|
#
|
14973
|
-
# # The following example uploads a part of a multipart upload by copying
|
14974
|
-
# # data source.
|
14893
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
14975
14894
|
#
|
14976
14895
|
# resp = client.upload_part_copy({
|
14977
14896
|
# bucket: "examplebucket",
|
14978
14897
|
# copy_source: "/bucketname/sourceobjectkey",
|
14979
|
-
# copy_source_range: "bytes=1-100000",
|
14980
14898
|
# key: "examplelargeobject",
|
14981
|
-
# part_number:
|
14899
|
+
# part_number: 1,
|
14982
14900
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
14983
14901
|
# })
|
14984
14902
|
#
|
14985
14903
|
# resp.to_h outputs the following:
|
14986
14904
|
# {
|
14987
14905
|
# copy_part_result: {
|
14988
|
-
# etag: "\"
|
14989
|
-
# last_modified: Time.parse("2016-12-29T21:
|
14906
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
14907
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
14990
14908
|
# },
|
14991
14909
|
# }
|
14992
14910
|
#
|
@@ -15322,7 +15240,7 @@ module Aws::S3
|
|
15322
15240
|
#
|
15323
15241
|
# @option params [String] :server_side_encryption
|
15324
15242
|
# The server-side encryption algorithm used when storing requested
|
15325
|
-
# object in Amazon S3 (for example, AES256,
|
15243
|
+
# object in Amazon S3 (for example, AES256, aws:kms).
|
15326
15244
|
#
|
15327
15245
|
# @option params [String] :sse_customer_algorithm
|
15328
15246
|
# Encryption algorithm used if server-side encryption with a
|
@@ -15331,8 +15249,8 @@ module Aws::S3
|
|
15331
15249
|
#
|
15332
15250
|
# @option params [String] :ssekms_key_id
|
15333
15251
|
# If present, specifies the ID of the Amazon Web Services Key Management
|
15334
|
-
# Service (Amazon Web Services KMS) symmetric
|
15335
|
-
#
|
15252
|
+
# Service (Amazon Web Services KMS) symmetric customer managed key that
|
15253
|
+
# was used for stored in Amazon S3 object.
|
15336
15254
|
#
|
15337
15255
|
# @option params [String] :sse_customer_key_md5
|
15338
15256
|
# 128-bit MD5 digest of customer-provided encryption key used in Amazon
|
@@ -15408,7 +15326,7 @@ module Aws::S3
|
|
15408
15326
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
15409
15327
|
# ssekms_key_id: "SSEKMSKeyId",
|
15410
15328
|
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
15411
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
|
15329
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW
|
15412
15330
|
# tag_count: 1,
|
15413
15331
|
# version_id: "ObjectVersionId",
|
15414
15332
|
# bucket_key_enabled: false,
|
@@ -15436,7 +15354,7 @@ module Aws::S3
|
|
15436
15354
|
params: params,
|
15437
15355
|
config: config)
|
15438
15356
|
context[:gem_name] = 'aws-sdk-s3'
|
15439
|
-
context[:gem_version] = '1.
|
15357
|
+
context[:gem_version] = '1.121.0'
|
15440
15358
|
Seahorse::Client::Request.new(handlers, context)
|
15441
15359
|
end
|
15442
15360
|
|