aws-sdk-s3 1.126.0 → 1.128.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.
@@ -65,7 +65,7 @@ module Aws::S3
65
65
  # When you use this action with S3 on Outposts through the Amazon Web
66
66
  # Services SDKs, you provide the Outposts access point ARN in place of
67
67
  # the bucket name. For more information about S3 on Outposts ARNs, see
68
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
68
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
69
69
  #
70
70
  #
71
71
  #
@@ -718,7 +718,7 @@ module Aws::S3
718
718
  # When you use this action with S3 on Outposts through the Amazon Web
719
719
  # Services SDKs, you provide the Outposts access point ARN in place of
720
720
  # the bucket name. For more information about S3 on Outposts ARNs, see
721
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
721
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
722
722
  #
723
723
  #
724
724
  #
@@ -871,7 +871,7 @@ module Aws::S3
871
871
  # When you use this action with S3 on Outposts through the Amazon Web
872
872
  # Services SDKs, you provide the Outposts access point ARN in place of
873
873
  # the bucket name. For more information about S3 on Outposts ARNs, see
874
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
874
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
875
875
  #
876
876
  #
877
877
  #
@@ -1256,7 +1256,7 @@ module Aws::S3
1256
1256
  # When you use this action with S3 on Outposts through the Amazon Web
1257
1257
  # Services SDKs, you provide the Outposts access point ARN in place of
1258
1258
  # the bucket name. For more information about S3 on Outposts ARNs, see
1259
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
1259
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
1260
1260
  #
1261
1261
  #
1262
1262
  #
@@ -1895,7 +1895,7 @@ module Aws::S3
1895
1895
  # When you use this action with S3 on Outposts through the Amazon Web
1896
1896
  # Services SDKs, you provide the Outposts access point ARN in place of
1897
1897
  # the bucket name. For more information about S3 on Outposts ARNs, see
1898
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
1898
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
1899
1899
  #
1900
1900
  #
1901
1901
  #
@@ -2002,7 +2002,7 @@ module Aws::S3
2002
2002
  # When you use this action with S3 on Outposts through the Amazon Web
2003
2003
  # Services SDKs, you provide the Outposts access point ARN in place of
2004
2004
  # the bucket name. For more information about S3 on Outposts ARNs, see
2005
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
2005
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
2006
2006
  #
2007
2007
  #
2008
2008
  #
@@ -2671,7 +2671,7 @@ module Aws::S3
2671
2671
  # When you use this action with S3 on Outposts through the Amazon Web
2672
2672
  # Services SDKs, you provide the Outposts access point ARN in place of
2673
2673
  # the bucket name. For more information about S3 on Outposts ARNs, see
2674
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
2674
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
2675
2675
  #
2676
2676
  #
2677
2677
  #
@@ -2764,7 +2764,7 @@ module Aws::S3
2764
2764
  # When you use this action with S3 on Outposts through the Amazon Web
2765
2765
  # Services SDKs, you provide the Outposts access point ARN in place of
2766
2766
  # the bucket name. For more information about S3 on Outposts ARNs, see
2767
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
2767
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
2768
2768
  #
2769
2769
  #
2770
2770
  #
@@ -2842,7 +2842,7 @@ module Aws::S3
2842
2842
  # When you use this action with S3 on Outposts through the Amazon Web
2843
2843
  # Services SDKs, you provide the Outposts access point ARN in place of
2844
2844
  # the bucket name. For more information about S3 on Outposts ARNs, see
2845
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
2845
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
2846
2846
  #
2847
2847
  #
2848
2848
  #
@@ -5046,7 +5046,7 @@ module Aws::S3
5046
5046
  # When you use this action with S3 on Outposts through the Amazon Web
5047
5047
  # Services SDKs, you provide the Outposts access point ARN in place of
5048
5048
  # the bucket name. For more information about S3 on Outposts ARNs, see
5049
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
5049
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
5050
5050
  #
5051
5051
  #
5052
5052
  #
@@ -5109,9 +5109,8 @@ module Aws::S3
5109
5109
  # @return [String]
5110
5110
  #
5111
5111
  # @!attribute [rw] object_attributes
5112
- # An XML header that specifies the fields at the root level that you
5113
- # want returned in the response. Fields that you do not specify are
5114
- # not returned.
5112
+ # Specifies the fields at the root level that you want returned in the
5113
+ # response. Fields that you do not specify are not returned.
5115
5114
  # @return [Array<String>]
5116
5115
  #
5117
5116
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesRequest AWS API Documentation
@@ -5528,7 +5527,7 @@ module Aws::S3
5528
5527
  # When you use this action with S3 on Outposts through the Amazon Web
5529
5528
  # Services SDKs, you provide the Outposts access point ARN in place of
5530
5529
  # the bucket name. For more information about S3 on Outposts ARNs, see
5531
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
5530
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
5532
5531
  #
