Struct aws_sdk_s3::client::fluent_builders::GetObjectLegalHold

pub struct GetObjectLegalHold<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetObjectLegalHold.

Gets an object's current Legal Hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Implementations

impl<C, M, R> GetObjectLegalHold<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetObjectLegalHoldOutput, SdkError<GetObjectLegalHoldError>> where
    R::Policy: SmithyRetryPolicy<GetObjectLegalHoldInputOperationOutputAlias, GetObjectLegalHoldOutput, GetObjectLegalHoldError, GetObjectLegalHoldInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn bucket(self, inp: impl Into<String>) -> Self

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 set_bucket(self, input: Option<String>) -> Self

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, inp: impl Into<String>) -> Self

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

pub fn set_key(self, input: Option<String>) -> Self

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

pub fn version_id(self, inp: impl Into<String>) -> Self

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

pub fn set_version_id(self, input: Option<String>) -> Self

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

pub fn request_payer(self, inp: RequestPayer) -> Self

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 set_request_payer(self, input: Option<RequestPayer>) -> Self

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, inp: impl Into<String>) -> Self

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.

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

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<C: Debug, M: Debug, R: Debug> Debug for GetObjectLegalHold<C, M, R>

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

Formats the value using the given formatter.