aws-sdk-s3 1.125.0 → 1.127.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 +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +61 -31
- data/lib/aws-sdk-s3/client.rb +442 -407
- data/lib/aws-sdk-s3/client_api.rb +24 -0
- data/lib/aws-sdk-s3/object.rb +36 -37
- data/lib/aws-sdk-s3/object_summary.rb +45 -32
- data/lib/aws-sdk-s3/object_version.rb +14 -0
- data/lib/aws-sdk-s3/presigner.rb +4 -2
- data/lib/aws-sdk-s3/types.rb +371 -204
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +6 -6
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -513,7 +513,7 @@ module Aws::S3
|
|
513
513
|
# When you use this action with S3 on Outposts through the Amazon Web
|
514
514
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
515
515
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
516
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
516
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
517
517
|
#
|
518
518
|
#
|
519
519
|
#
|
@@ -702,7 +702,7 @@ module Aws::S3
|
|
702
702
|
# When you use this action with S3 on Outposts through the Amazon Web
|
703
703
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
704
704
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
705
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
705
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
706
706
|
#
|
707
707
|
#
|
708
708
|
#
|
@@ -963,11 +963,12 @@ module Aws::S3
|
|
963
963
|
#
|
964
964
|
# Metadata
|
965
965
|
#
|
966
|
-
# : When copying an object, you can preserve all metadata (default)
|
967
|
-
# specify new metadata. However, the
|
968
|
-
# to private for the user making the request.
|
969
|
-
# ACL setting, specify a new ACL when
|
970
|
-
# more information, see [Using
|
966
|
+
# : When copying an object, you can preserve all metadata (the default)
|
967
|
+
# or specify new metadata. However, the access control list (ACL) is
|
968
|
+
# not preserved and is set to private for the user making the request.
|
969
|
+
# To override the default ACL setting, specify a new ACL when
|
970
|
+
# generating a copy request. For more information, see [Using
|
971
|
+
# ACLs][5].
|
971
972
|
#
|
972
973
|
# To specify whether you want the object metadata copied from the
|
973
974
|
# source object or replaced with metadata provided in the request, you
|
@@ -1032,25 +1033,26 @@ module Aws::S3
|
|
1032
1033
|
# of encryption configuration that uses server-side encryption with
|
1033
1034
|
# Amazon S3 managed keys (SSE-S3). If the destination bucket has a
|
1034
1035
|
# default encryption configuration that uses server-side encryption
|
1035
|
-
# with
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
#
|
1036
|
+
# with Key Management Service (KMS) keys (SSE-KMS), dual-layer
|
1037
|
+
# server-side encryption with Amazon Web Services KMS keys (DSSE-KMS),
|
1038
|
+
# or server-side encryption with customer-provided encryption keys
|
1039
|
+
# (SSE-C), Amazon S3 uses the corresponding KMS key, or a
|
1040
|
+
# customer-provided key to encrypt the target object copy.
|
1039
1041
|
#
|
1040
|
-
# When you perform a CopyObject operation, if you want to use a
|
1042
|
+
# When you perform a `CopyObject` operation, if you want to use a
|
1041
1043
|
# different type of encryption setting for the target object, you can
|
1042
1044
|
# use other appropriate encryption-related headers to encrypt the
|
1043
1045
|
# target object with a KMS key, an Amazon S3 managed key, or a
|
1044
1046
|
# customer-provided key. With server-side encryption, Amazon S3
|
1045
|
-
# encrypts your data as it writes
|
1046
|
-
# decrypts the data when you access it. If the encryption
|
1047
|
-
# your request is different from the default encryption
|
1048
|
-
# of the destination bucket, the encryption setting in
|
1049
|
-
# takes precedence. If the source object for the copy is
|
1050
|
-
# Amazon S3 using SSE-C, you must provide the necessary
|
1051
|
-
# information in your request so that Amazon S3 can decrypt
|
1052
|
-
# for copying. For more information about server-side
|
1053
|
-
# [Using Server-Side Encryption][8].
|
1047
|
+
# encrypts your data as it writes your data to disks in its data
|
1048
|
+
# centers and decrypts the data when you access it. If the encryption
|
1049
|
+
# setting in your request is different from the default encryption
|
1050
|
+
# configuration of the destination bucket, the encryption setting in
|
1051
|
+
# your request takes precedence. If the source object for the copy is
|
1052
|
+
# stored in Amazon S3 using SSE-C, you must provide the necessary
|
1053
|
+
# encryption information in your request so that Amazon S3 can decrypt
|
1054
|
+
# the object for copying. For more information about server-side
|
1055
|
+
# encryption, see [Using Server-Side Encryption][8].
|
1054
1056
|
#
|
1055
1057
|
# If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
|
1056
1058
|
# the object. For more information, see [Amazon S3 Bucket Keys][9] in
|
@@ -1062,16 +1064,16 @@ module Aws::S3
|
|
1062
1064
|
# ACL-based permissions. By default, all objects are private. Only the
|
1063
1065
|
# owner has full access control. When adding a new object, you can
|
1064
1066
|
# grant permissions to individual Amazon Web Services accounts or to
|
1065
|
-
# predefined groups defined by Amazon S3. These permissions
|
1066
|
-
# added to the ACL on the object. For more information, see
|
1067
|
-
# Control List (ACL) Overview][10] and [Managing ACLs Using
|
1068
|
-
# API][11].
|
1067
|
+
# predefined groups that are defined by Amazon S3. These permissions
|
1068
|
+
# are then added to the ACL on the object. For more information, see
|
1069
|
+
# [Access Control List (ACL) Overview][10] and [Managing ACLs Using
|
1070
|
+
# the REST API][11].
|
1069
1071
|
#
|
1070
1072
|
# If the bucket that you're copying objects to uses the bucket owner
|
1071
1073
|
# enforced setting for S3 Object Ownership, ACLs are disabled and no
|
1072
1074
|
# longer affect permissions. Buckets that use this setting only accept
|
1073
|
-
# PUT requests that don't specify an ACL or PUT requests that
|
1074
|
-
# bucket owner full control ACLs, such as the
|
1075
|
+
# `PUT` requests that don't specify an ACL or `PUT` requests that
|
1076
|
+
# specify bucket owner full control ACLs, such as the
|
1075
1077
|
# `bucket-owner-full-control` canned ACL or an equivalent form of this
|
1076
1078
|
# ACL expressed in the XML format.
|
1077
1079
|
#
|
@@ -1088,13 +1090,13 @@ module Aws::S3
|
|
1088
1090
|
#
|
1089
1091
|
# : When copying an object, if it has a checksum, that checksum will be
|
1090
1092
|
# copied to the new object by default. When you copy the object over,
|
1091
|
-
# you
|
1093
|
+
# you can optionally specify a different checksum algorithm to use
|
1092
1094
|
# with the `x-amz-checksum-algorithm` header.
|
1093
1095
|
#
|
1094
1096
|
# Storage Class Options
|
1095
1097
|
#
|
1096
1098
|
# : You can use the `CopyObject` action to change the storage class of
|
1097
|
-
# an object that is already stored in Amazon S3 using the
|
1099
|
+
# an object that is already stored in Amazon S3 by using the
|
1098
1100
|
# `StorageClass` parameter. For more information, see [Storage
|
1099
1101
|
# Classes][13] in the *Amazon S3 User Guide*.
|
1100
1102
|
#
|
@@ -1105,10 +1107,10 @@ module Aws::S3
|
|
1105
1107
|
#
|
1106
1108
|
# Versioning
|
1107
1109
|
#
|
1108
|
-
# : By default, `x-amz-copy-source` identifies the current
|
1109
|
-
# object to copy. If the current version is a delete
|
1110
|
-
# behaves as if the object was deleted. To copy a
|
1111
|
-
# use the `versionId` subresource.
|
1110
|
+
# : By default, `x-amz-copy-source` header identifies the current
|
1111
|
+
# version of an object to copy. If the current version is a delete
|
1112
|
+
# marker, Amazon S3 behaves as if the object was deleted. To copy a
|
1113
|
+
# different version, use the `versionId` subresource.
|
1112
1114
|
#
|
1113
1115
|
# If you enable versioning on the target bucket, Amazon S3 generates a
|
1114
1116
|
# unique version ID for the object being copied. This version ID is
|
@@ -1168,7 +1170,7 @@ module Aws::S3
|
|
1168
1170
|
# When you use this action with S3 on Outposts through the Amazon Web
|
1169
1171
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
1170
1172
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1171
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
1173
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1172
1174
|
#
|
1173
1175
|
#
|
1174
1176
|
#
|
@@ -1302,7 +1304,7 @@ module Aws::S3
|
|
1302
1304
|
#
|
1303
1305
|
# @option params [String] :server_side_encryption
|
1304
1306
|
# The server-side encryption algorithm used when storing this object in
|
1305
|
-
# Amazon S3 (for example, AES256
|
1307
|
+
# Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1306
1308
|
#
|
1307
1309
|
# @option params [String] :storage_class
|
1308
1310
|
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
@@ -1341,13 +1343,12 @@ module Aws::S3
|
|
1341
1343
|
# ensure that the encryption key was transmitted without error.
|
1342
1344
|
#
|
1343
1345
|
# @option params [String] :ssekms_key_id
|
1344
|
-
# Specifies the
|
1345
|
-
#
|
1346
|
-
#
|
1347
|
-
#
|
1348
|
-
#
|
1349
|
-
#
|
1350
|
-
# User Guide*.
|
1346
|
+
# Specifies the KMS key ID to use for object encryption. All GET and PUT
|
1347
|
+
# requests for an object protected by KMS will fail if they're not made
|
1348
|
+
# via SSL or using SigV4. For information about configuring any of the
|
1349
|
+
# officially supported Amazon Web Services SDKs and Amazon Web Services
|
1350
|
+
# CLI, see [Specifying the Signature Version in Request
|
1351
|
+
# Authentication][1] in the *Amazon S3 User Guide*.
|
1351
1352
|
#
|
1352
1353
|
#
|
1353
1354
|
#
|
@@ -1360,9 +1361,9 @@ module Aws::S3
|
|
1360
1361
|
#
|
1361
1362
|
# @option params [Boolean] :bucket_key_enabled
|
1362
1363
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
1363
|
-
# encryption with server-side encryption using
|
1364
|
-
# Setting this header to `true` causes Amazon S3
|
1365
|
-
# for object encryption with SSE-KMS.
|
1364
|
+
# encryption with server-side encryption using Key Management Service
|
1365
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
1366
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
1366
1367
|
#
|
1367
1368
|
# Specifying this header with a COPY action doesn’t affect bucket-level
|
1368
1369
|
# settings for S3 Bucket Key.
|
@@ -1545,8 +1546,8 @@ module Aws::S3
|
|
1545
1546
|
# (Ireland) Region. For more information, see [Accessing a bucket][3].
|
1546
1547
|
#
|
1547
1548
|
# <note markdown="1"> If you send your create bucket request to the `s3.amazonaws.com`
|
1548
|
-
# endpoint, the request goes to the us-east-1 Region. Accordingly, the
|
1549
|
-
# signature calculations in Signature Version 4 must use us-east-1 as
|
1549
|
+
# endpoint, the request goes to the `us-east-1` Region. Accordingly, the
|
1550
|
+
# signature calculations in Signature Version 4 must use `us-east-1` as
|
1550
1551
|
# the Region, even if the location constraint in the request specifies
|
1551
1552
|
# another Region where the bucket is to be created. If you create a
|
1552
1553
|
# bucket in a Region other than US East (N. Virginia), your application
|
@@ -1555,108 +1556,62 @@ module Aws::S3
|
|
1555
1556
|
#
|
1556
1557
|
# </note>
|
1557
1558
|
#
|
1558
|
-
# Access control lists (ACLs)
|
1559
|
-
#
|
1560
|
-
# : When creating a bucket using this operation, you can optionally
|
1561
|
-
# configure the bucket ACL to specify the accounts or groups that
|
1562
|
-
# should be granted specific permissions on the bucket.
|
1563
|
-
#
|
1564
|
-
# If your CreateBucket request sets bucket owner enforced for S3
|
1565
|
-
# Object Ownership and specifies a bucket ACL that provides access to
|
1566
|
-
# an external Amazon Web Services account, your request fails with a
|
1567
|
-
# `400` error and returns the `InvalidBucketAclWithObjectOwnership`
|
1568
|
-
# error code. For more information, see [Controlling object
|
1569
|
-
# ownership][5] in the *Amazon S3 User Guide*.
|
1570
|
-
#
|
1571
|
-
# There are two ways to grant the appropriate permissions using the
|
1572
|
-
# request headers.
|
1573
|
-
#
|
1574
|
-
# * Specify a canned ACL using the `x-amz-acl` request header. Amazon
|
1575
|
-
# S3 supports a set of predefined ACLs, known as *canned ACLs*. Each
|
1576
|
-
# canned ACL has a predefined set of grantees and permissions. For
|
1577
|
-
# more information, see [Canned ACL][6].
|
1578
|
-
#
|
1579
|
-
# * Specify access permissions explicitly using the
|
1580
|
-
# `x-amz-grant-read`, `x-amz-grant-write`, `x-amz-grant-read-acp`,
|
1581
|
-
# `x-amz-grant-write-acp`, and `x-amz-grant-full-control` headers.
|
1582
|
-
# These headers map to the set of permissions Amazon S3 supports in
|
1583
|
-
# an ACL. For more information, see [Access control list (ACL)
|
1584
|
-
# overview][7].
|
1585
|
-
#
|
1586
|
-
# You specify each grantee as a type=value pair, where the type is
|
1587
|
-
# one of the following:
|
1588
|
-
#
|
1589
|
-
# * `id` – if the value specified is the canonical user ID of an
|
1590
|
-
# Amazon Web Services account
|
1591
|
-
#
|
1592
|
-
# * `uri` – if you are granting permissions to a predefined group
|
1593
|
-
#
|
1594
|
-
# * `emailAddress` – if the value specified is the email address of
|
1595
|
-
# an Amazon Web Services account
|
1596
|
-
#
|
1597
|
-
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
1598
|
-
# the following Amazon Web Services Regions:
|
1599
|
-
#
|
1600
|
-
# * US East (N. Virginia)
|
1601
|
-
#
|
1602
|
-
# * US West (N. California)
|
1603
|
-
#
|
1604
|
-
# * US West (Oregon)
|
1605
|
-
#
|
1606
|
-
# * Asia Pacific (Singapore)
|
1607
|
-
#
|
1608
|
-
# * Asia Pacific (Sydney)
|
1609
|
-
#
|
1610
|
-
# * Asia Pacific (Tokyo)
|
1611
|
-
#
|
1612
|
-
# * Europe (Ireland)
|
1613
|
-
#
|
1614
|
-
# * South America (São Paulo)
|
1615
|
-
#
|
1616
|
-
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1617
|
-
# see [Regions and Endpoints][8] in the Amazon Web Services
|
1618
|
-
# General Reference.
|
1619
|
-
#
|
1620
|
-
# </note>
|
1621
|
-
#
|
1622
|
-
# For example, the following `x-amz-grant-read` header grants the
|
1623
|
-
# Amazon Web Services accounts identified by account IDs permissions
|
1624
|
-
# to read object data and its metadata:
|
1625
|
-
#
|
1626
|
-
# `x-amz-grant-read: id="11112222333", id="444455556666" `
|
1627
|
-
#
|
1628
|
-
# <note markdown="1"> You can use either a canned ACL or specify access permissions
|
1629
|
-
# explicitly. You cannot do both.
|
1630
|
-
#
|
1631
|
-
# </note>
|
1632
|
-
#
|
1633
1559
|
# Permissions
|
1634
1560
|
#
|
1635
1561
|
# : In addition to `s3:CreateBucket`, the following permissions are
|
1636
|
-
# required when your CreateBucket includes specific headers:
|
1562
|
+
# required when your `CreateBucket` request includes specific headers:
|
1637
1563
|
#
|
1638
|
-
# * **ACLs** - If your `CreateBucket` request
|
1639
|
-
# permissions and the ACL is
|
1640
|
-
# authenticated-read, or if you
|
1641
|
-
# explicitly through any other ACL, both
|
1642
|
-
# `s3:PutBucketAcl` permissions are needed. If
|
1643
|
-
# `CreateBucket` request is private or
|
1644
|
-
# only `s3:CreateBucket`
|
1564
|
+
# * **Access control lists (ACLs)** - If your `CreateBucket` request
|
1565
|
+
# specifies access control list (ACL) permissions and the ACL is
|
1566
|
+
# public-read, public-read-write, authenticated-read, or if you
|
1567
|
+
# specify access permissions explicitly through any other ACL, both
|
1568
|
+
# `s3:CreateBucket` and `s3:PutBucketAcl` permissions are needed. If
|
1569
|
+
# the ACL for the `CreateBucket` request is private or if the
|
1570
|
+
# request doesn't specify any ACLs, only `s3:CreateBucket`
|
1571
|
+
# permission is needed.
|
1645
1572
|
#
|
1646
1573
|
# * **Object Lock** - If `ObjectLockEnabledForBucket` is set to true
|
1647
1574
|
# in your `CreateBucket` request,
|
1648
1575
|
# `s3:PutBucketObjectLockConfiguration` and `s3:PutBucketVersioning`
|
1649
1576
|
# permissions are required.
|
1650
1577
|
#
|
1651
|
-
# * **S3 Object Ownership** - If your CreateBucket request includes
|
1652
|
-
# the `x-amz-object-ownership` header,
|
1653
|
-
# `s3:PutBucketOwnershipControls` permission is required.
|
1578
|
+
# * **S3 Object Ownership** - If your `CreateBucket` request includes
|
1579
|
+
# the `x-amz-object-ownership` header, then the
|
1580
|
+
# `s3:PutBucketOwnershipControls` permission is required. By
|
1581
|
+
# default, `ObjectOwnership` is set to `BucketOWnerEnforced` and
|
1582
|
+
# ACLs are disabled. We recommend keeping ACLs disabled, except in
|
1583
|
+
# uncommon use cases where you must control access for each object
|
1584
|
+
# individually. If you want to change the `ObjectOwnership` setting,
|
1585
|
+
# you can use the `x-amz-object-ownership` header in your
|
1586
|
+
# `CreateBucket` request to set the `ObjectOwnership` setting of
|
1587
|
+
# your choice. For more information about S3 Object Ownership, see
|
1588
|
+
# [Controlling object ownership ][5] in the *Amazon S3 User Guide*.
|
1589
|
+
#
|
1590
|
+
# * **S3 Block Public Access** - If your specific use case requires
|
1591
|
+
# granting public access to your S3 resources, you can disable Block
|
1592
|
+
# Public Access. You can create a new bucket with Block Public
|
1593
|
+
# Access enabled, then separately call the [
|
1594
|
+
# `DeletePublicAccessBlock` ][6] API. To use this operation, you
|
1595
|
+
# must have the `s3:PutBucketPublicAccessBlock` permission. By
|
1596
|
+
# default, all Block Public Access settings are enabled for new
|
1597
|
+
# buckets. To avoid inadvertent exposure of your resources, we
|
1598
|
+
# recommend keeping the S3 Block Public Access settings enabled. For
|
1599
|
+
# more information about S3 Block Public Access, see [Blocking
|
1600
|
+
# public access to your Amazon S3 storage ][5] in the *Amazon S3
|
1601
|
+
# User Guide*.
|
1602
|
+
#
|
1603
|
+
# If your `CreateBucket` request sets `BucketOwnerEnforced` for Amazon
|
1604
|
+
# S3 Object Ownership and specifies a bucket ACL that provides access to
|
1605
|
+
# an external Amazon Web Services account, your request fails with a
|
1606
|
+
# `400` error and returns the `InvalidBucketAcLWithObjectOwnership`
|
1607
|
+
# error code. For more information, see [Setting Object Ownership on an
|
1608
|
+
# existing bucket ][7] in the *Amazon S3 User Guide*.
|
1654
1609
|
#
|
1655
1610
|
# The following operations are related to `CreateBucket`:
|
1656
1611
|
#
|
1657
|
-
# * [PutObject][
|
1612
|
+
# * [PutObject][8]
|
1658
1613
|
#
|
1659
|
-
# * [DeleteBucket][
|
1614
|
+
# * [DeleteBucket][9]
|
1660
1615
|
#
|
1661
1616
|
#
|
1662
1617
|
#
|
@@ -1665,11 +1620,10 @@ module Aws::S3
|
|
1665
1620
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
|
1666
1621
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
1667
1622
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
1668
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1669
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
1670
|
-
# [8]: https://docs.aws.amazon.com/
|
1671
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1672
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
1623
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
|
1624
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html
|
1625
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
1626
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
1673
1627
|
#
|
1674
1628
|
# @option params [String] :acl
|
1675
1629
|
# The canned ACL to apply to the bucket.
|
@@ -1726,33 +1680,33 @@ module Aws::S3
|
|
1726
1680
|
# * {Types::CreateBucketOutput#location #location} => String
|
1727
1681
|
#
|
1728
1682
|
#
|
1729
|
-
# @example Example: To create a bucket
|
1683
|
+
# @example Example: To create a bucket
|
1730
1684
|
#
|
1731
|
-
# # The following example creates a bucket.
|
1685
|
+
# # The following example creates a bucket.
|
1732
1686
|
#
|
1733
1687
|
# resp = client.create_bucket({
|
1734
1688
|
# bucket: "examplebucket",
|
1735
|
-
# create_bucket_configuration: {
|
1736
|
-
# location_constraint: "eu-west-1",
|
1737
|
-
# },
|
1738
1689
|
# })
|
1739
1690
|
#
|
1740
1691
|
# resp.to_h outputs the following:
|
1741
1692
|
# {
|
1742
|
-
# location: "
|
1693
|
+
# location: "/examplebucket",
|
1743
1694
|
# }
|
1744
1695
|
#
|
1745
|
-
# @example Example: To create a bucket
|
1696
|
+
# @example Example: To create a bucket in a specific region
|
1746
1697
|
#
|
1747
|
-
# # The following example creates a bucket.
|
1698
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
1748
1699
|
#
|
1749
1700
|
# resp = client.create_bucket({
|
1750
1701
|
# bucket: "examplebucket",
|
1702
|
+
# create_bucket_configuration: {
|
1703
|
+
# location_constraint: "eu-west-1",
|
1704
|
+
# },
|
1751
1705
|
# })
|
1752
1706
|
#
|
1753
1707
|
# resp.to_h outputs the following:
|
1754
1708
|
# {
|
1755
|
-
# location: "/
|
1709
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
1756
1710
|
# }
|
1757
1711
|
#
|
1758
1712
|
# @example Request syntax with placeholder values
|
@@ -2072,7 +2026,7 @@ module Aws::S3
|
|
2072
2026
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2073
2027
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2074
2028
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2075
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2029
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2076
2030
|
#
|
2077
2031
|
#
|
2078
2032
|
#
|
@@ -2128,7 +2082,7 @@ module Aws::S3
|
|
2128
2082
|
#
|
2129
2083
|
# @option params [String] :server_side_encryption
|
2130
2084
|
# The server-side encryption algorithm used when storing this object in
|
2131
|
-
# Amazon S3 (for example, AES256
|
2085
|
+
# Amazon S3 (for example, `AES256`, `aws:kms`).
|
2132
2086
|
#
|
2133
2087
|
# @option params [String] :storage_class
|
2134
2088
|
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
@@ -2166,11 +2120,11 @@ module Aws::S3
|
|
2166
2120
|
# @option params [String] :ssekms_key_id
|
2167
2121
|
# Specifies the ID of the symmetric encryption customer managed key to
|
2168
2122
|
# use for object encryption. All GET and PUT requests for an object
|
2169
|
-
# protected by
|
2170
|
-
#
|
2171
|
-
#
|
2172
|
-
#
|
2173
|
-
#
|
2123
|
+
# protected by KMS will fail if they're not made via SSL or using
|
2124
|
+
# SigV4. For information about configuring any of the officially
|
2125
|
+
# supported Amazon Web Services SDKs and Amazon Web Services CLI, see
|
2126
|
+
# [Specifying the Signature Version in Request Authentication][1] in the
|
2127
|
+
# *Amazon S3 User Guide*.
|
2174
2128
|
#
|
2175
2129
|
#
|
2176
2130
|
#
|
@@ -2183,9 +2137,9 @@ module Aws::S3
|
|
2183
2137
|
#
|
2184
2138
|
# @option params [Boolean] :bucket_key_enabled
|
2185
2139
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
2186
|
-
# encryption with server-side encryption using
|
2187
|
-
# Setting this header to `true` causes Amazon S3
|
2188
|
-
# for object encryption with SSE-KMS.
|
2140
|
+
# encryption with server-side encryption using Key Management Service
|
2141
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
2142
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
2189
2143
|
#
|
2190
2144
|
# Specifying this header with an object action doesn’t affect
|
2191
2145
|
# bucket-level settings for S3 Bucket Key.
|
@@ -2446,7 +2400,7 @@ module Aws::S3
|
|
2446
2400
|
# For information about `cors`, see [Enabling Cross-Origin Resource
|
2447
2401
|
# Sharing][1] in the *Amazon S3 User Guide*.
|
2448
2402
|
#
|
2449
|
-
#
|
2403
|
+
# **Related Resources**
|
2450
2404
|
#
|
2451
2405
|
# * [PutBucketCors][2]
|
2452
2406
|
#
|
@@ -3157,7 +3111,7 @@ module Aws::S3
|
|
3157
3111
|
# When you use this action with S3 on Outposts through the Amazon Web
|
3158
3112
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
3159
3113
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
3160
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3114
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
3161
3115
|
#
|
3162
3116
|
#
|
3163
3117
|
#
|
@@ -3204,15 +3158,6 @@ module Aws::S3
|
|
3204
3158
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
3205
3159
|
#
|
3206
3160
|
#
|
3207
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
3208
|
-
#
|
3209
|
-
# # The following example deletes an object from a non-versioned bucket.
|
3210
|
-
#
|
3211
|
-
# resp = client.delete_object({
|
3212
|
-
# bucket: "ExampleBucket",
|
3213
|
-
# key: "HappyFace.jpg",
|
3214
|
-
# })
|
3215
|
-
#
|
3216
3161
|
# @example Example: To delete an object
|
3217
3162
|
#
|
3218
3163
|
# # The following example deletes an object from an S3 bucket.
|
@@ -3226,6 +3171,15 @@ module Aws::S3
|
|
3226
3171
|
# {
|
3227
3172
|
# }
|
3228
3173
|
#
|
3174
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
3175
|
+
#
|
3176
|
+
# # The following example deletes an object from a non-versioned bucket.
|
3177
|
+
#
|
3178
|
+
# resp = client.delete_object({
|
3179
|
+
# bucket: "ExampleBucket",
|
3180
|
+
# key: "HappyFace.jpg",
|
3181
|
+
# })
|
3182
|
+
#
|
3229
3183
|
# @example Request syntax with placeholder values
|
3230
3184
|
#
|
3231
3185
|
# resp = client.delete_object({
|
@@ -3293,7 +3247,7 @@ module Aws::S3
|
|
3293
3247
|
# When you use this action with S3 on Outposts through the Amazon Web
|
3294
3248
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
3295
3249
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
3296
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3250
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
3297
3251
|
#
|
3298
3252
|
#
|
3299
3253
|
#
|
@@ -3317,35 +3271,35 @@ module Aws::S3
|
|
3317
3271
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
3318
3272
|
#
|
3319
3273
|
#
|
3320
|
-
# @example Example: To remove tag set from an object
|
3274
|
+
# @example Example: To remove tag set from an object version
|
3321
3275
|
#
|
3322
|
-
# # The following example removes tag set associated with the specified object.
|
3323
|
-
# #
|
3276
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
3277
|
+
# # object key and object version.
|
3324
3278
|
#
|
3325
3279
|
# resp = client.delete_object_tagging({
|
3326
3280
|
# bucket: "examplebucket",
|
3327
3281
|
# key: "HappyFace.jpg",
|
3282
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
3328
3283
|
# })
|
3329
3284
|
#
|
3330
3285
|
# resp.to_h outputs the following:
|
3331
3286
|
# {
|
3332
|
-
# version_id: "
|
3287
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
3333
3288
|
# }
|
3334
3289
|
#
|
3335
|
-
# @example Example: To remove tag set from an object
|
3290
|
+
# @example Example: To remove tag set from an object
|
3336
3291
|
#
|
3337
|
-
# # The following example removes tag set associated with the specified object
|
3338
|
-
# #
|
3292
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
3293
|
+
# # operation removes tag set from the latest object version.
|
3339
3294
|
#
|
3340
3295
|
# resp = client.delete_object_tagging({
|
3341
3296
|
# bucket: "examplebucket",
|
3342
3297
|
# key: "HappyFace.jpg",
|
3343
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
3344
3298
|
# })
|
3345
3299
|
#
|
3346
3300
|
# resp.to_h outputs the following:
|
3347
3301
|
# {
|
3348
|
-
# version_id: "
|
3302
|
+
# version_id: "null",
|
3349
3303
|
# }
|
3350
3304
|
#
|
3351
3305
|
# @example Request syntax with placeholder values
|
@@ -3441,7 +3395,7 @@ module Aws::S3
|
|
3441
3395
|
# When you use this action with S3 on Outposts through the Amazon Web
|
3442
3396
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
3443
3397
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
3444
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
3398
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
3445
3399
|
#
|
3446
3400
|
#
|
3447
3401
|
#
|
@@ -3720,20 +3674,34 @@ module Aws::S3
|
|
3720
3674
|
# a different account, the request fails with the HTTP status code `403
|
3721
3675
|
# Forbidden` (access denied).
|
3722
3676
|
#
|
3677
|
+
# @option params [String] :request_payer
|
3678
|
+
# Confirms that the requester knows that they will be charged for the
|
3679
|
+
# request. Bucket owners need not specify this parameter in their
|
3680
|
+
# requests. For information about downloading objects from Requester
|
3681
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
3682
|
+
# in the *Amazon S3 User Guide*.
|
3683
|
+
#
|
3684
|
+
#
|
3685
|
+
#
|
3686
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
3687
|
+
#
|
3723
3688
|
# @return [Types::GetBucketAccelerateConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3724
3689
|
#
|
3725
3690
|
# * {Types::GetBucketAccelerateConfigurationOutput#status #status} => String
|
3691
|
+
# * {Types::GetBucketAccelerateConfigurationOutput#request_charged #request_charged} => String
|
3726
3692
|
#
|
3727
3693
|
# @example Request syntax with placeholder values
|
3728
3694
|
#
|
3729
3695
|
# resp = client.get_bucket_accelerate_configuration({
|
3730
3696
|
# bucket: "BucketName", # required
|
3731
3697
|
# expected_bucket_owner: "AccountId",
|
3698
|
+
# request_payer: "requester", # accepts requester
|
3732
3699
|
# })
|
3733
3700
|
#
|
3734
3701
|
# @example Response structure
|
3735
3702
|
#
|
3736
3703
|
# resp.status #=> String, one of "Enabled", "Suspended"
|
3704
|
+
# resp.request_charged #=> String, one of "requester"
|
3737
3705
|
#
|
3738
3706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration AWS API Documentation
|
3739
3707
|
#
|
@@ -5639,30 +5607,32 @@ module Aws::S3
|
|
5639
5607
|
# For more information about returning the ACL of an object, see
|
5640
5608
|
# [GetObjectAcl][2].
|
5641
5609
|
#
|
5642
|
-
# If the object you are retrieving is stored in the S3 Glacier
|
5643
|
-
# Glacier Deep Archive storage class, or S3
|
5644
|
-
# or S3 Intelligent-Tiering Deep Archive
|
5645
|
-
# the object you must first restore a
|
5646
|
-
# Otherwise, this action returns an
|
5647
|
-
# information about restoring archived
|
5648
|
-
# Objects][4].
|
5610
|
+
# If the object you are retrieving is stored in the S3 Glacier Flexible
|
5611
|
+
# Retrieval or S3 Glacier Deep Archive storage class, or S3
|
5612
|
+
# Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive
|
5613
|
+
# tiers, before you can retrieve the object you must first restore a
|
5614
|
+
# copy using [RestoreObject][3]. Otherwise, this action returns an
|
5615
|
+
# `InvalidObjectState` error. For information about restoring archived
|
5616
|
+
# objects, see [Restoring Archived Objects][4].
|
5649
5617
|
#
|
5650
5618
|
# Encryption request headers, like `x-amz-server-side-encryption`,
|
5651
5619
|
# should not be sent for GET requests if your object uses server-side
|
5652
|
-
# encryption with KMS keys (SSE-KMS)
|
5653
|
-
#
|
5654
|
-
#
|
5620
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS),
|
5621
|
+
# dual-layer server-side encryption with Amazon Web Services KMS keys
|
5622
|
+
# (DSSE-KMS), or server-side encryption with Amazon S3 managed
|
5623
|
+
# encryption keys (SSE-S3). If your object does use these types of keys,
|
5624
|
+
# you’ll get an HTTP 400 Bad Request error.
|
5655
5625
|
#
|
5656
5626
|
# If you encrypt an object by using server-side encryption with
|
5657
5627
|
# customer-provided encryption keys (SSE-C) when you store the object in
|
5658
5628
|
# Amazon S3, then when you GET the object, you must use the following
|
5659
5629
|
# headers:
|
5660
5630
|
#
|
5661
|
-
# * x-amz-server-side-encryption-customer-algorithm
|
5631
|
+
# * `x-amz-server-side-encryption-customer-algorithm`
|
5662
5632
|
#
|
5663
|
-
# * x-amz-server-side-encryption-customer-key
|
5633
|
+
# * `x-amz-server-side-encryption-customer-key`
|
5664
5634
|
#
|
5665
|
-
# * x-amz-server-side-encryption-customer-key-MD5
|
5635
|
+
# * `x-amz-server-side-encryption-customer-key-MD5`
|
5666
5636
|
#
|
5667
5637
|
# For more information about SSE-C, see [Server-Side Encryption (Using
|
5668
5638
|
# Customer-Provided Encryption Keys)][5].
|
@@ -5677,20 +5647,21 @@ module Aws::S3
|
|
5677
5647
|
#
|
5678
5648
|
# : You need the relevant read object (or version) permission for this
|
5679
5649
|
# operation. For more information, see [Specifying Permissions in a
|
5680
|
-
# Policy][7]. If the object you request
|
5681
|
-
# Amazon S3 returns depends on whether you also have the
|
5650
|
+
# Policy][7]. If the object that you request doesn’t exist, the error
|
5651
|
+
# that Amazon S3 returns depends on whether you also have the
|
5682
5652
|
# `s3:ListBucket` permission.
|
5683
5653
|
#
|
5684
|
-
#
|
5685
|
-
#
|
5654
|
+
# If you have the `s3:ListBucket` permission on the bucket, Amazon S3
|
5655
|
+
# returns an HTTP status code 404 (Not Found) error.
|
5686
5656
|
#
|
5687
|
-
#
|
5688
|
-
#
|
5657
|
+
# If you don’t have the `s3:ListBucket` permission, Amazon S3 returns
|
5658
|
+
# an HTTP status code 403 ("access denied") error.
|
5689
5659
|
#
|
5690
5660
|
# Versioning
|
5691
5661
|
#
|
5692
|
-
# : By default, the GET action returns the current version of an
|
5693
|
-
# To return a different version, use the `versionId`
|
5662
|
+
# : By default, the `GET` action returns the current version of an
|
5663
|
+
# object. To return a different version, use the `versionId`
|
5664
|
+
# subresource.
|
5694
5665
|
#
|
5695
5666
|
# <note markdown="1"> * If you supply a `versionId`, you need the `s3:GetObjectVersion`
|
5696
5667
|
# permission to access a specific version of an object. If you
|
@@ -5710,18 +5681,18 @@ module Aws::S3
|
|
5710
5681
|
# Overriding Response Header Values
|
5711
5682
|
#
|
5712
5683
|
# : There are times when you want to override certain response header
|
5713
|
-
# values in a GET response. For example, you might override the
|
5714
|
-
# `Content-Disposition` response header value in your GET request.
|
5684
|
+
# values in a `GET` response. For example, you might override the
|
5685
|
+
# `Content-Disposition` response header value in your `GET` request.
|
5715
5686
|
#
|
5716
5687
|
# You can override values for a set of response headers using the
|
5717
5688
|
# following query parameters. These response header values are sent
|
5718
5689
|
# only on a successful request, that is, when status code 200 OK is
|
5719
5690
|
# returned. The set of headers you can override using these parameters
|
5720
5691
|
# is a subset of the headers that Amazon S3 accepts when you create an
|
5721
|
-
# object. The response headers that you can override for the GET
|
5692
|
+
# object. The response headers that you can override for the `GET`
|
5722
5693
|
# response are `Content-Type`, `Content-Language`, `Expires`,
|
5723
5694
|
# `Cache-Control`, `Content-Disposition`, and `Content-Encoding`. To
|
5724
|
-
# override these header values in the GET response, you use the
|
5695
|
+
# override these header values in the `GET` response, you use the
|
5725
5696
|
# following request parameters.
|
5726
5697
|
#
|
5727
5698
|
# <note markdown="1"> You must sign the request, either using an Authorization header or a
|
@@ -5799,7 +5770,7 @@ module Aws::S3
|
|
5799
5770
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5800
5771
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5801
5772
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5802
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5773
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5803
5774
|
#
|
5804
5775
|
#
|
5805
5776
|
#
|
@@ -6386,7 +6357,7 @@ module Aws::S3
|
|
6386
6357
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6387
6358
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6388
6359
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6389
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6360
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6390
6361
|
#
|
6391
6362
|
#
|
6392
6363
|
#
|
@@ -6439,9 +6410,8 @@ module Aws::S3
|
|
6439
6410
|
# Forbidden` (access denied).
|
6440
6411
|
#
|
6441
6412
|
# @option params [required, Array<String>] :object_attributes
|
6442
|
-
#
|
6443
|
-
#
|
6444
|
-
# returned.
|
6413
|
+
# Specifies the fields at the root level that you want returned in the
|
6414
|
+
# response. Fields that you do not specify are not returned.
|
6445
6415
|
#
|
6446
6416
|
# @return [Types::GetObjectAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6447
6417
|
#
|
@@ -6786,7 +6756,7 @@ module Aws::S3
|
|
6786
6756
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6787
6757
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6788
6758
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6789
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6759
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6790
6760
|
#
|
6791
6761
|
#
|
6792
6762
|
#
|
@@ -7119,7 +7089,7 @@ module Aws::S3
|
|
7119
7089
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7120
7090
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7121
7091
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7122
|
-
# [What is S3 on Outposts][3] in the *Amazon S3 User Guide*.
|
7092
|
+
# [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
|
7123
7093
|
#
|
7124
7094
|
#
|
7125
7095
|
#
|
@@ -7165,9 +7135,9 @@ module Aws::S3
|
|
7165
7135
|
req.send_request(options)
|
7166
7136
|
end
|
7167
7137
|
|
7168
|
-
# The HEAD action retrieves metadata from an object without returning
|
7138
|
+
# The `HEAD` action retrieves metadata from an object without returning
|
7169
7139
|
# the object itself. This action is useful if you're only interested in
|
7170
|
-
# an object's metadata. To use HEAD
|
7140
|
+
# an object's metadata. To use `HEAD`, you must have READ access to the
|
7171
7141
|
# object.
|
7172
7142
|
#
|
7173
7143
|
# A `HEAD` request has the same options as a `GET` action on an object.
|
@@ -7182,20 +7152,22 @@ module Aws::S3
|
|
7182
7152
|
# Amazon S3, then when you retrieve the metadata from the object, you
|
7183
7153
|
# must use the following headers:
|
7184
7154
|
#
|
7185
|
-
# * x-amz-server-side-encryption-customer-algorithm
|
7155
|
+
# * `x-amz-server-side-encryption-customer-algorithm`
|
7186
7156
|
#
|
7187
|
-
# * x-amz-server-side-encryption-customer-key
|
7157
|
+
# * `x-amz-server-side-encryption-customer-key`
|
7188
7158
|
#
|
7189
|
-
# * x-amz-server-side-encryption-customer-key-MD5
|
7159
|
+
# * `x-amz-server-side-encryption-customer-key-MD5`
|
7190
7160
|
#
|
7191
7161
|
# For more information about SSE-C, see [Server-Side Encryption (Using
|
7192
7162
|
# Customer-Provided Encryption Keys)][1].
|
7193
7163
|
#
|
7194
7164
|
# <note markdown="1"> * Encryption request headers, like `x-amz-server-side-encryption`,
|
7195
|
-
# should not be sent for GET requests if your object uses
|
7196
|
-
# encryption with
|
7197
|
-
#
|
7198
|
-
#
|
7165
|
+
# should not be sent for `GET` requests if your object uses
|
7166
|
+
# server-side encryption with Key Management Service (KMS) keys
|
7167
|
+
# (SSE-KMS), dual-layer server-side encryption with Amazon Web
|
7168
|
+
# Services KMS keys (DSSE-KMS), or server-side encryption with Amazon
|
7169
|
+
# S3 managed encryption keys (SSE-S3). If your object does use these
|
7170
|
+
# types of keys, you’ll get an HTTP 400 Bad Request error.
|
7199
7171
|
#
|
7200
7172
|
# * The last modified property in this case is the creation date of the
|
7201
7173
|
# object.
|
@@ -7231,15 +7203,15 @@ module Aws::S3
|
|
7231
7203
|
#
|
7232
7204
|
# : You need the relevant read object (or version) permission for this
|
7233
7205
|
# operation. For more information, see [Actions, resources, and
|
7234
|
-
# condition keys for Amazon S3][4]. If the object you request
|
7235
|
-
# exist, the error Amazon S3 returns depends on whether you also
|
7236
|
-
# the s3:ListBucket permission.
|
7206
|
+
# condition keys for Amazon S3][4]. If the object you request doesn't
|
7207
|
+
# exist, the error that Amazon S3 returns depends on whether you also
|
7208
|
+
# have the s3:ListBucket permission.
|
7237
7209
|
#
|
7238
7210
|
# * If you have the `s3:ListBucket` permission on the bucket, Amazon
|
7239
|
-
# S3 returns an HTTP status code 404
|
7211
|
+
# S3 returns an HTTP status code 404 error.
|
7240
7212
|
#
|
7241
7213
|
# * If you don’t have the `s3:ListBucket` permission, Amazon S3
|
7242
|
-
# returns an HTTP status code 403
|
7214
|
+
# returns an HTTP status code 403 error.
|
7243
7215
|
#
|
7244
7216
|
# The following actions are related to `HeadObject`:
|
7245
7217
|
#
|
@@ -7274,7 +7246,7 @@ module Aws::S3
|
|
7274
7246
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7275
7247
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7276
7248
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7277
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7249
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7278
7250
|
#
|
7279
7251
|
#
|
7280
7252
|
#
|
@@ -7534,7 +7506,7 @@ module Aws::S3
|
|
7534
7506
|
# retrieved.
|
7535
7507
|
#
|
7536
7508
|
# @option params [String] :continuation_token
|
7537
|
-
# The ContinuationToken that represents a placeholder from where this
|
7509
|
+
# The `ContinuationToken` that represents a placeholder from where this
|
7538
7510
|
# request should begin.
|
7539
7511
|
#
|
7540
7512
|
# @option params [String] :expected_bucket_owner
|
@@ -7720,7 +7692,7 @@ module Aws::S3
|
|
7720
7692
|
#
|
7721
7693
|
# @option params [String] :continuation_token
|
7722
7694
|
# The marker used to continue an inventory configuration listing that
|
7723
|
-
# has been truncated. Use the NextContinuationToken from a previously
|
7695
|
+
# has been truncated. Use the `NextContinuationToken` from a previously
|
7724
7696
|
# truncated list response to continue the listing. The continuation
|
7725
7697
|
# token is an opaque value that Amazon S3 understands.
|
7726
7698
|
#
|
@@ -7820,7 +7792,7 @@ module Aws::S3
|
|
7820
7792
|
#
|
7821
7793
|
# @option params [String] :continuation_token
|
7822
7794
|
# The marker that is used to continue a metrics configuration listing
|
7823
|
-
# that has been truncated. Use the NextContinuationToken from a
|
7795
|
+
# that has been truncated. Use the `NextContinuationToken` from a
|
7824
7796
|
# previously truncated list response to continue the listing. The
|
7825
7797
|
# continuation token is an opaque value that Amazon S3 understands.
|
7826
7798
|
#
|
@@ -7999,7 +7971,7 @@ module Aws::S3
|
|
7999
7971
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8000
7972
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8001
7973
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8002
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7974
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8003
7975
|
#
|
8004
7976
|
#
|
8005
7977
|
#
|
@@ -8018,15 +7990,15 @@ module Aws::S3
|
|
8018
7990
|
#
|
8019
7991
|
# @option params [String] :encoding_type
|
8020
7992
|
# Requests Amazon S3 to encode the object keys in the response and
|
8021
|
-
# specifies the encoding method to use. An object key
|
8022
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7993
|
+
# specifies the encoding method to use. An object key can contain any
|
7994
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
8023
7995
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
8024
7996
|
# characters that are not supported in XML 1.0, you can add this
|
8025
7997
|
# parameter to request that Amazon S3 encode the keys in the response.
|
8026
7998
|
#
|
8027
7999
|
# @option params [String] :key_marker
|
8028
|
-
# Together with upload-id-marker
|
8029
|
-
# upload after which listing should begin.
|
8000
|
+
# Together with `upload-id-marker`, this parameter specifies the
|
8001
|
+
# multipart upload after which listing should begin.
|
8030
8002
|
#
|
8031
8003
|
# If `upload-id-marker` is not specified, only the keys
|
8032
8004
|
# lexicographically greater than the specified `key-marker` will be
|
@@ -8045,8 +8017,8 @@ module Aws::S3
|
|
8045
8017
|
# @option params [String] :prefix
|
8046
8018
|
# Lists in-progress uploads only for those keys that begin with the
|
8047
8019
|
# specified prefix. You can use prefixes to separate a bucket into
|
8048
|
-
# different grouping of keys. (You can think of using prefix to make
|
8049
|
-
# groups in the same way you'd use a folder in a file system.)
|
8020
|
+
# different grouping of keys. (You can think of using `prefix` to make
|
8021
|
+
# groups in the same way that you'd use a folder in a file system.)
|
8050
8022
|
#
|
8051
8023
|
# @option params [String] :upload_id_marker
|
8052
8024
|
# Together with key-marker, specifies the multipart upload after which
|
@@ -8061,6 +8033,17 @@ module Aws::S3
|
|
8061
8033
|
# a different account, the request fails with the HTTP status code `403
|
8062
8034
|
# Forbidden` (access denied).
|
8063
8035
|
#
|
8036
|
+
# @option params [String] :request_payer
|
8037
|
+
# Confirms that the requester knows that they will be charged for the
|
8038
|
+
# request. Bucket owners need not specify this parameter in their
|
8039
|
+
# requests. For information about downloading objects from Requester
|
8040
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
8041
|
+
# in the *Amazon S3 User Guide*.
|
8042
|
+
#
|
8043
|
+
#
|
8044
|
+
#
|
8045
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
8046
|
+
#
|
8064
8047
|
# @return [Types::ListMultipartUploadsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8065
8048
|
#
|
8066
8049
|
# * {Types::ListMultipartUploadsOutput#bucket #bucket} => String
|
@@ -8075,6 +8058,7 @@ module Aws::S3
|
|
8075
8058
|
# * {Types::ListMultipartUploadsOutput#uploads #uploads} => Array<Types::MultipartUpload>
|
8076
8059
|
# * {Types::ListMultipartUploadsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
8077
8060
|
# * {Types::ListMultipartUploadsOutput#encoding_type #encoding_type} => String
|
8061
|
+
# * {Types::ListMultipartUploadsOutput#request_charged #request_charged} => String
|
8078
8062
|
#
|
8079
8063
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8080
8064
|
#
|
@@ -8185,6 +8169,7 @@ module Aws::S3
|
|
8185
8169
|
# prefix: "Prefix",
|
8186
8170
|
# upload_id_marker: "UploadIdMarker",
|
8187
8171
|
# expected_bucket_owner: "AccountId",
|
8172
|
+
# request_payer: "requester", # accepts requester
|
8188
8173
|
# })
|
8189
8174
|
#
|
8190
8175
|
# @example Response structure
|
@@ -8211,6 +8196,7 @@ module Aws::S3
|
|
8211
8196
|
# resp.common_prefixes #=> Array
|
8212
8197
|
# resp.common_prefixes[0].prefix #=> String
|
8213
8198
|
# resp.encoding_type #=> String, one of "url"
|
8199
|
+
# resp.request_charged #=> String, one of "requester"
|
8214
8200
|
#
|
8215
8201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads AWS API Documentation
|
8216
8202
|
#
|
@@ -8225,10 +8211,10 @@ module Aws::S3
|
|
8225
8211
|
# can also use request parameters as selection criteria to return
|
8226
8212
|
# metadata about a subset of all the object versions.
|
8227
8213
|
#
|
8228
|
-
# To use this operation, you must have
|
8214
|
+
# To use this operation, you must have permission to perform the
|
8229
8215
|
# `s3:ListBucketVersions` action. Be aware of the name difference.
|
8230
8216
|
#
|
8231
|
-
# <note markdown="1"> A 200 OK response can contain valid or invalid XML. Make sure to
|
8217
|
+
# <note markdown="1"> A `200 OK` response can contain valid or invalid XML. Make sure to
|
8232
8218
|
# design your application to parse the contents of the response and
|
8233
8219
|
# handle it appropriately.
|
8234
8220
|
#
|
@@ -8262,14 +8248,14 @@ module Aws::S3
|
|
8262
8248
|
# A delimiter is a character that you specify to group keys. All keys
|
8263
8249
|
# that contain the same string between the `prefix` and the first
|
8264
8250
|
# occurrence of the delimiter are grouped under a single result element
|
8265
|
-
# in CommonPrefixes
|
8266
|
-
# max-keys limitation. These keys are not returned elsewhere in
|
8267
|
-
# response.
|
8251
|
+
# in `CommonPrefixes`. These groups are counted as one result against
|
8252
|
+
# the `max-keys` limitation. These keys are not returned elsewhere in
|
8253
|
+
# the response.
|
8268
8254
|
#
|
8269
8255
|
# @option params [String] :encoding_type
|
8270
8256
|
# Requests Amazon S3 to encode the object keys in the response and
|
8271
|
-
# specifies the encoding method to use. An object key
|
8272
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
8257
|
+
# specifies the encoding method to use. An object key can contain any
|
8258
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
8273
8259
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
8274
8260
|
# characters that are not supported in XML 1.0, you can add this
|
8275
8261
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -8278,20 +8264,20 @@ module Aws::S3
|
|
8278
8264
|
# Specifies the key to start with when listing objects in a bucket.
|
8279
8265
|
#
|
8280
8266
|
# @option params [Integer] :max_keys
|
8281
|
-
# Sets the maximum number of keys returned in the response. By default
|
8267
|
+
# Sets the maximum number of keys returned in the response. By default,
|
8282
8268
|
# the action returns up to 1,000 key names. The response might contain
|
8283
8269
|
# fewer keys but will never contain more. If additional keys satisfy the
|
8284
|
-
# search criteria, but were not returned because max-keys was
|
8285
|
-
# the response contains
|
8286
|
-
# return the additional keys, see key-marker and version-id-marker
|
8270
|
+
# search criteria, but were not returned because `max-keys` was
|
8271
|
+
# exceeded, the response contains `<isTruncated>true</isTruncated>`. To
|
8272
|
+
# return the additional keys, see `key-marker` and `version-id-marker`.
|
8287
8273
|
#
|
8288
8274
|
# @option params [String] :prefix
|
8289
8275
|
# Use this parameter to select only those keys that begin with the
|
8290
8276
|
# specified prefix. You can use prefixes to separate a bucket into
|
8291
|
-
# different groupings of keys. (You can think of using prefix to make
|
8292
|
-
# groups in the same way you'd use a folder in a file system.) You
|
8293
|
-
# use prefix with delimiter to roll up numerous objects into a
|
8294
|
-
# result under CommonPrefixes
|
8277
|
+
# different groupings of keys. (You can think of using `prefix` to make
|
8278
|
+
# groups in the same way that you'd use a folder in a file system.) You
|
8279
|
+
# can use `prefix` with `delimiter` to roll up numerous objects into a
|
8280
|
+
# single result under `CommonPrefixes`.
|
8295
8281
|
#
|
8296
8282
|
# @option params [String] :version_id_marker
|
8297
8283
|
# Specifies the object version you want to start listing from.
|
@@ -8301,6 +8287,21 @@ module Aws::S3
|
|
8301
8287
|
# a different account, the request fails with the HTTP status code `403
|
8302
8288
|
# Forbidden` (access denied).
|
8303
8289
|
#
|
8290
|
+
# @option params [String] :request_payer
|
8291
|
+
# Confirms that the requester knows that they will be charged for the
|
8292
|
+
# request. Bucket owners need not specify this parameter in their
|
8293
|
+
# requests. For information about downloading objects from Requester
|
8294
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
8295
|
+
# in the *Amazon S3 User Guide*.
|
8296
|
+
#
|
8297
|
+
#
|
8298
|
+
#
|
8299
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
8300
|
+
#
|
8301
|
+
# @option params [Array<String>] :optional_object_attributes
|
8302
|
+
# Specifies the optional fields that you want returned in the response.
|
8303
|
+
# Fields that you do not specify are not returned.
|
8304
|
+
#
|
8304
8305
|
# @return [Types::ListObjectVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8305
8306
|
#
|
8306
8307
|
# * {Types::ListObjectVersionsOutput#is_truncated #is_truncated} => Boolean
|
@@ -8316,6 +8317,7 @@ module Aws::S3
|
|
8316
8317
|
# * {Types::ListObjectVersionsOutput#max_keys #max_keys} => Integer
|
8317
8318
|
# * {Types::ListObjectVersionsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
8318
8319
|
# * {Types::ListObjectVersionsOutput#encoding_type #encoding_type} => String
|
8320
|
+
# * {Types::ListObjectVersionsOutput#request_charged #request_charged} => String
|
8319
8321
|
#
|
8320
8322
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8321
8323
|
#
|
@@ -8374,6 +8376,8 @@ module Aws::S3
|
|
8374
8376
|
# prefix: "Prefix",
|
8375
8377
|
# version_id_marker: "VersionIdMarker",
|
8376
8378
|
# expected_bucket_owner: "AccountId",
|
8379
|
+
# request_payer: "requester", # accepts requester
|
8380
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
8377
8381
|
# })
|
8378
8382
|
#
|
8379
8383
|
# @example Response structure
|
@@ -8395,6 +8399,8 @@ module Aws::S3
|
|
8395
8399
|
# resp.versions[0].last_modified #=> Time
|
8396
8400
|
# resp.versions[0].owner.display_name #=> String
|
8397
8401
|
# resp.versions[0].owner.id #=> String
|
8402
|
+
# resp.versions[0].restore_status.is_restore_in_progress #=> Boolean
|
8403
|
+
# resp.versions[0].restore_status.restore_expiry_date #=> Time
|
8398
8404
|
# resp.delete_markers #=> Array
|
8399
8405
|
# resp.delete_markers[0].owner.display_name #=> String
|
8400
8406
|
# resp.delete_markers[0].owner.id #=> String
|
@@ -8409,6 +8415,7 @@ module Aws::S3
|
|
8409
8415
|
# resp.common_prefixes #=> Array
|
8410
8416
|
# resp.common_prefixes[0].prefix #=> String
|
8411
8417
|
# resp.encoding_type #=> String, one of "url"
|
8418
|
+
# resp.request_charged #=> String, one of "requester"
|
8412
8419
|
#
|
8413
8420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions AWS API Documentation
|
8414
8421
|
#
|
@@ -8467,7 +8474,7 @@ module Aws::S3
|
|
8467
8474
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8468
8475
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8469
8476
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8470
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8477
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8471
8478
|
#
|
8472
8479
|
#
|
8473
8480
|
#
|
@@ -8475,12 +8482,12 @@ module Aws::S3
|
|
8475
8482
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8476
8483
|
#
|
8477
8484
|
# @option params [String] :delimiter
|
8478
|
-
# A delimiter is a character you use to group keys.
|
8485
|
+
# A delimiter is a character that you use to group keys.
|
8479
8486
|
#
|
8480
8487
|
# @option params [String] :encoding_type
|
8481
8488
|
# Requests Amazon S3 to encode the object keys in the response and
|
8482
|
-
# specifies the encoding method to use. An object key
|
8483
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
8489
|
+
# specifies the encoding method to use. An object key can contain any
|
8490
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
8484
8491
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
8485
8492
|
# characters that are not supported in XML 1.0, you can add this
|
8486
8493
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -8491,7 +8498,7 @@ module Aws::S3
|
|
8491
8498
|
# bucket.
|
8492
8499
|
#
|
8493
8500
|
# @option params [Integer] :max_keys
|
8494
|
-
# Sets the maximum number of keys returned in the response. By default
|
8501
|
+
# Sets the maximum number of keys returned in the response. By default,
|
8495
8502
|
# the action returns up to 1,000 key names. The response might contain
|
8496
8503
|
# fewer keys but will never contain more.
|
8497
8504
|
#
|
@@ -8508,6 +8515,10 @@ module Aws::S3
|
|
8508
8515
|
# a different account, the request fails with the HTTP status code `403
|
8509
8516
|
# Forbidden` (access denied).
|
8510
8517
|
#
|
8518
|
+
# @option params [Array<String>] :optional_object_attributes
|
8519
|
+
# Specifies the optional fields that you want returned in the response.
|
8520
|
+
# Fields that you do not specify are not returned.
|
8521
|
+
#
|
8511
8522
|
# @return [Types::ListObjectsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8512
8523
|
#
|
8513
8524
|
# * {Types::ListObjectsOutput#is_truncated #is_truncated} => Boolean
|
@@ -8520,6 +8531,7 @@ module Aws::S3
|
|
8520
8531
|
# * {Types::ListObjectsOutput#max_keys #max_keys} => Integer
|
8521
8532
|
# * {Types::ListObjectsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
8522
8533
|
# * {Types::ListObjectsOutput#encoding_type #encoding_type} => String
|
8534
|
+
# * {Types::ListObjectsOutput#request_charged #request_charged} => String
|
8523
8535
|
#
|
8524
8536
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8525
8537
|
#
|
@@ -8573,6 +8585,7 @@ module Aws::S3
|
|
8573
8585
|
# prefix: "Prefix",
|
8574
8586
|
# request_payer: "requester", # accepts requester
|
8575
8587
|
# expected_bucket_owner: "AccountId",
|
8588
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
8576
8589
|
# })
|
8577
8590
|
#
|
8578
8591
|
# @example Response structure
|
@@ -8590,6 +8603,8 @@ module Aws::S3
|
|
8590
8603
|
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8591
8604
|
# resp.contents[0].owner.display_name #=> String
|
8592
8605
|
# resp.contents[0].owner.id #=> String
|
8606
|
+
# resp.contents[0].restore_status.is_restore_in_progress #=> Boolean
|
8607
|
+
# resp.contents[0].restore_status.restore_expiry_date #=> Time
|
8593
8608
|
# resp.name #=> String
|
8594
8609
|
# resp.prefix #=> String
|
8595
8610
|
# resp.delimiter #=> String
|
@@ -8597,6 +8612,7 @@ module Aws::S3
|
|
8597
8612
|
# resp.common_prefixes #=> Array
|
8598
8613
|
# resp.common_prefixes[0].prefix #=> String
|
8599
8614
|
# resp.encoding_type #=> String, one of "url"
|
8615
|
+
# resp.request_charged #=> String, one of "requester"
|
8600
8616
|
#
|
8601
8617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects AWS API Documentation
|
8602
8618
|
#
|
@@ -8614,21 +8630,23 @@ module Aws::S3
|
|
8614
8630
|
# parse the contents of the response and handle it appropriately.
|
8615
8631
|
# Objects are returned sorted in an ascending order of the respective
|
8616
8632
|
# key names in the list. For more information about listing objects, see
|
8617
|
-
# [Listing object keys programmatically][1]
|
8633
|
+
# [Listing object keys programmatically][1] in the *Amazon S3 User
|
8634
|
+
# Guide*.
|
8618
8635
|
#
|
8619
8636
|
# To use this operation, you must have READ access to the bucket.
|
8620
8637
|
#
|
8621
8638
|
# To use this action in an Identity and Access Management (IAM) policy,
|
8622
|
-
# you must have
|
8639
|
+
# you must have permission to perform the `s3:ListBucket` action. The
|
8623
8640
|
# bucket owner has this permission by default and can grant this
|
8624
8641
|
# permission to others. For more information about permissions, see
|
8625
8642
|
# [Permissions Related to Bucket Subresource Operations][2] and
|
8626
|
-
# [Managing Access Permissions to Your Amazon S3 Resources][3]
|
8643
|
+
# [Managing Access Permissions to Your Amazon S3 Resources][3] in the
|
8644
|
+
# *Amazon S3 User Guide*.
|
8627
8645
|
#
|
8628
8646
|
# This section describes the latest revision of this action. We
|
8629
|
-
# recommend that you use this revised API for application
|
8630
|
-
# For backward compatibility, Amazon S3 continues to
|
8631
|
-
# version of this API, [ListObjects][4].
|
8647
|
+
# recommend that you use this revised API operation for application
|
8648
|
+
# development. For backward compatibility, Amazon S3 continues to
|
8649
|
+
# support the prior version of this API operation, [ListObjects][4].
|
8632
8650
|
#
|
8633
8651
|
# To get a list of your buckets, see [ListBuckets][5].
|
8634
8652
|
#
|
@@ -8669,7 +8687,7 @@ module Aws::S3
|
|
8669
8687
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8670
8688
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8671
8689
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8672
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8690
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8673
8691
|
#
|
8674
8692
|
#
|
8675
8693
|
#
|
@@ -8677,13 +8695,13 @@ module Aws::S3
|
|
8677
8695
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
8678
8696
|
#
|
8679
8697
|
# @option params [String] :delimiter
|
8680
|
-
# A delimiter is a character you use to group keys.
|
8698
|
+
# A delimiter is a character that you use to group keys.
|
8681
8699
|
#
|
8682
8700
|
# @option params [String] :encoding_type
|
8683
8701
|
# Encoding type used by Amazon S3 to encode object keys in the response.
|
8684
8702
|
#
|
8685
8703
|
# @option params [Integer] :max_keys
|
8686
|
-
# Sets the maximum number of keys returned in the response. By default
|
8704
|
+
# Sets the maximum number of keys returned in the response. By default,
|
8687
8705
|
# the action returns up to 1,000 key names. The response might contain
|
8688
8706
|
# fewer keys but will never contain more.
|
8689
8707
|
#
|
@@ -8691,14 +8709,14 @@ module Aws::S3
|
|
8691
8709
|
# Limits the response to keys that begin with the specified prefix.
|
8692
8710
|
#
|
8693
8711
|
# @option params [String] :continuation_token
|
8694
|
-
# ContinuationToken indicates Amazon S3 that the list is being
|
8695
|
-
# on this bucket with a token. ContinuationToken is
|
8696
|
-
# not a real key.
|
8712
|
+
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
8713
|
+
# continued on this bucket with a token. `ContinuationToken` is
|
8714
|
+
# obfuscated and is not a real key.
|
8697
8715
|
#
|
8698
8716
|
# @option params [Boolean] :fetch_owner
|
8699
|
-
# The owner field is not present in
|
8700
|
-
# return owner field with each key in the result then set
|
8701
|
-
#
|
8717
|
+
# The owner field is not present in `ListObjectsV2` by default. If you
|
8718
|
+
# want to return the owner field with each key in the result, then set
|
8719
|
+
# the `FetchOwner` field to `true`.
|
8702
8720
|
#
|
8703
8721
|
# @option params [String] :start_after
|
8704
8722
|
# StartAfter is where you want Amazon S3 to start listing from. Amazon
|
@@ -8715,6 +8733,10 @@ module Aws::S3
|
|
8715
8733
|
# a different account, the request fails with the HTTP status code `403
|
8716
8734
|
# Forbidden` (access denied).
|
8717
8735
|
#
|
8736
|
+
# @option params [Array<String>] :optional_object_attributes
|
8737
|
+
# Specifies the optional fields that you want returned in the response.
|
8738
|
+
# Fields that you do not specify are not returned.
|
8739
|
+
#
|
8718
8740
|
# @return [Types::ListObjectsV2Output] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8719
8741
|
#
|
8720
8742
|
# * {Types::ListObjectsV2Output#is_truncated #is_truncated} => Boolean
|
@@ -8729,6 +8751,7 @@ module Aws::S3
|
|
8729
8751
|
# * {Types::ListObjectsV2Output#continuation_token #continuation_token} => String
|
8730
8752
|
# * {Types::ListObjectsV2Output#next_continuation_token #next_continuation_token} => String
|
8731
8753
|
# * {Types::ListObjectsV2Output#start_after #start_after} => String
|
8754
|
+
# * {Types::ListObjectsV2Output#request_charged #request_charged} => String
|
8732
8755
|
#
|
8733
8756
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8734
8757
|
#
|
@@ -8782,6 +8805,7 @@ module Aws::S3
|
|
8782
8805
|
# start_after: "StartAfter",
|
8783
8806
|
# request_payer: "requester", # accepts requester
|
8784
8807
|
# expected_bucket_owner: "AccountId",
|
8808
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
8785
8809
|
# })
|
8786
8810
|
#
|
8787
8811
|
# @example Response structure
|
@@ -8797,6 +8821,8 @@ module Aws::S3
|
|
8797
8821
|
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
8798
8822
|
# resp.contents[0].owner.display_name #=> String
|
8799
8823
|
# resp.contents[0].owner.id #=> String
|
8824
|
+
# resp.contents[0].restore_status.is_restore_in_progress #=> Boolean
|
8825
|
+
# resp.contents[0].restore_status.restore_expiry_date #=> Time
|
8800
8826
|
# resp.name #=> String
|
8801
8827
|
# resp.prefix #=> String
|
8802
8828
|
# resp.delimiter #=> String
|
@@ -8808,6 +8834,7 @@ module Aws::S3
|
|
8808
8834
|
# resp.continuation_token #=> String
|
8809
8835
|
# resp.next_continuation_token #=> String
|
8810
8836
|
# resp.start_after #=> String
|
8837
|
+
# resp.request_charged #=> String, one of "requester"
|
8811
8838
|
#
|
8812
8839
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2 AWS API Documentation
|
8813
8840
|
#
|
@@ -8884,7 +8911,7 @@ module Aws::S3
|
|
8884
8911
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8885
8912
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8886
8913
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8887
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8914
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8888
8915
|
#
|
8889
8916
|
#
|
8890
8917
|
#
|
@@ -9187,7 +9214,8 @@ module Aws::S3
|
|
9187
9214
|
#
|
9188
9215
|
# Permissions
|
9189
9216
|
#
|
9190
|
-
# : You can set access permissions using one of the following
|
9217
|
+
# : You can set access permissions by using one of the following
|
9218
|
+
# methods:
|
9191
9219
|
#
|
9192
9220
|
# * Specify a canned ACL with the `x-amz-acl` request header. Amazon
|
9193
9221
|
# S3 supports a set of predefined ACLs, known as *canned ACLs*. Each
|
@@ -9760,19 +9788,20 @@ module Aws::S3
|
|
9760
9788
|
# By default, all buckets have a default encryption configuration that
|
9761
9789
|
# uses server-side encryption with Amazon S3 managed keys (SSE-S3). You
|
9762
9790
|
# can optionally configure default encryption for a bucket by using
|
9763
|
-
# server-side encryption with
|
9764
|
-
#
|
9765
|
-
#
|
9766
|
-
#
|
9767
|
-
#
|
9768
|
-
#
|
9769
|
-
# the *Amazon S3 User Guide*.
|
9791
|
+
# server-side encryption with Key Management Service (KMS) keys
|
9792
|
+
# (SSE-KMS), dual-layer server-side encryption with Amazon Web Services
|
9793
|
+
# KMS keys (DSSE-KMS), or server-side encryption with customer-provided
|
9794
|
+
# keys (SSE-C). If you specify default encryption by using SSE-KMS, you
|
9795
|
+
# can also configure Amazon S3 Bucket Keys. For information about bucket
|
9796
|
+
# default encryption, see [Amazon S3 bucket default encryption][1] in
|
9797
|
+
# the *Amazon S3 User Guide*. For more information about S3 Bucket Keys,
|
9798
|
+
# see [Amazon S3 Bucket Keys][2] in the *Amazon S3 User Guide*.
|
9770
9799
|
#
|
9771
9800
|
# This action requires Amazon Web Services Signature Version 4. For more
|
9772
9801
|
# information, see [ Authenticating Requests (Amazon Web Services
|
9773
9802
|
# Signature Version 4)][3].
|
9774
9803
|
#
|
9775
|
-
# To use this operation, you must have
|
9804
|
+
# To use this operation, you must have permission to perform the
|
9776
9805
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
9777
9806
|
# permission by default. The bucket owner can grant this permission to
|
9778
9807
|
# others. For more information about permissions, see [Permissions
|
@@ -10314,11 +10343,11 @@ module Aws::S3
|
|
10314
10343
|
# 1,000 rules. This limit is not adjustable. Each rule consists of the
|
10315
10344
|
# following:
|
10316
10345
|
#
|
10317
|
-
# *
|
10318
|
-
# The filter can be based on a key name prefix, object
|
10319
|
-
# combination of both.
|
10346
|
+
# * A filter identifying a subset of objects to which the rule
|
10347
|
+
# applies. The filter can be based on a key name prefix, object
|
10348
|
+
# tags, or a combination of both.
|
10320
10349
|
#
|
10321
|
-
# *
|
10350
|
+
# * A status indicating whether the rule is in effect.
|
10322
10351
|
#
|
10323
10352
|
# * One or more lifecycle transition and expiration actions that you
|
10324
10353
|
# want Amazon S3 to perform on the objects identified by the filter.
|
@@ -10342,7 +10371,7 @@ module Aws::S3
|
|
10342
10371
|
# operation, a user must get the `s3:PutLifecycleConfiguration`
|
10343
10372
|
# permission.
|
10344
10373
|
#
|
10345
|
-
# You can also explicitly deny permissions.
|
10374
|
+
# You can also explicitly deny permissions. An explicit deny also
|
10346
10375
|
# supersedes any other permissions. If you want to block users or
|
10347
10376
|
# accounts from removing or deleting objects from your bucket, you
|
10348
10377
|
# must deny them permissions for the following actions:
|
@@ -10525,7 +10554,7 @@ module Aws::S3
|
|
10525
10554
|
# Grantee Values
|
10526
10555
|
#
|
10527
10556
|
# : You can specify the person (grantee) to whom you're assigning
|
10528
|
-
# access rights (using request elements) in the following ways:
|
10557
|
+
# access rights (by using request elements) in the following ways:
|
10529
10558
|
#
|
10530
10559
|
# * By the person's ID:
|
10531
10560
|
#
|
@@ -10533,23 +10562,23 @@ module Aws::S3
|
|
10533
10562
|
# xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
|
10534
10563
|
# </Grantee>`
|
10535
10564
|
#
|
10536
|
-
# DisplayName is optional and ignored in the request.
|
10565
|
+
# `DisplayName` is optional and ignored in the request.
|
10537
10566
|
#
|
10538
10567
|
# * By Email address:
|
10539
10568
|
#
|
10540
10569
|
# ` <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
10541
10570
|
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>`
|
10542
10571
|
#
|
10543
|
-
# The grantee is resolved to the CanonicalUser and, in a response
|
10544
|
-
# a
|
10572
|
+
# The grantee is resolved to the `CanonicalUser` and, in a response
|
10573
|
+
# to a `GETObjectAcl` request, appears as the CanonicalUser.
|
10545
10574
|
#
|
10546
10575
|
# * By URI:
|
10547
10576
|
#
|
10548
10577
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
10549
10578
|
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
|
10550
10579
|
#
|
10551
|
-
# To enable logging, you use LoggingEnabled and its children request
|
10552
|
-
# elements. To disable logging, you use an empty BucketLoggingStatus
|
10580
|
+
# To enable logging, you use `LoggingEnabled` and its children request
|
10581
|
+
# elements. To disable logging, you use an empty `BucketLoggingStatus`
|
10553
10582
|
# request element:
|
10554
10583
|
#
|
10555
10584
|
# `<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01"
|
@@ -10704,7 +10733,7 @@ module Aws::S3
|
|
10704
10733
|
#
|
10705
10734
|
# * [ListBucketMetricsConfigurations][6]
|
10706
10735
|
#
|
10707
|
-
# `
|
10736
|
+
# `PutBucketMetricsConfiguration` has the following special error:
|
10708
10737
|
#
|
10709
10738
|
# * Error code: `TooManyConfigurations`
|
10710
10739
|
#
|
@@ -10899,7 +10928,7 @@ module Aws::S3
|
|
10899
10928
|
#
|
10900
10929
|
# By default, only the bucket owner can configure notifications on a
|
10901
10930
|
# bucket. However, bucket owners can use a bucket policy to grant
|
10902
|
-
# permission to other users to set this configuration with
|
10931
|
+
# permission to other users to set this configuration with the required
|
10903
10932
|
# `s3:PutBucketNotification` permission.
|
10904
10933
|
#
|
10905
10934
|
# <note markdown="1"> The PUT notification is an atomic operation. For example, suppose your
|
@@ -12041,15 +12070,15 @@ module Aws::S3
|
|
12041
12070
|
#
|
12042
12071
|
# </note>
|
12043
12072
|
#
|
12044
|
-
# You have
|
12073
|
+
# You have four mutually exclusive options to protect data using
|
12045
12074
|
# server-side encryption in Amazon S3, depending on how you choose to
|
12046
12075
|
# manage the encryption keys. Specifically, the encryption key options
|
12047
12076
|
# are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys
|
12048
|
-
# (SSE-KMS), and customer-provided keys (SSE-C). Amazon S3
|
12049
|
-
# with server-side encryption by using Amazon S3 managed
|
12050
|
-
# by default. You can optionally tell Amazon S3 to encrypt
|
12051
|
-
# rest using server-side encryption with other key options.
|
12052
|
-
# information, see [Using Server-Side Encryption][3].
|
12077
|
+
# (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3
|
12078
|
+
# encrypts data with server-side encryption by using Amazon S3 managed
|
12079
|
+
# keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt
|
12080
|
+
# data at rest by using server-side encryption with other key options.
|
12081
|
+
# For more information, see [Using Server-Side Encryption][3].
|
12053
12082
|
#
|
12054
12083
|
# When adding a new object, you can use headers to grant ACL-based
|
12055
12084
|
# permissions to individual Amazon Web Services accounts or to
|
@@ -12145,7 +12174,7 @@ module Aws::S3
|
|
12145
12174
|
# When you use this action with S3 on Outposts through the Amazon Web
|
12146
12175
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
12147
12176
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12148
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
12177
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12149
12178
|
#
|
12150
12179
|
#
|
12151
12180
|
#
|
@@ -12312,7 +12341,7 @@ module Aws::S3
|
|
12312
12341
|
#
|
12313
12342
|
# @option params [String] :server_side_encryption
|
12314
12343
|
# The server-side encryption algorithm used when storing this object in
|
12315
|
-
# Amazon S3 (for example, AES256
|
12344
|
+
# Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
12316
12345
|
#
|
12317
12346
|
# @option params [String] :storage_class
|
12318
12347
|
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
@@ -12369,15 +12398,15 @@ module Aws::S3
|
|
12369
12398
|
# ensure that the encryption key was transmitted without error.
|
12370
12399
|
#
|
12371
12400
|
# @option params [String] :ssekms_key_id
|
12372
|
-
# If `x-amz-server-side-encryption` has a valid value of `aws:kms
|
12373
|
-
# header specifies the ID of the
|
12374
|
-
# Service (
|
12375
|
-
#
|
12376
|
-
# `x-amz-server-side-encryption:aws:kms`, but do not provide`
|
12401
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
12402
|
+
# `aws:kms:dsse`, this header specifies the ID of the Key Management
|
12403
|
+
# Service (KMS) symmetric encryption customer managed key that was used
|
12404
|
+
# for the object. If you specify `x-amz-server-side-encryption:aws:kms`
|
12405
|
+
# or `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
|
12377
12406
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
12378
|
-
# Amazon Web Services managed key to protect the data. If the
|
12379
|
-
# does not exist in the same account issuing the
|
12380
|
-
# the full ARN and not just the ID.
|
12407
|
+
# Amazon Web Services managed key (`aws/s3`) to protect the data. If the
|
12408
|
+
# KMS key does not exist in the same account that's issuing the
|
12409
|
+
# command, you must use the full ARN and not just the ID.
|
12381
12410
|
#
|
12382
12411
|
# @option params [String] :ssekms_encryption_context
|
12383
12412
|
# Specifies the Amazon Web Services KMS Encryption Context to use for
|
@@ -12389,9 +12418,9 @@ module Aws::S3
|
|
12389
12418
|
#
|
12390
12419
|
# @option params [Boolean] :bucket_key_enabled
|
12391
12420
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
12392
|
-
# encryption with server-side encryption using
|
12393
|
-
# Setting this header to `true` causes Amazon S3
|
12394
|
-
# for object encryption with SSE-KMS.
|
12421
|
+
# encryption with server-side encryption using Key Management Service
|
12422
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
12423
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
12395
12424
|
#
|
12396
12425
|
# Specifying this header with a PUT action doesn’t affect bucket-level
|
12397
12426
|
# settings for S3 Bucket Key.
|
@@ -12449,23 +12478,6 @@ module Aws::S3
|
|
12449
12478
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
12450
12479
|
#
|
12451
12480
|
#
|
12452
|
-
# @example Example: To upload an object
|
12453
|
-
#
|
12454
|
-
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
12455
|
-
# # syntax. S3 returns VersionId of the newly created object.
|
12456
|
-
#
|
12457
|
-
# resp = client.put_object({
|
12458
|
-
# body: "HappyFace.jpg",
|
12459
|
-
# bucket: "examplebucket",
|
12460
|
-
# key: "HappyFace.jpg",
|
12461
|
-
# })
|
12462
|
-
#
|
12463
|
-
# resp.to_h outputs the following:
|
12464
|
-
# {
|
12465
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12466
|
-
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
12467
|
-
# }
|
12468
|
-
#
|
12469
12481
|
# @example Example: To upload object and specify user-defined metadata
|
12470
12482
|
#
|
12471
12483
|
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
@@ -12523,60 +12535,77 @@ module Aws::S3
|
|
12523
12535
|
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
12524
12536
|
# }
|
12525
12537
|
#
|
12526
|
-
# @example Example: To upload an object and specify
|
12538
|
+
# @example Example: To upload an object and specify canned ACL.
|
12527
12539
|
#
|
12528
|
-
# # The following example uploads
|
12529
|
-
# #
|
12540
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
12541
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
12530
12542
|
#
|
12531
12543
|
# resp = client.put_object({
|
12544
|
+
# acl: "authenticated-read",
|
12532
12545
|
# body: "filetoupload",
|
12533
12546
|
# bucket: "examplebucket",
|
12534
12547
|
# key: "exampleobject",
|
12535
|
-
# server_side_encryption: "AES256",
|
12536
|
-
# tagging: "key1=value1&key2=value2",
|
12537
12548
|
# })
|
12538
12549
|
#
|
12539
12550
|
# resp.to_h outputs the following:
|
12540
12551
|
# {
|
12541
12552
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12542
|
-
#
|
12543
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
12553
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
12544
12554
|
# }
|
12545
12555
|
#
|
12546
|
-
# @example Example: To upload an object
|
12556
|
+
# @example Example: To upload an object
|
12547
12557
|
#
|
12548
|
-
# # The following example uploads an object
|
12549
|
-
# # S3 returns
|
12558
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
12559
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
12550
12560
|
#
|
12551
12561
|
# resp = client.put_object({
|
12552
|
-
# body: "
|
12562
|
+
# body: "HappyFace.jpg",
|
12553
12563
|
# bucket: "examplebucket",
|
12554
12564
|
# key: "HappyFace.jpg",
|
12555
|
-
# tagging: "key1=value1&key2=value2",
|
12556
12565
|
# })
|
12557
12566
|
#
|
12558
12567
|
# resp.to_h outputs the following:
|
12559
12568
|
# {
|
12560
12569
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12561
|
-
# version_id: "
|
12570
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
12562
12571
|
# }
|
12563
12572
|
#
|
12564
|
-
# @example Example: To upload an object and specify
|
12573
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
12565
12574
|
#
|
12566
|
-
# # The following example uploads
|
12567
|
-
# #
|
12575
|
+
# # The following example uploads an object. The request specifies the optional server-side encryption option. The request
|
12576
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
12568
12577
|
#
|
12569
12578
|
# resp = client.put_object({
|
12570
|
-
# acl: "authenticated-read",
|
12571
12579
|
# body: "filetoupload",
|
12572
12580
|
# bucket: "examplebucket",
|
12573
12581
|
# key: "exampleobject",
|
12582
|
+
# server_side_encryption: "AES256",
|
12583
|
+
# tagging: "key1=value1&key2=value2",
|
12574
12584
|
# })
|
12575
12585
|
#
|
12576
12586
|
# resp.to_h outputs the following:
|
12577
12587
|
# {
|
12578
12588
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12579
|
-
#
|
12589
|
+
# server_side_encryption: "AES256",
|
12590
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
12591
|
+
# }
|
12592
|
+
#
|
12593
|
+
# @example Example: To upload an object and specify optional tags
|
12594
|
+
#
|
12595
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
12596
|
+
# # S3 returns version ID of the newly created object.
|
12597
|
+
#
|
12598
|
+
# resp = client.put_object({
|
12599
|
+
# body: "c:\\HappyFace.jpg",
|
12600
|
+
# bucket: "examplebucket",
|
12601
|
+
# key: "HappyFace.jpg",
|
12602
|
+
# tagging: "key1=value1&key2=value2",
|
12603
|
+
# })
|
12604
|
+
#
|
12605
|
+
# resp.to_h outputs the following:
|
12606
|
+
# {
|
12607
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12608
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
12580
12609
|
# }
|
12581
12610
|
#
|
12582
12611
|
# @example Streaming a file from disk
|
@@ -12922,7 +12951,7 @@ module Aws::S3
|
|
12922
12951
|
# When you use this action with S3 on Outposts through the Amazon Web
|
12923
12952
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
12924
12953
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12925
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
12954
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12926
12955
|
#
|
12927
12956
|
#
|
12928
12957
|
#
|
@@ -13426,7 +13455,7 @@ module Aws::S3
|
|
13426
13455
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13427
13456
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13428
13457
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13429
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13458
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13430
13459
|
#
|
13431
13460
|
#
|
13432
13461
|
#
|
@@ -13725,19 +13754,20 @@ module Aws::S3
|
|
13725
13754
|
#
|
13726
13755
|
# Restoring objects
|
13727
13756
|
#
|
13728
|
-
# : Objects that you archive to the S3 Glacier Flexible Retrieval
|
13729
|
-
# Glacier Deep Archive storage class, and S3
|
13730
|
-
# Archive or S3 Intelligent-Tiering Deep Archive
|
13731
|
-
# accessible in real time. For objects in the S3
|
13732
|
-
# Retrieval or S3 Glacier Deep
|
13733
|
-
#
|
13734
|
-
#
|
13735
|
-
#
|
13736
|
-
# S3
|
13737
|
-
#
|
13738
|
-
#
|
13739
|
-
#
|
13740
|
-
# then wait until the object is
|
13757
|
+
# : Objects that you archive to the S3 Glacier Flexible Retrieval
|
13758
|
+
# Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3
|
13759
|
+
# Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive
|
13760
|
+
# tiers, are not accessible in real time. For objects in the S3
|
13761
|
+
# Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep
|
13762
|
+
# Archive storage classes, you must first initiate a restore request,
|
13763
|
+
# and then wait until a temporary copy of the object is available. If
|
13764
|
+
# you want a permanent copy of the object, create a copy of it in the
|
13765
|
+
# Amazon S3 Standard storage class in your S3 bucket. To access an
|
13766
|
+
# archived object, you must restore the object for the duration
|
13767
|
+
# (number of days) that you specify. For objects in the Archive Access
|
13768
|
+
# or Deep Archive Access tiers of S3 Intelligent-Tiering, you must
|
13769
|
+
# first initiate a restore request, and then wait until the object is
|
13770
|
+
# moved into the Frequent Access tier.
|
13741
13771
|
#
|
13742
13772
|
# To restore a specific object version, you can provide a version ID.
|
13743
13773
|
# If you don't provide a version ID, Amazon S3 restores the current
|
@@ -13748,37 +13778,38 @@ module Aws::S3
|
|
13748
13778
|
# request body:
|
13749
13779
|
#
|
13750
13780
|
# * `Expedited` - Expedited retrievals allow you to quickly access
|
13751
|
-
# your data stored in the S3 Glacier Flexible Retrieval
|
13752
|
-
# class or S3 Intelligent-Tiering Archive tier
|
13753
|
-
# urgent requests for restoring archives are
|
13754
|
-
# the largest archived objects (250 MB+), data
|
13755
|
-
# Expedited retrievals is typically made available
|
13756
|
-
# minutes. Provisioned capacity ensures that retrieval
|
13757
|
-
# Expedited retrievals is available when you need it.
|
13758
|
-
# retrievals and provisioned capacity are not available
|
13759
|
-
# stored in the S3 Glacier Deep Archive storage class or
|
13760
|
-
# Intelligent-Tiering Deep Archive tier.
|
13781
|
+
# your data stored in the S3 Glacier Flexible Retrieval Flexible
|
13782
|
+
# Retrieval storage class or S3 Intelligent-Tiering Archive tier
|
13783
|
+
# when occasional urgent requests for restoring archives are
|
13784
|
+
# required. For all but the largest archived objects (250 MB+), data
|
13785
|
+
# accessed using Expedited retrievals is typically made available
|
13786
|
+
# within 1–5 minutes. Provisioned capacity ensures that retrieval
|
13787
|
+
# capacity for Expedited retrievals is available when you need it.
|
13788
|
+
# Expedited retrievals and provisioned capacity are not available
|
13789
|
+
# for objects stored in the S3 Glacier Deep Archive storage class or
|
13790
|
+
# S3 Intelligent-Tiering Deep Archive tier.
|
13761
13791
|
#
|
13762
13792
|
# * `Standard` - Standard retrievals allow you to access any of your
|
13763
13793
|
# archived objects within several hours. This is the default option
|
13764
13794
|
# for retrieval requests that do not specify the retrieval option.
|
13765
13795
|
# Standard retrievals typically finish within 3–5 hours for objects
|
13766
|
-
# stored in the S3 Glacier Flexible Retrieval
|
13767
|
-
# Intelligent-Tiering Archive tier. They
|
13768
|
-
# hours for objects stored in the S3
|
13769
|
-
# class or S3 Intelligent-Tiering Deep
|
13770
|
-
# retrievals are free for objects stored in
|
13796
|
+
# stored in the S3 Glacier Flexible Retrieval Flexible Retrieval
|
13797
|
+
# storage class or S3 Intelligent-Tiering Archive tier. They
|
13798
|
+
# typically finish within 12 hours for objects stored in the S3
|
13799
|
+
# Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep
|
13800
|
+
# Archive tier. Standard retrievals are free for objects stored in
|
13801
|
+
# S3 Intelligent-Tiering.
|
13771
13802
|
#
|
13772
13803
|
# * `Bulk` - Bulk retrievals free for objects stored in the S3 Glacier
|
13773
13804
|
# Flexible Retrieval and S3 Intelligent-Tiering storage classes,
|
13774
13805
|
# enabling you to retrieve large amounts, even petabytes, of data at
|
13775
13806
|
# no cost. Bulk retrievals typically finish within 5–12 hours for
|
13776
|
-
# objects stored in the S3 Glacier Flexible Retrieval
|
13777
|
-
# or S3 Intelligent-Tiering Archive tier.
|
13778
|
-
# the lowest-cost retrieval option when
|
13779
|
-
# Glacier Deep Archive. They typically
|
13780
|
-
# objects stored in the S3 Glacier Deep
|
13781
|
-
# Intelligent-Tiering Deep Archive tier.
|
13807
|
+
# objects stored in the S3 Glacier Flexible Retrieval Flexible
|
13808
|
+
# Retrieval storage class or S3 Intelligent-Tiering Archive tier.
|
13809
|
+
# Bulk retrievals are also the lowest-cost retrieval option when
|
13810
|
+
# restoring objects from S3 Glacier Deep Archive. They typically
|
13811
|
+
# finish within 48 hours for objects stored in the S3 Glacier Deep
|
13812
|
+
# Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
|
13782
13813
|
#
|
13783
13814
|
# For more information about archive retrieval options and provisioned
|
13784
13815
|
# capacity for `Expedited` data access, see [Restoring Archived
|
@@ -13886,7 +13917,7 @@ module Aws::S3
|
|
13886
13917
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13887
13918
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13888
13919
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13889
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13920
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13890
13921
|
#
|
13891
13922
|
#
|
13892
13923
|
#
|
@@ -14139,10 +14170,14 @@ module Aws::S3
|
|
14139
14170
|
# the request parameters), you cannot specify the range of bytes of
|
14140
14171
|
# an object to return.
|
14141
14172
|
#
|
14142
|
-
# * GLACIER
|
14143
|
-
#
|
14144
|
-
# `
|
14145
|
-
#
|
14173
|
+
# * The `GLACIER`, `DEEP_ARCHIVE`, and `REDUCED_REDUNDANCY` storage
|
14174
|
+
# classes, or the `ARCHIVE_ACCESS` and `DEEP_ARCHIVE_ACCESS` access
|
14175
|
+
# tiers of the `INTELLIGENT_TIERING` storage class: You cannot query
|
14176
|
+
# objects in the `GLACIER`, `DEEP_ARCHIVE`, or `REDUCED_REDUNDANCY`
|
14177
|
+
# storage classes, nor objects in the `ARCHIVE_ACCESS` or
|
14178
|
+
# `DEEP_ARCHIVE_ACCESS` access tiers of the `INTELLIGENT_TIERING`
|
14179
|
+
# storage class. For more information about storage classes, see
|
14180
|
+
# [Using Amazon S3 storage classes][9] in the *Amazon S3 User
|
14146
14181
|
# Guide*.
|
14147
14182
|
#
|
14148
14183
|
# Special Errors
|
@@ -14168,7 +14203,7 @@ module Aws::S3
|
|
14168
14203
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
14169
14204
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html
|
14170
14205
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange
|
14171
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14206
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html
|
14172
14207
|
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList
|
14173
14208
|
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
14174
14209
|
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
@@ -14616,7 +14651,7 @@ module Aws::S3
|
|
14616
14651
|
# When you use this action with S3 on Outposts through the Amazon Web
|
14617
14652
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
14618
14653
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
14619
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
14654
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
14620
14655
|
#
|
14621
14656
|
#
|
14622
14657
|
#
|
@@ -14965,7 +15000,7 @@ module Aws::S3
|
|
14965
15000
|
# When you use this action with S3 on Outposts through the Amazon Web
|
14966
15001
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
14967
15002
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
14968
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
15003
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
14969
15004
|
#
|
14970
15005
|
#
|
14971
15006
|
#
|
@@ -15115,45 +15150,45 @@ module Aws::S3
|
|
15115
15150
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
15116
15151
|
#
|
15117
15152
|
#
|
15118
|
-
# @example Example: To upload a part by copying
|
15153
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
15119
15154
|
#
|
15120
|
-
# # The following example uploads a part of a multipart upload by copying
|
15121
|
-
# # data source.
|
15155
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
15122
15156
|
#
|
15123
15157
|
# resp = client.upload_part_copy({
|
15124
15158
|
# bucket: "examplebucket",
|
15125
15159
|
# copy_source: "/bucketname/sourceobjectkey",
|
15126
|
-
# copy_source_range: "bytes=1-100000",
|
15127
15160
|
# key: "examplelargeobject",
|
15128
|
-
# part_number:
|
15161
|
+
# part_number: 1,
|
15129
15162
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
15130
15163
|
# })
|
15131
15164
|
#
|
15132
15165
|
# resp.to_h outputs the following:
|
15133
15166
|
# {
|
15134
15167
|
# copy_part_result: {
|
15135
|
-
# etag: "\"
|
15136
|
-
# last_modified: Time.parse("2016-12-29T21:
|
15168
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
15169
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
15137
15170
|
# },
|
15138
15171
|
# }
|
15139
15172
|
#
|
15140
|
-
# @example Example: To upload a part by copying
|
15173
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
15141
15174
|
#
|
15142
|
-
# # The following example uploads a part of a multipart upload by copying
|
15175
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
15176
|
+
# # data source.
|
15143
15177
|
#
|
15144
15178
|
# resp = client.upload_part_copy({
|
15145
15179
|
# bucket: "examplebucket",
|
15146
15180
|
# copy_source: "/bucketname/sourceobjectkey",
|
15181
|
+
# copy_source_range: "bytes=1-100000",
|
15147
15182
|
# key: "examplelargeobject",
|
15148
|
-
# part_number:
|
15183
|
+
# part_number: 2,
|
15149
15184
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
15150
15185
|
# })
|
15151
15186
|
#
|
15152
15187
|
# resp.to_h outputs the following:
|
15153
15188
|
# {
|
15154
15189
|
# copy_part_result: {
|
15155
|
-
# etag: "\"
|
15156
|
-
# last_modified: Time.parse("2016-12-29T21:
|
15190
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
15191
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
15157
15192
|
# },
|
15158
15193
|
# }
|
15159
15194
|
#
|
@@ -15601,7 +15636,7 @@ module Aws::S3
|
|
15601
15636
|
params: params,
|
15602
15637
|
config: config)
|
15603
15638
|
context[:gem_name] = 'aws-sdk-s3'
|
15604
|
-
context[:gem_version] = '1.
|
15639
|
+
context[:gem_version] = '1.127.0'
|
15605
15640
|
Seahorse::Client::Request.new(handlers, context)
|
15606
15641
|
end
|
15607
15642
|
|