5533
5532
  #
5534
5533
  #
@@ -5787,7 +5786,7 @@ module Aws::S3
5787
5786
  # When you use this action with S3 on Outposts through the Amazon Web
5788
5787
  # Services SDKs, you provide the Outposts access point ARN in place of
5789
5788
  # the bucket name. For more information about S3 on Outposts ARNs, see
5790
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
5789
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
5791
5790
  #
5792
5791
  #
5793
5792
  #
@@ -6045,7 +6044,7 @@ module Aws::S3
6045
6044
  # When you use this action with S3 on Outposts through the Amazon Web
6046
6045
  # Services SDKs, you provide the Outposts access point ARN in place of
6047
6046
  # the bucket name. For more information about S3 on Outposts ARNs, see
6048
- # [What is S3 on Outposts][3] in the *Amazon S3 User Guide*.
6047
+ # [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
6049
6048
  #
6050
6049
  #
6051
6050
  #
@@ -6418,7 +6417,7 @@ module Aws::S3
6418
6417
  # When you use this action with S3 on Outposts through the Amazon Web
6419
6418
  # Services SDKs, you provide the Outposts access point ARN in place of
6420
6419
  # the bucket name. For more information about S3 on Outposts ARNs, see
6421
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
6420
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
6422
6421
  #
6423
6422
  #
6424
6423
  #
@@ -7242,8 +7241,8 @@ module Aws::S3
7242
7241
  # @return [String]
7243
7242
  #
7244
7243
  # @!attribute [rw] continuation_token
7245
- # The ContinuationToken that represents a placeholder from where this
7246
- # request should begin.
7244
+ # The `ContinuationToken` that represents a placeholder from where
7245
+ # this request should begin.
7247
7246
  # @return [String]
7248
7247
  #
7249
7248
  # @!attribute [rw] expected_bucket_owner
@@ -7355,9 +7354,9 @@ module Aws::S3
7355
7354
  #
7356
7355
  # @!attribute [rw] continuation_token
7357
7356
  # The marker used to continue an inventory configuration listing that
7358
- # has been truncated. Use the NextContinuationToken from a previously
7359
- # truncated list response to continue the listing. The continuation
7360
- # token is an opaque value that Amazon S3 understands.
7357
+ # has been truncated. Use the `NextContinuationToken` from a
7358
+ # previously truncated list response to continue the listing. The
7359
+ # continuation token is an opaque value that Amazon S3 understands.
7361
7360
  # @return [String]
7362
7361
  #
7363
7362
  # @!attribute [rw] expected_bucket_owner
@@ -7418,7 +7417,7 @@ module Aws::S3
7418
7417
  #
7419
7418
  # @!attribute [rw] continuation_token
7420
7419
  # The marker that is used to continue a metrics configuration listing
7421
- # that has been truncated. Use the NextContinuationToken from a
7420
+ # that has been truncated. Use the `NextContinuationToken` from a
7422
7421
  # previously truncated list response to continue the listing. The
7423
7422
  # continuation token is an opaque value that Amazon S3 understands.
7424
7423
  # @return [String]
@@ -7521,9 +7520,9 @@ module Aws::S3
7521
7520
  # Encoding type used by Amazon S3 to encode object keys in the
7522
7521
  # response.
7523
7522
  #
7524
- # If you specify `encoding-type` request parameter, Amazon S3 includes
7525
- # this element in the response, and returns encoded key name values in
7526
- # the following response elements:
7523
+ # If you specify the `encoding-type` request parameter, Amazon S3
7524
+ # includes this element in the response, and returns encoded key name
7525
+ # values in the following response elements:
7527
7526
  #
7528
7527
  # `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.
7529
7528
  # @return [String]
@@ -7572,7 +7571,7 @@ module Aws::S3
7572
7571
  # When you use this action with S3 on Outposts through the Amazon Web
7573
7572
  # Services SDKs, you provide the Outposts access point ARN in place of
7574
7573
  # the bucket name. For more information about S3 on Outposts ARNs, see
7575
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
7574
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
7576
7575
  #
7577
7576
  #
7578
7577
  #
@@ -7594,15 +7593,15 @@ module Aws::S3
7594
7593
  #
7595
7594
  # @!attribute [rw] encoding_type
7596
7595
  # Requests Amazon S3 to encode the object keys in the response and
7597
- # specifies the encoding method to use. An object key may contain any
7598
- # Unicode character; however, XML 1.0 parser cannot parse some
7596
+ # specifies the encoding method to use. An object key can contain any
7597
+ # Unicode character; however, the XML 1.0 parser cannot parse some
7599
7598
  # characters, such as characters with an ASCII value from 0 to 10. For
7600
7599
  # characters that are not supported in XML 1.0, you can add this
7601
7600
  # parameter to request that Amazon S3 encode the keys in the response.
7602
7601
  # @return [String]
