Struct aws_sdk_s3::input::GetObjectInput

source · [−]

#[non_exhaustive]
pub struct GetObjectInput { /* private fields */ }

Implementations

source

impl GetObjectInput

source

pub async fn presigned(
 self,
 config: &Config,
 presigning_config: PresigningConfig
) -> Result<PresignedRequest, SdkError<GetObjectError>>

Creates a presigned request for this operation.

The credentials provider from the config will be used to generate the request’s signature. The presigning_config provides additional presigning-specific config values, such as the amount of time the request should be valid for after creation.

Presigned requests can be given to other users or applications to access a resource or perform an operation without having access to the AWS security credentials.

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetObject, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<GetObject>

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetObjectInput.

source

impl GetObjectInput

source

pub fn bucket(&self) -> Option<&str>

The bucket name containing the object.

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 an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

source

pub fn if_match(&self) -> Option<&str>

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

source

pub fn if_modified_since(&self) -> Option<&DateTime>

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

source

pub fn if_none_match(&self) -> Option<&str>

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

source

pub fn if_unmodified_since(&self) -> Option<&DateTime>

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

source

pub fn key(&self) -> Option<&str>

Key of the object to get.

source

pub fn range(&self) -> Option<&str>

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

source

pub fn response_cache_control(&self) -> Option<&str>

Sets the Cache-Control header of the response.

source

pub fn response_content_disposition(&self) -> Option<&str>

Sets the Content-Disposition header of the response

source

pub fn response_content_encoding(&self) -> Option<&str>

Sets the Content-Encoding header of the response.

source

pub fn response_content_language(&self) -> Option<&str>

Sets the Content-Language header of the response.

source

pub fn response_content_type(&self) -> Option<&str>

Sets the Content-Type header of the response.

source

pub fn response_expires(&self) -> Option<&DateTime>

Sets the Expires header of the response.

source

pub fn version_id(&self) -> Option<&str>

VersionId used to reference a specific version of the object.

source

pub fn sse_customer_algorithm(&self) -> Option<&str>

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

source

pub fn sse_customer_key(&self) -> Option<&str>

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

source

pub fn sse_customer_key_md5(&self) -> Option<&str>

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

source

pub fn request_payer(&self) -> Option<&RequestPayer>

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

source

pub fn part_number(&self) -> i32

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

source

pub fn expected_bucket_owner(&self) -> Option<&str>

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

source