Struct aws_sdk_s3::input::GetObjectLegalHoldInput

#[non_exhaustive]
pub struct GetObjectLegalHoldInput {
    pub bucket: Option<String>,
    pub key: Option<String>,
    pub version_id: Option<String>,
    pub request_payer: Option<RequestPayer>,
    pub expected_bucket_owner: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket: Option<String>

The bucket name containing the object whose Legal Hold status you want to retrieve.

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.

key: Option<String>

The key name for the object whose Legal Hold status you want to retrieve.

version_id: Option<String>

The version ID of the object whose Legal Hold status you want to retrieve.

request_payer: 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 Requestor Pays Buckets in the Amazon S3 User Guide.

expected_bucket_owner: Option<String>

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.

Implementations

impl GetObjectLegalHoldInput

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

Consumes the builder and constructs an Operation<GetObjectLegalHold>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetObjectLegalHoldInput

impl GetObjectLegalHoldInput

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

The bucket name containing the object whose Legal Hold status you want to retrieve.

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.

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

The key name for the object whose Legal Hold status you want to retrieve.

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

The version ID of the object whose Legal Hold status you want to retrieve.

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 Requestor Pays Buckets in the Amazon S3 User Guide.

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 will fail with an HTTP 403 (Access Denied) error.

Trait Implementations

impl Clone for GetObjectLegalHoldInput

fn clone(&self) -> GetObjectLegalHoldInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetObjectLegalHoldInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<GetObjectLegalHoldInput> for GetObjectLegalHoldInput

fn eq(&self, other: &GetObjectLegalHoldInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GetObjectLegalHoldInput) -> bool

This method tests for !=.

impl StructuralPartialEq for GetObjectLegalHoldInput