7603
7602
  #
7604
7603
  # @!attribute [rw] key_marker
7605
- # Together with upload-id-marker, this parameter specifies the
7604
+ # Together with `upload-id-marker`, this parameter specifies the
7606
7605
  # multipart upload after which listing should begin.
7607
7606
  #
7608
7607
  # If `upload-id-marker` is not specified, only the keys
@@ -7624,8 +7623,8 @@ module Aws::S3
7624
7623
  # @!attribute [rw] prefix
7625
7624
  # Lists in-progress uploads only for those keys that begin with the
7626
7625
  # specified prefix. You can use prefixes to separate a bucket into
7627
- # different grouping of keys. (You can think of using prefix to make
7628
- # groups in the same way you'd use a folder in a file system.)
7626
+ # different grouping of keys. (You can think of using `prefix` to make
7627
+ # groups in the same way that you'd use a folder in a file system.)
7629
7628
  # @return [String]
7630
7629
  #
7631
7630
  # @!attribute [rw] upload_id_marker
@@ -7674,9 +7673,9 @@ module Aws::S3
7674
7673
  # @!attribute [rw] is_truncated
7675
7674
  # A flag that indicates whether Amazon S3 returned all of the results
7676
7675
  # that satisfied the search criteria. If your results were truncated,
7677
- # you can make a follow-up paginated request using the NextKeyMarker
7678
- # and NextVersionIdMarker response parameters as a starting place in
7679
- # another request to return the rest of the results.
7676
+ # you can make a follow-up paginated request by using the
7677
+ # `NextKeyMarker` and `NextVersionIdMarker` response parameters as a
7678
+ # starting place in another request to return the rest of the results.
7680
7679
  # @return [Boolean]
7681
7680
  #
7682
7681
  # @!attribute [rw] key_marker
@@ -7698,7 +7697,7 @@ module Aws::S3
7698
7697
  # When the number of responses exceeds the value of `MaxKeys`,
7699
7698
  # `NextVersionIdMarker` specifies the first object version not
7700
7699
  # returned that satisfies the search criteria. Use this value for the
7701
- # version-id-marker request parameter in a subsequent request.
7700
+ # `version-id-marker` request parameter in a subsequent request.
7702
7701
  # @return [String]
7703
7702
  #
7704
7703
  # @!attribute [rw] versions
@@ -7723,7 +7722,7 @@ module Aws::S3
7723
7722
  # that you specify to group keys. All keys that contain the same
7724
7723
  # string between the prefix and the first occurrence of the delimiter
7725
7724
  # are grouped under a single result element in `CommonPrefixes`. These
7726
- # groups are counted as one result against the max-keys limitation.
7725
+ # groups are counted as one result against the `max-keys` limitation.
7727
7726
  # These keys are not returned elsewhere in the response.
7728
7727
  # @return [String]
7729
7728
  #
@@ -7740,9 +7739,9 @@ module Aws::S3
7740
7739
  # Encoding type used by Amazon S3 to encode object key names in the
7741
7740
  # XML response.
7742
7741
  #
7743
- # If you specify encoding-type request parameter, Amazon S3 includes
7744
- # this element in the response, and returns encoded key name values in
7745
- # the following response elements:
7742
+ # If you specify the `encoding-type` request parameter, Amazon S3
7743
+ # includes this element in the response, and returns encoded key name
7744
+ # values in the following response elements:
7746
7745
  #
7747
7746
  # `KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.
7748
7747
  # @return [String]
@@ -7781,15 +7780,15 @@ module Aws::S3
7781
7780
  # A delimiter is a character that you specify to group keys. All keys
7782
7781
  # that contain the same string between the `prefix` and the first
7783
7782
  # occurrence of the delimiter are grouped under a single result
7784
- # element in CommonPrefixes. These groups are counted as one result
7785
- # against the max-keys limitation. These keys are not returned
7783
+ # element in `CommonPrefixes`. These groups are counted as one result
7784
+ # against the `max-keys` limitation. These keys are not returned
7786
7785
  # elsewhere in the response.
7787
7786
  # @return [String]
7788
7787
  #
7789
7788
  # @!attribute [rw] encoding_type
7790
7789
  # Requests Amazon S3 to encode the object keys in the response and
7791
- # specifies the encoding method to use. An object key may contain any
7792
- # Unicode character; however, XML 1.0 parser cannot parse some
7790
+ # specifies the encoding method to use. An object key can contain any
7791
+ # Unicode character; however, the XML 1.0 parser cannot parse some
7793
7792
  # characters, such as characters with an ASCII value from 0 to 10. For
7794
7793
  # characters that are not supported in XML 1.0, you can add this
7795
7794
  # parameter to request that Amazon S3 encode the keys in the response.
@@ -7800,22 +7799,22 @@ module Aws::S3
7800
7799
  # @return [String]
7801
7800
  #
