/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class AWS_S3_API ListObjectsRequest : public S3Request { public: ListObjectsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListObjects"; } Aws::String SerializePayload() const override; void AddQueryStringParameters(Aws::Http::URI& uri) const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the bucket containing the objects.

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

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

*/ inline const Aws::String& GetBucket() const{ return m_bucket; } /** *

The name of the bucket containing the objects.

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

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

*/ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** *

The name of the bucket containing the objects.

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

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

*/ inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } /** *

The name of the bucket containing the objects.

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

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

*/ inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } /** *

The name of the bucket containing the objects.

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

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

*/ inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } /** *

The name of the bucket containing the objects.

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

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

*/ inline ListObjectsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} /** *

The name of the bucket containing the objects.

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

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

*/ inline ListObjectsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** *

The name of the bucket containing the objects.

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

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

*/ inline ListObjectsRequest& WithBucket(const char* value) { SetBucket(value); return *this;} /** *

A delimiter is a character you use to group keys.

*/ inline const Aws::String& GetDelimiter() const{ return m_delimiter; } /** *

A delimiter is a character you use to group keys.

*/ inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; } /** *

A delimiter is a character you use to group keys.

*/ inline void SetDelimiter(const Aws::String& value) { m_delimiterHasBeenSet = true; m_delimiter = value; } /** *

A delimiter is a character you use to group keys.

*/ inline void SetDelimiter(Aws::String&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::move(value); } /** *

A delimiter is a character you use to group keys.

*/ inline void SetDelimiter(const char* value) { m_delimiterHasBeenSet = true; m_delimiter.assign(value); } /** *

A delimiter is a character you use to group keys.

*/ inline ListObjectsRequest& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;} /** *

A delimiter is a character you use to group keys.

*/ inline ListObjectsRequest& WithDelimiter(Aws::String&& value) { SetDelimiter(std::move(value)); return *this;} /** *

A delimiter is a character you use to group keys.

*/ inline ListObjectsRequest& WithDelimiter(const char* value) { SetDelimiter(value); return *this;} inline const EncodingType& GetEncodingType() const{ return m_encodingType; } inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; } inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; } inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = std::move(value); } inline ListObjectsRequest& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;} inline ListObjectsRequest& WithEncodingType(EncodingType&& value) { SetEncodingType(std::move(value)); return *this;} /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline const Aws::String& GetMarker() const{ return m_marker; } /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline ListObjectsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline ListObjectsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts * listing after this specified key. Marker can be any key in the bucket.

*/ inline ListObjectsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** *

Sets the maximum number of keys returned in the response. By default the * action returns up to 1,000 key names. The response might contain fewer keys but * will never contain more.

*/ inline int GetMaxKeys() const{ return m_maxKeys; } /** *

Sets the maximum number of keys returned in the response. By default the * action returns up to 1,000 key names. The response might contain fewer keys but * will never contain more.

*/ inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; } /** *

Sets the maximum number of keys returned in the response. By default the * action returns up to 1,000 key names. The response might contain fewer keys but * will never contain more.

*/ inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; } /** *

Sets the maximum number of keys returned in the response. By default the * action returns up to 1,000 key names. The response might contain fewer keys but * will never contain more.

*/ inline ListObjectsRequest& WithMaxKeys(int value) { SetMaxKeys(value); return *this;} /** *

Limits the response to keys that begin with the specified prefix.

*/ inline const Aws::String& GetPrefix() const{ return m_prefix; } /** *

Limits the response to keys that begin with the specified prefix.

*/ inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; } /** *

Limits the response to keys that begin with the specified prefix.

*/ inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; } /** *

Limits the response to keys that begin with the specified prefix.

*/ inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); } /** *

Limits the response to keys that begin with the specified prefix.

*/ inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); } /** *

Limits the response to keys that begin with the specified prefix.

*/ inline ListObjectsRequest& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;} /** *

Limits the response to keys that begin with the specified prefix.

*/ inline ListObjectsRequest& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;} /** *

Limits the response to keys that begin with the specified prefix.

*/ inline ListObjectsRequest& WithPrefix(const char* value) { SetPrefix(value); return *this;} /** *

Confirms that the requester knows that she or he will be charged for the list * objects request. Bucket owners need not specify this parameter in their * requests.

*/ inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; } /** *

Confirms that the requester knows that she or he will be charged for the list * objects request. Bucket owners need not specify this parameter in their * requests.

*/ inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; } /** *

Confirms that the requester knows that she or he will be charged for the list * objects request. Bucket owners need not specify this parameter in their * requests.

*/ inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; } /** *

Confirms that the requester knows that she or he will be charged for the list * objects request. Bucket owners need not specify this parameter in their * requests.

*/ inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); } /** *

Confirms that the requester knows that she or he will be charged for the list * objects request. Bucket owners need not specify this parameter in their * requests.

*/ inline ListObjectsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;} /** *

Confirms that the requester knows that she or he will be charged for the list * objects request. Bucket owners need not specify this parameter in their * requests.

*/ inline ListObjectsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;} /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline ListObjectsRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline ListObjectsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} /** *

The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request will fail with an HTTP 403 (Access * Denied) error.

*/ inline ListObjectsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} inline const Aws::Map& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } inline void SetCustomizedAccessLogTag(const Aws::Map& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } inline void SetCustomizedAccessLogTag(Aws::Map&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } inline ListObjectsRequest& WithCustomizedAccessLogTag(const Aws::Map& value) { SetCustomizedAccessLogTag(value); return *this;} inline ListObjectsRequest& WithCustomizedAccessLogTag(Aws::Map&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} inline ListObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline ListObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } inline ListObjectsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline ListObjectsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } private: Aws::String m_bucket; bool m_bucketHasBeenSet; Aws::String m_delimiter; bool m_delimiterHasBeenSet; EncodingType m_encodingType; bool m_encodingTypeHasBeenSet; Aws::String m_marker; bool m_markerHasBeenSet; int m_maxKeys; bool m_maxKeysHasBeenSet; Aws::String m_prefix; bool m_prefixHasBeenSet; RequestPayer m_requestPayer; bool m_requestPayerHasBeenSet; Aws::String m_expectedBucketOwner; bool m_expectedBucketOwnerHasBeenSet; Aws::Map m_customizedAccessLogTag; bool m_customizedAccessLogTagHasBeenSet; }; } // namespace Model } // namespace S3 } // namespace Aws