7802
7801
  # @!attribute [rw] max_keys
7803
- # Sets the maximum number of keys returned in the response. By default
7804
- # the action returns up to 1,000 key names. The response might contain
7805
- # fewer keys but will never contain more. If additional keys satisfy
7806
- # the search criteria, but were not returned because max-keys was
7807
- # exceeded, the response contains
7808
- # &lt;isTruncated&gt;true&lt;/isTruncated&gt;. To return the
7809
- # additional keys, see key-marker and version-id-marker.
7802
+ # Sets the maximum number of keys returned in the response. By
7803
+ # default, the action returns up to 1,000 key names. The response
7804
+ # might contain fewer keys but will never contain more. If additional
7805
+ # keys satisfy the search criteria, but were not returned because
7806
+ # `max-keys` was exceeded, the response contains
7807
+ # `<isTruncated>true</isTruncated>`. To return the additional keys,
7808
+ # see `key-marker` and `version-id-marker`.
7810
7809
  # @return [Integer]
7811
7810
  #
7812
7811
  # @!attribute [rw] prefix
7813
7812
  # Use this parameter to select only those keys that begin with the
7814
7813
  # specified prefix. You can use prefixes to separate a bucket into
7815
- # different groupings of keys. (You can think of using prefix to make
7816
- # groups in the same way you'd use a folder in a file system.) You
7817
- # can use prefix with delimiter to roll up numerous objects into a
7818
- # single result under CommonPrefixes.
7814
+ # different groupings of keys. (You can think of using `prefix` to
7815
+ # make groups in the same way that you'd use a folder in a file
7816
+ # system.) You can use `prefix` with `delimiter` to roll up numerous
7817
+ # objects into a single result under `CommonPrefixes`.
7819
7818
  # @return [String]
7820
7819
  #
7821
7820
  # @!attribute [rw] version_id_marker
@@ -7840,6 +7839,11 @@ module Aws::S3
7840
7839
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
7841
7840
  # @return [String]
7842
7841
  #
7842
+ # @!attribute [rw] optional_object_attributes
7843
+ # Specifies the optional fields that you want returned in the
7844
+ # response. Fields that you do not specify are not returned.
7845
+ # @return [Array<String>]
7846
+ #
7843
7847
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsRequest AWS API Documentation
7844
7848
  #
7845
7849
  class ListObjectVersionsRequest < Struct.new(
@@ -7851,7 +7855,8 @@ module Aws::S3
7851
7855
  :prefix,
7852
7856
  :version_id_marker,
7853
7857
  :expected_bucket_owner,
7854
- :request_payer)
7858
+ :request_payer,
7859
+ :optional_object_attributes)
7855
7860
  SENSITIVE = []
7856
7861
  include Aws::Structure
7857
7862
  end
@@ -7867,14 +7872,18 @@ module Aws::S3
7867
7872
  # @return [String]
7868
7873
  #
7869
7874
  # @!attribute [rw] next_marker
7870
- # When response is truncated (the IsTruncated element value in the
7871
- # response is true), you can use the key name in this field as marker
7872
- # in the subsequent request to get next set of objects. Amazon S3
7873
- # lists objects in alphabetical order Note: This element is returned
7874
- # only if you have delimiter request parameter specified. If response
7875
- # does not include the NextMarker and it is truncated, you can use the
7876
- # value of the last Key in the response as the marker in the
7877
- # subsequent request to get the next set of object keys.
7875
+ # When the response is truncated (the `IsTruncated` element value in
7876
+ # the response is `true`), you can use the key name in this field as
7877
+ # the `marker` parameter in the subsequent request to get the next set
7878
+ # of objects. Amazon S3 lists objects in alphabetical order.
7879
+ #
7880
+ # <note markdown="1"> This element is returned only if you have the `delimiter` request
7881
+ # parameter specified. If the response does not include the
7882
+ # `NextMarker` element and it is truncated, you can use the value of
7883
+ # the last `Key` element in the response as the `marker` parameter in
7884
+ # the subsequent request to get the next set of object keys.
7885
+ #
7886
+ # </note>
7878
7887
  # @return [String]
7879
7888
  #
7880
7889
  # @!attribute [rw] contents
@@ -7905,19 +7914,20 @@ module Aws::S3
7905
7914
  # All of the keys (up to 1,000) rolled up in a common prefix count as
7906
7915
  # a single return when calculating the number of returns.
7907
7916
  #
7908
- # A response can contain CommonPrefixes only if you specify a
7917
+ # A response can contain `CommonPrefixes` only if you specify a
7909
7918
  # delimiter.
7910
7919
  #
7911
- # CommonPrefixes contains all (if there are any) keys between Prefix
7912
- # and the next occurrence of the string specified by the delimiter.
7920
+ # `CommonPrefixes` contains all (if there are any) keys between
7921
+ # `Prefix` and the next occurrence of the string specified by the
7922
+ # delimiter.
7913
7923
  #
7914
- # CommonPrefixes lists keys that act like subdirectories in the
7915
- # directory specified by Prefix.
7924
+ # `CommonPrefixes` lists keys that act like subdirectories in the
7925
+ # directory specified by `Prefix`.
7916
7926
  #
7917
- # For example, if the prefix is notes/ and the delimiter is a slash
7918
- # (/) as in notes/summer/july, the common prefix is notes/summer/. All
7919
- # of the keys that roll up into a common prefix count as a single
7920
- # return when calculating the number of returns.
7927
+ # For example, if the prefix is `notes/` and the delimiter is a slash
7928
+ # (`/`), as in `notes/summer/july`, the common prefix is
7929
+ # `notes/summer/`. All of the keys that roll up into a common prefix
7930
+ # count as a single return when calculating the number of returns.
7921
7931
  # @return [Array<Types::CommonPrefix>]
7922
7932
  #
7923
7933
  # @!attribute [rw] encoding_type
@@ -7967,7 +7977,7 @@ module Aws::S3
7967
7977
  # When you use this action with S3 on Outposts through the Amazon Web
7968
7978
  # Services SDKs, you provide the Outposts access point ARN in place of
7969
7979
  # the bucket name. For more information about S3 on Outposts ARNs, see
7970
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
7980
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
7971
7981
  #
7972
7982
  #
7973
7983
  #
@@ -7976,13 +7986,13 @@ module Aws::S3
7976
7986
  # @return [String]
7977
7987
  #
7978
7988
  # @!attribute [rw] delimiter
7979
- # A delimiter is a character you use to group keys.
7989
+ # A delimiter is a character that you use to group keys.
7980
7990
  # @return [String]
7981
7991
  #
7982
7992
  # @!attribute [rw] encoding_type
7983
7993
  # Requests Amazon S3 to encode the object keys in the response and
7984
- # specifies the encoding method to use. An object key may contain any
7985
- # Unicode character; however, XML 1.0 parser cannot parse some
7994
+ # specifies the encoding method to use. An object key can contain any
7995
+ # Unicode character; however, the XML 1.0 parser cannot parse some
7986
7996
  # characters, such as characters with an ASCII value from 0 to 10. For
7987
7997
  # characters that are not supported in XML 1.0, you can add this
7988
7998
  # parameter to request that Amazon S3 encode the keys in the response.
@@ -7995,9 +8005,9 @@ module Aws::S3
7995
8005
  # @return [String]
7996
8006
  #
7997
8007
  # @!attribute [rw] max_keys
7998
- # Sets the maximum number of keys returned in the response. By default
7999
- # the action returns up to 1,000 key names. The response might contain
8000
- # fewer keys but will never contain more.
8008
+ # Sets the maximum number of keys returned in the response. By
8009
+ # default, the action returns up to 1,000 key names. The response
8010
+ # might contain fewer keys but will never contain more.
8001
8011
  # @return [Integer]
8002
8012
  #
8003
8013
  # @!attribute [rw] prefix
@@ -8016,6 +8026,11 @@ module Aws::S3
8016
8026
  # `403 Forbidden` (access denied).
8017
8027
  # @return [String]
8018
8028
  #
8029
+ # @!attribute [rw] optional_object_attributes
8030
+ # Specifies the optional fields that you want returned in the
8031
+ # response. Fields that you do not specify are not returned.
8032
+ # @return [Array<String>]
8033
+ #
8019
8034
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation
8020
8035
  #
8021
8036
  class ListObjectsRequest < Struct.new(
@@ -8026,15 +8041,17 @@ module Aws::S3
8026
8041
  :max_keys,
8027
8042
  :prefix,
8028
8043
  :request_payer,
8029
- :expected_bucket_owner)
8044
+ :expected_bucket_owner,
8045
+ :optional_object_attributes)
8030
8046
  SENSITIVE = []
8031
8047
  include Aws::Structure
8032
8048
  end
8033
8049
 
8034
8050
  # @!attribute [rw] is_truncated
8035
- # Set to false if all of the results were returned. Set to true if
8051
+ # Set to `false` if all of the results were returned. Set to `true` if
8036
8052
  # more keys are available to return. If the number of results exceeds
8037
- # that specified by MaxKeys, all of the results might not be returned.
8053
+ # that specified by `MaxKeys`, all of the results might not be
8054
+ # returned.
8038
8055
  # @return [Boolean]
8039
8056
  #
8040
8057
  # @!attribute [rw] contents
@@ -8060,7 +8077,7 @@ module Aws::S3
8060
8077
  # When you use this action with S3 on Outposts through the Amazon Web
8061
8078
  # Services SDKs, you provide the Outposts access point ARN in place of
8062
8079
  # the bucket name. For more information about S3 on Outposts ARNs, see
8063
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
8080
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
8064
8081
  #
8065
8082
  #
8066
8083
  #
@@ -8073,17 +8090,17 @@ module Aws::S3
8073
8090
  # @return [String]
8074
8091
  #
8075
8092
  # @!attribute [rw] delimiter
8076
- # Causes keys that contain the same string between the prefix and the
8077
- # first occurrence of the delimiter to be rolled up into a single
8078
- # result element in the CommonPrefixes collection. These rolled-up
8093
+ # Causes keys that contain the same string between the `prefix` and
8094
+ # the first occurrence of the delimiter to be rolled up into a single
8095
+ # result element in the `CommonPrefixes` collection. These rolled-up
8079
8096
  # keys are not returned elsewhere in the response. Each rolled-up
8080
8097
  # result counts as only one return against the `MaxKeys` value.
8081
8098
  # @return [String]
8082
8099
  #
8083
8100
  # @!attribute [rw] max_keys
8084
- # Sets the maximum number of keys returned in the response. By default
8085
- # the action returns up to 1,000 key names. The response might contain
8086
- # fewer keys but will never contain more.
8101
+ # Sets the maximum number of keys returned in the response. By
8102
+ # default, the action returns up to 1,000 key names. The response
8103
+ # might contain fewer keys but will never contain more.
8087
8104
  # @return [Integer]
8088
8105
  #
8089
8106
  # @!attribute [rw] common_prefixes
@@ -8110,7 +8127,7 @@ module Aws::S3
8110
8127
  # Encoding type used by Amazon S3 to encode object key names in the
8111
8128
  # XML response.
8112
8129
  #
8113
- # If you specify the encoding-type request parameter, Amazon S3
8130
+ # If you specify the `encoding-type` request parameter, Amazon S3
8114
8131
  # includes this element in the response, and returns encoded key name
8115
8132
  # values in the following response elements:
8116
8133
  #
@@ -8118,13 +8135,14 @@ module Aws::S3
8118
8135
  # @return [String]
8119
8136
  #
8120
8137
  # @!attribute [rw] key_count
8121
- # KeyCount is the number of keys returned with this request. KeyCount
8122
- # will always be less than or equal to the `MaxKeys` field. Say you
8123
- # ask for 50 keys, your result will include 50 keys or fewer.
8138
+ # `KeyCount` is the number of keys returned with this request.
8139
+ # `KeyCount` will always be less than or equal to the `MaxKeys` field.
8140
+ # For example, if you ask for 50 keys, your result will include 50
8141
+ # keys or fewer.
8124
8142
  # @return [Integer]
8125
8143
  #
8126
8144
  # @!attribute [rw] continuation_token
8127
- # If ContinuationToken was sent with the request, it is included in
8145
+ # If `ContinuationToken` was sent with the request, it is included in
8128
8146
  # the response.
8129
8147
  # @return [String]
8130
8148
  #
@@ -8185,7 +8203,7 @@ module Aws::S3
8185
8203
  # When you use this action with S3 on Outposts through the Amazon Web
8186
8204
  # Services SDKs, you provide the Outposts access point ARN in place of
8187
8205
  # the bucket name. For more information about S3 on Outposts ARNs, see
8188
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
8206
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
8189
8207
  #
8190
8208
  #
8191
8209
  #
@@ -8194,7 +8212,7 @@ module Aws::S3
8194
8212
  # @return [String]
8195
8213
  #
8196
8214
  # @!attribute [rw] delimiter
8197
- # A delimiter is a character you use to group keys.
8215
+ # A delimiter is a character that you use to group keys.
8198
8216
  # @return [String]
8199
8217
  #
8200
8218
  # @!attribute [rw] encoding_type
@@ -8203,9 +8221,9 @@ module Aws::S3
8203
8221
  # @return [String]
8204
8222
  #
8205
8223
  # @!attribute [rw] max_keys
8206
- # Sets the maximum number of keys returned in the response. By default
8207
- # the action returns up to 1,000 key names. The response might contain
8208
- # fewer keys but will never contain more.
8224
+ # Sets the maximum number of keys returned in the response. By
8225
+ # default, the action returns up to 1,000 key names. The response
8226
+ # might contain fewer keys but will never contain more.
8209
8227
  # @return [Integer]
8210
8228
  #
8211
8229
  # @!attribute [rw] prefix
@@ -8213,15 +8231,15 @@ module Aws::S3
8213
8231
  # @return [String]
8214
8232
  #
8215
8233
  # @!attribute [rw] continuation_token
8216
- # ContinuationToken indicates Amazon S3 that the list is being
8217
- # continued on this bucket with a token. ContinuationToken is
8234
+ # `ContinuationToken` indicates to Amazon S3 that the list is being
8235
+ # continued on this bucket with a token. `ContinuationToken` is
8218
8236
  # obfuscated and is not a real key.
8219
8237
  # @return [String]
8220
8238
  #
8221
8239
  # @!attribute [rw] fetch_owner
8222
- # The owner field is not present in listV2 by default, if you want to
8223
- # return owner field with each key in the result then set the fetch
8224
- # owner field to true.
8240
+ # The owner field is not present in `ListObjectsV2` by default. If you
8241
+ # want to return the owner field with each key in the result, then set
8242
+ # the `FetchOwner` field to `true`.
8225
8243
  # @return [Boolean]
8226
8244
  #
8227
8245
  # @!attribute [rw] start_after
@@ -8242,6 +8260,11 @@ module Aws::S3
8242
8260
  # `403 Forbidden` (access denied).
8243
8261
  # @return [String]
8244
8262
  #
8263
+ # @!attribute [rw] optional_object_attributes
8264
+ # Specifies the optional fields that you want returned in the
8265
+ # response. Fields that you do not specify are not returned.
8266
+ # @return [Array<String>]
8267
+ #
8245
8268
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Request AWS API Documentation
8246
8269
  #
8247
8270
  class ListObjectsV2Request < Struct.new(
@@ -8254,7 +8277,8 @@ module Aws::S3
8254
8277
  :fetch_owner,
8255
8278
  :start_after,
8256
8279
  :request_payer,
8257
- :expected_bucket_owner)
8280
+ :expected_bucket_owner,
8281
+ :optional_object_attributes)
8258
8282
  SENSITIVE = []
8259
8283
  include Aws::Structure
8260
8284
  end
@@ -8305,7 +8329,7 @@ module Aws::S3
8305
8329
  #
8306
8330
  # @!attribute [rw] next_part_number_marker
8307
8331
  # When a list is truncated, this element specifies the last part in
8308
- # the list, as well as the value to use for the part-number-marker
8332
+ # the list, as well as the value to use for the `part-number-marker`
8309
8333
  # request parameter in a subsequent request.
8310
8334
  # @return [Integer]
8311
8335
  #
@@ -8394,7 +8418,7 @@ module Aws::S3
8394
8418
  # When you use this action with S3 on Outposts through the Amazon Web
8395
8419
  # Services SDKs, you provide the Outposts access point ARN in place of
8396
8420
  # the bucket name. For more information about S3 on Outposts ARNs, see
8397
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
8421
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
8398
8422
  #
8399
8423
  #
8400
8424
  #
@@ -8538,11 +8562,11 @@ module Aws::S3
8538
8562
  # A metadata key-value pair to store with an object.
8539
8563
  #
8540
8564
  # @!attribute [rw] name
8541
- # Name of the Object.
8565
+ # Name of the object.
8542
8566
  # @return [String]
8543
8567
  #
8544
8568
  # @!attribute [rw] value
8545
- # Value of the Object.
8569
+ # Value of the object.
8546
8570
  # @return [String]
8547
8571
  #
8548
8572
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetadataEntry AWS API Documentation
@@ -8957,6 +8981,18 @@ module Aws::S3
8957
8981
  # The owner of the object
8958
8982
  # @return [Types::Owner]
8959
8983
  #
8984
+ # @!attribute [rw] restore_status
8985
+ # Specifies the restoration status of an object. Objects in certain
8986
+ # storage classes must be restored before they can be retrieved. For
8987
+ # more information about these storage classes and how to work with
8988
+ # archived objects, see [ Working with archived objects][1] in the
8989
+ # *Amazon S3 User Guide*.
8990
+ #
8991
+ #
8992
+ #
8993
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
8994
+ # @return [Types::RestoreStatus]
8995
+ #
8960
8996
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Object AWS API Documentation
8961
8997
  #
8962
8998
  class Object < Struct.new(
@@ -8966,7 +9002,8 @@ module Aws::S3
8966
9002
  :checksum_algorithm,
8967
9003
  :size,
8968
9004
  :storage_class,
8969
- :owner)
9005
+ :owner,
9006
+ :restore_status)
8970
9007
  SENSITIVE = []
8971
9008
  include Aws::Structure
8972
9009
  end
@@ -9201,6 +9238,18 @@ module Aws::S3
9201
9238
  # Specifies the owner of the object.
9202
9239
  # @return [Types::Owner]
9203
9240
  #
9241
+ # @!attribute [rw] restore_status
9242
+ # Specifies the restoration status of an object. Objects in certain
9243
+ # storage classes must be restored before they can be retrieved. For
9244
+ # more information about these storage classes and how to work with
9245
+ # archived objects, see [ Working with archived objects][1] in the
9246
+ # *Amazon S3 User Guide*.
9247
+ #
9248
+ #
9249
+ #
9250
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
9251
+ # @return [Types::RestoreStatus]
9252
+ #
9204
9253
  # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectVersion AWS API Documentation
9205
9254
  #
9206
9255
  class ObjectVersion < Struct.new(
@@ -9212,7 +9261,8 @@ module Aws::S3
9212
9261
  :version_id,
9213
9262
  :is_latest,
9214
9263
  :last_modified,
9215
- :owner)
9264
+ :owner,
9265
+ :restore_status)
9216
9266
  SENSITIVE = []
9217
9267
  include Aws::Structure
9218
9268
  end
@@ -10668,7 +10718,7 @@ module Aws::S3
10668
10718
  # When you use this action with S3 on Outposts through the Amazon Web
10669
10719
  # Services SDKs, you provide the Outposts access point ARN in place of
10670
10720
  # the bucket name. For more information about S3 on Outposts ARNs, see
10671
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
10721
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
10672
10722
  #
10673
10723
  #
10674
10724
  #
@@ -11077,7 +11127,7 @@ module Aws::S3
11077
11127
  # When you use this action with S3 on Outposts through the Amazon Web
11078
11128
  # Services SDKs, you provide the Outposts access point ARN in place of
11079
11129
  # the bucket name. For more information about S3 on Outposts ARNs, see
11080
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
11130
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
11081
11131
  #
11082
11132
  #
11083
11133
  #
@@ -11586,7 +11636,7 @@ module Aws::S3
11586
11636
  # When you use this action with S3 on Outposts through the Amazon Web
11587
11637
  # Services SDKs, you provide the Outposts access point ARN in place of
11588
11638
  # the bucket name. For more information about S3 on Outposts ARNs, see
11589
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
11639
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
11590
11640
  #
11591
11641
  #
11592
11642
  #
@@ -12254,7 +12304,7 @@ module Aws::S3
12254
12304
  # When you use this action with S3 on Outposts through the Amazon Web
12255
12305
  # Services SDKs, you provide the Outposts access point ARN in place of
12256
12306
  # the bucket name. For more information about S3 on Outposts ARNs, see
12257
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
12307
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
12258
12308
  #
12259
12309
  #
12260
12310
  #
@@ -12372,6 +12422,49 @@ module Aws::S3
12372
12422
  include Aws::Structure
12373
12423
  end
12374
12424
 
12425
+ # Specifies the restoration status of an object. Objects in certain
12426
+ # storage classes must be restored before they can be retrieved. For
12427
+ # more information about these storage classes and how to work with
12428
+ # archived objects, see [ Working with archived objects][1] in the
12429
+ # *Amazon S3 User Guide*.
12430
+ #
12431
+ #
12432
+ #
12433
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
12434
+ #
12435
+ # @!attribute [rw] is_restore_in_progress
12436
+ # Specifies whether the object is currently being restored. If the
12437
+ # object restoration is in progress, the header returns the value
12438
+ # `TRUE`. For example:
12439
+ #
12440
+ # `x-amz-optional-object-attributes: IsRestoreInProgress="true"`
12441
+ #
12442
+ # If the object restoration has completed, the header returns the
12443
+ # value `FALSE`. For example:
12444
+ #
12445
+ # `x-amz-optional-object-attributes: IsRestoreInProgress="false",
12446
+ # RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
12447
+ #
12448
+ # If the object hasn't been restored, there is no header response.
12449
+ # @return [Boolean]
12450
+ #
12451
+ # @!attribute [rw] restore_expiry_date
12452
+ # Indicates when the restored copy will expire. This value is
12453
+ # populated only if the object has already been restored. For example:
12454
+ #
12455
+ # `x-amz-optional-object-attributes: IsRestoreInProgress="false",
12456
+ # RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
12457
+ # @return [Time]
12458
+ #
12459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreStatus AWS API Documentation
12460
+ #
12461
+ class RestoreStatus < Struct.new(
12462
+ :is_restore_in_progress,
12463
+ :restore_expiry_date)
12464
+ SENSITIVE = []
12465
+ include Aws::Structure
12466
+ end
12467
+
12375
12468
  # Specifies the redirect behavior and when a redirect is applied. For
12376
12469
  # more information about routing rules, see [Configuring advanced
12377
12470
  # conditional redirects][1] in the *Amazon S3 User Guide*.
@@ -13311,7 +13404,7 @@ module Aws::S3
13311
13404
  # When you use this action with S3 on Outposts through the Amazon Web
13312
13405
  # Services SDKs, you provide the Outposts access point ARN in place of
13313
13406
  # the bucket name. For more information about S3 on Outposts ARNs, see
13314
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
13407
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
13315
13408
  #
13316
13409
  #
13317
13410
  #
@@ -13627,7 +13720,7 @@ module Aws::S3
13627
13720
  # When you use this action with S3 on Outposts through the Amazon Web
13628
13721
  # Services SDKs, you provide the Outposts access point ARN in place of
13629
13722
  # the bucket name. For more information about S3 on Outposts ARNs, see
13630
- # [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
13723
+ # [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
13631
13724
  #
13632
13725
  #
13633
13726
  #