# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.S3 do
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
error() :: %{
"Code" => String.t(),
"Key" => String.t(),
"Message" => String.t(),
"VersionId" => String.t()
}
"""
@type error() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_policy_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ConfirmRemoveSelfBucketAccess") => boolean(),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("Policy") => String.t()
}
"""
@type put_bucket_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_logging_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("BucketLoggingStatus") => bucket_logging_status()
}
"""
@type put_bucket_logging_request() :: %{String.t() => any()}
@typedoc """
## Example:
inventory_s3_bucket_destination() :: %{
"AccountId" => String.t(),
"Bucket" => String.t(),
"Encryption" => inventory_encryption(),
"Format" => list(any()),
"Prefix" => String.t()
}
"""
@type inventory_s3_bucket_destination() :: %{String.t() => any()}
@typedoc """
## Example:
records_event() :: %{
"Payload" => binary()
}
"""
@type records_event() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_metrics_configurations_output() :: %{
"ContinuationToken" => String.t(),
"IsTruncated" => boolean(),
"MetricsConfigurationList" => list(metrics_configuration()()),
"NextContinuationToken" => String.t()
}
"""
@type list_bucket_metrics_configurations_output() :: %{String.t() => any()}
@typedoc """
## Example:
delete_object_request() :: %{
optional("BypassGovernanceRetention") => boolean(),
optional("ExpectedBucketOwner") => String.t(),
optional("IfMatch") => String.t(),
optional("IfMatchLastModifiedTime") => non_neg_integer(),
optional("IfMatchSize") => float(),
optional("MFA") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t()
}
"""
@type delete_object_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_accelerate_configuration_output() :: %{
"RequestCharged" => list(any()),
"Status" => list(any())
}
"""
@type get_bucket_accelerate_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
c_o_r_s_configuration() :: %{
"CORSRules" => list(c_o_r_s_rule()())
}
"""
@type c_o_r_s_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_ownership_controls_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_ownership_controls_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_metrics_configurations_request() :: %{
optional("ContinuationToken") => String.t(),
optional("ExpectedBucketOwner") => String.t()
}
"""
@type list_bucket_metrics_configurations_request() :: %{String.t() => any()}
@typedoc """
## Example:
no_such_key() :: %{}
"""
@type no_such_key() :: %{}
@typedoc """
## Example:
get_bucket_policy_output() :: %{
"Policy" => String.t()
}
"""
@type get_bucket_policy_output() :: %{String.t() => any()}
@typedoc """
## Example:
encryption_configuration() :: %{
"ReplicaKmsKeyID" => String.t()
}
"""
@type encryption_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_versioning_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("MFA") => String.t(),
required("VersioningConfiguration") => versioning_configuration()
}
"""
@type put_bucket_versioning_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_torrent_output() :: %{
"Body" => binary(),
"RequestCharged" => list(any())
}
"""
@type get_object_torrent_output() :: %{String.t() => any()}
@typedoc """
## Example:
delete_object_tagging_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("VersionId") => String.t()
}
"""
@type delete_object_tagging_request() :: %{String.t() => any()}
@typedoc """
## Example:
inventory_configuration() :: %{
"Destination" => inventory_destination(),
"Filter" => inventory_filter(),
"Id" => String.t(),
"IncludedObjectVersions" => list(any()),
"IsEnabled" => boolean(),
"OptionalFields" => list(list(any())()),
"Schedule" => inventory_schedule()
}
"""
@type inventory_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
copy_object_result() :: %{
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ChecksumType" => list(any()),
"ETag" => String.t(),
"LastModified" => non_neg_integer()
}
"""
@type copy_object_result() :: %{String.t() => any()}
@typedoc """
## Example:
public_access_block_configuration() :: %{
"BlockPublicAcls" => boolean(),
"BlockPublicPolicy" => boolean(),
"IgnorePublicAcls" => boolean(),
"RestrictPublicBuckets" => boolean()
}
"""
@type public_access_block_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_accelerate_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any())
}
"""
@type get_bucket_accelerate_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
inventory_schedule() :: %{
"Frequency" => list(any())
}
"""
@type inventory_schedule() :: %{String.t() => any()}
@typedoc """
## Example:
write_get_object_response_request() :: %{
optional("VersionId") => String.t(),
optional("ChecksumCRC32C") => String.t(),
optional("Expires") => non_neg_integer(),
optional("Body") => binary(),
optional("DeleteMarker") => boolean(),
optional("ChecksumSHA256") => String.t(),
optional("ReplicationStatus") => list(any()),
optional("PartsCount") => integer(),
optional("Metadata") => map(),
optional("SSECustomerAlgorithm") => String.t(),
optional("ContentRange") => String.t(),
optional("TagCount") => integer(),
optional("Restore") => String.t(),
optional("BucketKeyEnabled") => boolean(),
optional("SSECustomerKeyMD5") => String.t(),
optional("LastModified") => non_neg_integer(),
optional("ContentDisposition") => String.t(),
optional("ChecksumCRC64NVME") => String.t(),
optional("ChecksumSHA1") => String.t(),
optional("ContentLanguage") => String.t(),
optional("RequestCharged") => list(any()),
optional("ETag") => String.t(),
optional("ServerSideEncryption") => list(any()),
optional("ErrorCode") => String.t(),
optional("ContentEncoding") => String.t(),
optional("StatusCode") => integer(),
optional("ObjectLockRetainUntilDate") => non_neg_integer(),
optional("ContentType") => String.t(),
optional("ErrorMessage") => String.t(),
required("RequestRoute") => String.t(),
optional("ChecksumCRC32") => String.t(),
optional("ContentLength") => float(),
optional("CacheControl") => String.t(),
optional("MissingMeta") => integer(),
optional("ObjectLockLegalHoldStatus") => list(any()),
optional("Expiration") => String.t(),
required("RequestToken") => String.t(),
optional("StorageClass") => list(any()),
optional("SSEKMSKeyId") => String.t(),
optional("ObjectLockMode") => list(any()),
optional("AcceptRanges") => String.t()
}
"""
@type write_get_object_response_request() :: %{String.t() => any()}
@typedoc """
## Example:
target_grant() :: %{
"Grantee" => grantee(),
"Permission" => list(any())
}
"""
@type target_grant() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_website_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_website_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_ownership_controls_output() :: %{
"OwnershipControls" => ownership_controls()
}
"""
@type get_bucket_ownership_controls_output() :: %{String.t() => any()}
@typedoc """
## Example:
ownership_controls_rule() :: %{
"ObjectOwnership" => list(any())
}
"""
@type ownership_controls_rule() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_request_payment_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_request_payment_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_public_access_block_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("PublicAccessBlockConfiguration") => public_access_block_configuration()
}
"""
@type put_public_access_block_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_tagging_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t()
}
"""
@type get_object_tagging_request() :: %{String.t() => any()}
@typedoc """
## Example:
abort_incomplete_multipart_upload() :: %{
"DaysAfterInitiation" => integer()
}
"""
@type abort_incomplete_multipart_upload() :: %{String.t() => any()}
@typedoc """
## Example:
lifecycle_rule() :: %{
"AbortIncompleteMultipartUpload" => abort_incomplete_multipart_upload(),
"Expiration" => lifecycle_expiration(),
"Filter" => lifecycle_rule_filter(),
"ID" => String.t(),
"NoncurrentVersionExpiration" => noncurrent_version_expiration(),
"NoncurrentVersionTransitions" => list(noncurrent_version_transition()()),
"Prefix" => String.t(),
"Status" => list(any()),
"Transitions" => list(transition()())
}
"""
@type lifecycle_rule() :: %{String.t() => any()}
@typedoc """
## Example:
delete_public_access_block_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_public_access_block_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_policy_status_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_policy_status_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_object_versions_request() :: %{
optional("Delimiter") => String.t(),
optional("EncodingType") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("KeyMarker") => String.t(),
optional("MaxKeys") => integer(),
optional("OptionalObjectAttributes") => list(list(any())()),
optional("Prefix") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionIdMarker") => String.t()
}
"""
@type list_object_versions_request() :: %{String.t() => any()}
@typedoc """
## Example:
versioning_configuration() :: %{
"MFADelete" => list(any()),
"Status" => list(any())
}
"""
@type versioning_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
delete() :: %{
"Objects" => list(object_identifier()()),
"Quiet" => boolean()
}
"""
@type delete() :: %{String.t() => any()}
@typedoc """
## Example:
upload_part_output() :: %{
"BucketKeyEnabled" => boolean(),
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ETag" => String.t(),
"RequestCharged" => list(any()),
"SSECustomerAlgorithm" => String.t(),
"SSECustomerKeyMD5" => String.t(),
"SSEKMSKeyId" => String.t(),
"ServerSideEncryption" => list(any())
}
"""
@type upload_part_output() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_cors_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("CORSConfiguration") => c_o_r_s_configuration()
}
"""
@type put_bucket_cors_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_analytics_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t()
}
"""
@type delete_bucket_analytics_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
head_bucket_output() :: %{
"AccessPointAlias" => boolean(),
"BucketLocationName" => String.t(),
"BucketLocationType" => list(any()),
"BucketRegion" => String.t()
}
"""
@type head_bucket_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_intelligent_tiering_configuration_output() :: %{
"IntelligentTieringConfiguration" => intelligent_tiering_configuration()
}
"""
@type get_bucket_intelligent_tiering_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
queue_configuration() :: %{
"Events" => list(list(any())()),
"Filter" => notification_configuration_filter(),
"Id" => String.t(),
"QueueArn" => String.t()
}
"""
@type queue_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
filter_rule() :: %{
"Name" => list(any()),
"Value" => String.t()
}
"""
@type filter_rule() :: %{String.t() => any()}
@typedoc """
## Example:
session_credentials() :: %{
"AccessKeyId" => String.t(),
"Expiration" => non_neg_integer(),
"SecretAccessKey" => String.t(),
"SessionToken" => String.t()
}
"""
@type session_credentials() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_logging_output() :: %{
"LoggingEnabled" => logging_enabled()
}
"""
@type get_bucket_logging_output() :: %{String.t() => any()}
@typedoc """
## Example:
redirect() :: %{
"HostName" => String.t(),
"HttpRedirectCode" => String.t(),
"Protocol" => list(any()),
"ReplaceKeyPrefixWith" => String.t(),
"ReplaceKeyWith" => String.t()
}
"""
@type redirect() :: %{String.t() => any()}
@typedoc """
## Example:
source_selection_criteria() :: %{
"ReplicaModifications" => replica_modifications(),
"SseKmsEncryptedObjects" => sse_kms_encrypted_objects()
}
"""
@type source_selection_criteria() :: %{String.t() => any()}
@typedoc """
## Example:
head_object_output() :: %{
"ContentLength" => float(),
"VersionId" => String.t(),
"Expiration" => String.t(),
"BucketKeyEnabled" => boolean(),
"SSEKMSKeyId" => String.t(),
"StorageClass" => list(any()),
"ETag" => String.t(),
"ObjectLockRetainUntilDate" => non_neg_integer(),
"ObjectLockMode" => list(any()),
"ArchiveStatus" => list(any()),
"WebsiteRedirectLocation" => String.t(),
"DeleteMarker" => boolean(),
"AcceptRanges" => String.t(),
"ServerSideEncryption" => list(any()),
"ChecksumSHA1" => String.t(),
"CacheControl" => String.t(),
"ObjectLockLegalHoldStatus" => list(any()),
"ChecksumType" => list(any()),
"ContentType" => String.t(),
"SSECustomerKeyMD5" => String.t(),
"LastModified" => non_neg_integer(),
"Expires" => non_neg_integer(),
"ReplicationStatus" => list(any()),
"ContentDisposition" => String.t(),
"ContentEncoding" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC32" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"Metadata" => map(),
"PartsCount" => integer(),
"ChecksumSHA256" => String.t(),
"RequestCharged" => list(any()),
"MissingMeta" => integer(),
"Restore" => String.t(),
"ContentRange" => String.t(),
"SSECustomerAlgorithm" => String.t(),
"ContentLanguage" => String.t()
}
"""
@type head_object_output() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_tagging_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_tagging_request() :: %{String.t() => any()}
@typedoc """
## Example:
stats_event() :: %{
"Details" => stats()
}
"""
@type stats_event() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_replication_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("Token") => String.t(),
required("ReplicationConfiguration") => replication_configuration()
}
"""
@type put_bucket_replication_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_lock_configuration_output() :: %{
"RequestCharged" => list(any())
}
"""
@type put_object_lock_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_retention_output() :: %{
"Retention" => object_lock_retention()
}
"""
@type get_object_retention_output() :: %{String.t() => any()}
@typedoc """
## Example:
common_prefix() :: %{
"Prefix" => String.t()
}
"""
@type common_prefix() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_acl_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_acl_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_bucket_metadata_table_configuration_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("MetadataTableConfiguration") => metadata_table_configuration()
}
"""
@type create_bucket_metadata_table_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
analytics_export_destination() :: %{
"S3BucketDestination" => analytics_s3_bucket_destination()
}
"""
@type analytics_export_destination() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_inventory_configurations_output() :: %{
"ContinuationToken" => String.t(),
"InventoryConfigurationList" => list(inventory_configuration()()),
"IsTruncated" => boolean(),
"NextContinuationToken" => String.t()
}
"""
@type list_bucket_inventory_configurations_output() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_legal_hold_output() :: %{
"RequestCharged" => list(any())
}
"""
@type put_object_legal_hold_output() :: %{String.t() => any()}
@typedoc """
## Example:
inventory_filter() :: %{
"Prefix" => String.t()
}
"""
@type inventory_filter() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_retention_output() :: %{
"RequestCharged" => list(any())
}
"""
@type put_object_retention_output() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_acl_request() :: %{
optional("ACL") => list(any()),
optional("AccessControlPolicy") => access_control_policy(),
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("GrantFullControl") => String.t(),
optional("GrantRead") => String.t(),
optional("GrantReadACP") => String.t(),
optional("GrantWrite") => String.t(),
optional("GrantWriteACP") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t()
}
"""
@type put_object_acl_request() :: %{String.t() => any()}
@typedoc """
## Example:
restore_object_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("RestoreRequest") => restore_request(),
optional("VersionId") => String.t()
}
"""
@type restore_object_request() :: %{String.t() => any()}
@typedoc """
## Example:
copy_part_result() :: %{
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ETag" => String.t(),
"LastModified" => non_neg_integer()
}
"""
@type copy_part_result() :: %{String.t() => any()}
@typedoc """
## Example:
lambda_function_configuration() :: %{
"Events" => list(list(any())()),
"Filter" => notification_configuration_filter(),
"Id" => String.t(),
"LambdaFunctionArn" => String.t()
}
"""
@type lambda_function_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
object_not_in_active_tier_error() :: %{}
"""
@type object_not_in_active_tier_error() :: %{}
@typedoc """
## Example:
list_objects_request() :: %{
optional("Delimiter") => String.t(),
optional("EncodingType") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("Marker") => String.t(),
optional("MaxKeys") => integer(),
optional("OptionalObjectAttributes") => list(list(any())()),
optional("Prefix") => String.t(),
optional("RequestPayer") => list(any())
}
"""
@type list_objects_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_inventory_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t()
}
"""
@type get_bucket_inventory_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
input_serialization() :: %{
"CSV" => csv_input(),
"CompressionType" => list(any()),
"JSON" => json_input(),
"Parquet" => parquet_input()
}
"""
@type input_serialization() :: %{String.t() => any()}
@typedoc """
## Example:
upload_part_request() :: %{
optional("Body") => binary(),
optional("ChecksumAlgorithm") => list(any()),
optional("ChecksumCRC32") => String.t(),
optional("ChecksumCRC32C") => String.t(),
optional("ChecksumCRC64NVME") => String.t(),
optional("ChecksumSHA1") => String.t(),
optional("ChecksumSHA256") => String.t(),
optional("ContentLength") => float(),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
required("PartNumber") => integer(),
required("UploadId") => String.t()
}
"""
@type upload_part_request() :: %{String.t() => any()}
@typedoc """
## Example:
grantee() :: %{
"DisplayName" => String.t(),
"EmailAddress" => String.t(),
"ID" => String.t(),
"Type" => list(any()),
"URI" => String.t()
}
"""
@type grantee() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_metadata_table_configuration_result() :: %{
"Error" => error_details(),
"MetadataTableConfigurationResult" => metadata_table_configuration_result(),
"Status" => String.t()
}
"""
@type get_bucket_metadata_table_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_legal_hold_output() :: %{
"LegalHold" => object_lock_legal_hold()
}
"""
@type get_object_legal_hold_output() :: %{String.t() => any()}
@typedoc """
## Example:
deleted_object() :: %{
"DeleteMarker" => boolean(),
"DeleteMarkerVersionId" => String.t(),
"Key" => String.t(),
"VersionId" => String.t()
}
"""
@type deleted_object() :: %{String.t() => any()}
@typedoc """
## Example:
progress() :: %{
"BytesProcessed" => float(),
"BytesReturned" => float(),
"BytesScanned" => float()
}
"""
@type progress() :: %{String.t() => any()}
@typedoc """
## Example:
too_many_parts() :: %{}
"""
@type too_many_parts() :: %{}
@typedoc """
## Example:
get_bucket_inventory_configuration_output() :: %{
"InventoryConfiguration" => inventory_configuration()
}
"""
@type get_bucket_inventory_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_output() :: %{
"BucketKeyEnabled" => boolean(),
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ChecksumType" => list(any()),
"ETag" => String.t(),
"Expiration" => String.t(),
"RequestCharged" => list(any()),
"SSECustomerAlgorithm" => String.t(),
"SSECustomerKeyMD5" => String.t(),
"SSEKMSEncryptionContext" => String.t(),
"SSEKMSKeyId" => String.t(),
"ServerSideEncryption" => list(any()),
"Size" => float(),
"VersionId" => String.t()
}
"""
@type put_object_output() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_analytics_configurations_request() :: %{
optional("ContinuationToken") => String.t(),
optional("ExpectedBucketOwner") => String.t()
}
"""
@type list_bucket_analytics_configurations_request() :: %{String.t() => any()}
@typedoc """
## Example:
topic_configuration() :: %{
"Events" => list(list(any())()),
"Filter" => notification_configuration_filter(),
"Id" => String.t(),
"TopicArn" => String.t()
}
"""
@type topic_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_versioning_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_versioning_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_object_versions_output() :: %{
"CommonPrefixes" => list(common_prefix()()),
"DeleteMarkers" => list(delete_marker_entry()()),
"Delimiter" => String.t(),
"EncodingType" => list(any()),
"IsTruncated" => boolean(),
"KeyMarker" => String.t(),
"MaxKeys" => integer(),
"Name" => String.t(),
"NextKeyMarker" => String.t(),
"NextVersionIdMarker" => String.t(),
"Prefix" => String.t(),
"RequestCharged" => list(any()),
"VersionIdMarker" => String.t(),
"Versions" => list(object_version()())
}
"""
@type list_object_versions_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_lifecycle_configuration_output() :: %{
"Rules" => list(lifecycle_rule()()),
"TransitionDefaultMinimumObjectSize" => list(any())
}
"""
@type get_bucket_lifecycle_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
sse_kms_encrypted_objects() :: %{
"Status" => list(any())
}
"""
@type sse_kms_encrypted_objects() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_policy_status_output() :: %{
"PolicyStatus" => policy_status()
}
"""
@type get_bucket_policy_status_output() :: %{String.t() => any()}
@typedoc """
## Example:
create_multipart_upload_output() :: %{
"AbortDate" => non_neg_integer(),
"AbortRuleId" => String.t(),
"Bucket" => String.t(),
"BucketKeyEnabled" => boolean(),
"ChecksumAlgorithm" => list(any()),
"ChecksumType" => list(any()),
"Key" => String.t(),
"RequestCharged" => list(any()),
"SSECustomerAlgorithm" => String.t(),
"SSECustomerKeyMD5" => String.t(),
"SSEKMSEncryptionContext" => String.t(),
"SSEKMSKeyId" => String.t(),
"ServerSideEncryption" => list(any()),
"UploadId" => String.t()
}
"""
@type create_multipart_upload_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_acl_output() :: %{
"Grants" => list(grant()()),
"Owner" => owner()
}
"""
@type get_bucket_acl_output() :: %{String.t() => any()}
@typedoc """
## Example:
object_lock_rule() :: %{
"DefaultRetention" => default_retention()
}
"""
@type object_lock_rule() :: %{String.t() => any()}
@typedoc """
## Example:
location_info() :: %{
"Name" => String.t(),
"Type" => list(any())
}
"""
@type location_info() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_ownership_controls_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_ownership_controls_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_location_output() :: %{
"LocationConstraint" => list(any())
}
"""
@type get_bucket_location_output() :: %{String.t() => any()}
@typedoc """
## Example:
replication_rule_filter() :: %{
"And" => replication_rule_and_operator(),
"Prefix" => String.t(),
"Tag" => tag()
}
"""
@type replication_rule_filter() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_inventory_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t()
}
"""
@type delete_bucket_inventory_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
logging_enabled() :: %{
"TargetBucket" => String.t(),
"TargetGrants" => list(target_grant()()),
"TargetObjectKeyFormat" => target_object_key_format(),
"TargetPrefix" => String.t()
}
"""
@type logging_enabled() :: %{String.t() => any()}
@typedoc """
## Example:
delete_marker_entry() :: %{
"IsLatest" => boolean(),
"Key" => String.t(),
"LastModified" => non_neg_integer(),
"Owner" => owner(),
"VersionId" => String.t()
}
"""
@type delete_marker_entry() :: %{String.t() => any()}
@typedoc """
## Example:
s3_tables_destination() :: %{
"TableBucketArn" => String.t(),
"TableName" => String.t()
}
"""
@type s3_tables_destination() :: %{String.t() => any()}
@typedoc """
## Example:
select_parameters() :: %{
"Expression" => String.t(),
"ExpressionType" => list(any()),
"InputSerialization" => input_serialization(),
"OutputSerialization" => output_serialization()
}
"""
@type select_parameters() :: %{String.t() => any()}
@typedoc """
## Example:
bucket_already_owned_by_you() :: %{}
"""
@type bucket_already_owned_by_you() :: %{}
@typedoc """
## Example:
delete_bucket_policy_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_multipart_uploads_request() :: %{
optional("Delimiter") => String.t(),
optional("EncodingType") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("KeyMarker") => String.t(),
optional("MaxUploads") => integer(),
optional("Prefix") => String.t(),
optional("RequestPayer") => list(any()),
optional("UploadIdMarker") => String.t()
}
"""
@type list_multipart_uploads_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_request() :: %{
optional("GrantRead") => String.t(),
optional("IfNoneMatch") => String.t(),
optional("ChecksumCRC32C") => String.t(),
optional("Expires") => non_neg_integer(),
optional("Body") => binary(),
optional("GrantFullControl") => String.t(),
optional("ChecksumSHA256") => String.t(),
optional("Metadata") => map(),
optional("SSECustomerAlgorithm") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("ACL") => list(any()),
optional("WebsiteRedirectLocation") => String.t(),
optional("BucketKeyEnabled") => boolean(),
optional("SSECustomerKeyMD5") => String.t(),
optional("ContentDisposition") => String.t(),
optional("ChecksumCRC64NVME") => String.t(),
optional("ChecksumSHA1") => String.t(),
optional("ContentLanguage") => String.t(),
optional("IfMatch") => String.t(),
optional("GrantReadACP") => String.t(),
optional("ChecksumAlgorithm") => list(any()),
optional("ServerSideEncryption") => list(any()),
optional("ContentEncoding") => String.t(),
optional("ObjectLockRetainUntilDate") => non_neg_integer(),
optional("GrantWriteACP") => String.t(),
optional("ContentType") => String.t(),
optional("WriteOffsetBytes") => float(),
optional("RequestPayer") => list(any()),
optional("ChecksumCRC32") => String.t(),
optional("ContentLength") => float(),
optional("ContentMD5") => String.t(),
optional("CacheControl") => String.t(),
optional("Tagging") => String.t(),
optional("ObjectLockLegalHoldStatus") => list(any()),
optional("SSEKMSEncryptionContext") => String.t(),
optional("StorageClass") => list(any()),
optional("SSEKMSKeyId") => String.t(),
optional("ObjectLockMode") => list(any()),
optional("SSECustomerKey") => String.t()
}
"""
@type put_object_request() :: %{String.t() => any()}
@typedoc """
## Example:
object_version() :: %{
"ChecksumAlgorithm" => list(list(any())()),
"ChecksumType" => list(any()),
"ETag" => String.t(),
"IsLatest" => boolean(),
"Key" => String.t(),
"LastModified" => non_neg_integer(),
"Owner" => owner(),
"RestoreStatus" => restore_status(),
"Size" => float(),
"StorageClass" => list(any()),
"VersionId" => String.t()
}
"""
@type object_version() :: %{String.t() => any()}
@typedoc """
## Example:
noncurrent_version_expiration() :: %{
"NewerNoncurrentVersions" => integer(),
"NoncurrentDays" => integer()
}
"""
@type noncurrent_version_expiration() :: %{String.t() => any()}
@typedoc """
## Example:
invalid_write_offset() :: %{}
"""
@type invalid_write_offset() :: %{}
@typedoc """
## Example:
s3_tables_destination_result() :: %{
"TableArn" => String.t(),
"TableBucketArn" => String.t(),
"TableName" => String.t(),
"TableNamespace" => String.t()
}
"""
@type s3_tables_destination_result() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_legal_hold_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t()
}
"""
@type get_object_legal_hold_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_notification_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("SkipDestinationValidation") => boolean(),
required("NotificationConfiguration") => notification_configuration()
}
"""
@type put_bucket_notification_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
scan_range() :: %{
"End" => float(),
"Start" => float()
}
"""
@type scan_range() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_legal_hold_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("LegalHold") => object_lock_legal_hold(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t()
}
"""
@type put_object_legal_hold_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_analytics_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t()
}
"""
@type get_bucket_analytics_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
restore_object_output() :: %{
"RequestCharged" => list(any()),
"RestoreOutputPath" => String.t()
}
"""
@type restore_object_output() :: %{String.t() => any()}
@typedoc """
## Example:
create_session_request() :: %{
optional("BucketKeyEnabled") => boolean(),
optional("SSEKMSEncryptionContext") => String.t(),
optional("SSEKMSKeyId") => String.t(),
optional("ServerSideEncryption") => list(any()),
optional("SessionMode") => list(any())
}
"""
@type create_session_request() :: %{String.t() => any()}
@typedoc """
## Example:
json_input() :: %{
"Type" => list(any())
}
"""
@type json_input() :: %{String.t() => any()}
@typedoc """
## Example:
metrics() :: %{
"EventThreshold" => replication_time_value(),
"Status" => list(any())
}
"""
@type metrics() :: %{String.t() => any()}
@typedoc """
## Example:
replica_modifications() :: %{
"Status" => list(any())
}
"""
@type replica_modifications() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_encryption_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_encryption_request() :: %{String.t() => any()}
@typedoc """
## Example:
replication_time_value() :: %{
"Minutes" => integer()
}
"""
@type replication_time_value() :: %{String.t() => any()}
@typedoc """
## Example:
upload_part_copy_request() :: %{
optional("CopySourceIfMatch") => String.t(),
optional("CopySourceIfModifiedSince") => non_neg_integer(),
optional("CopySourceIfNoneMatch") => String.t(),
optional("CopySourceIfUnmodifiedSince") => non_neg_integer(),
optional("CopySourceRange") => String.t(),
optional("CopySourceSSECustomerAlgorithm") => String.t(),
optional("CopySourceSSECustomerKey") => String.t(),
optional("CopySourceSSECustomerKeyMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("ExpectedSourceBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
required("CopySource") => String.t(),
required("PartNumber") => integer(),
required("UploadId") => String.t()
}
"""
@type upload_part_copy_request() :: %{String.t() => any()}
@typedoc """
## Example:
policy_status() :: %{
"IsPublic" => boolean()
}
"""
@type policy_status() :: %{String.t() => any()}
@typedoc """
## Example:
metadata_table_configuration() :: %{
"S3TablesDestination" => s3_tables_destination()
}
"""
@type metadata_table_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_replication_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_replication_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_analytics_configurations_output() :: %{
"AnalyticsConfigurationList" => list(analytics_configuration()()),
"ContinuationToken" => String.t(),
"IsTruncated" => boolean(),
"NextContinuationToken" => String.t()
}
"""
@type list_bucket_analytics_configurations_output() :: %{String.t() => any()}
@typedoc """
## Example:
replication_configuration() :: %{
"Role" => String.t(),
"Rules" => list(replication_rule()())
}
"""
@type replication_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_tagging_output() :: %{
"TagSet" => list(tag()())
}
"""
@type get_bucket_tagging_output() :: %{String.t() => any()}
@typedoc """
## Example:
object_identifier() :: %{
"ETag" => String.t(),
"Key" => String.t(),
"LastModifiedTime" => non_neg_integer(),
"Size" => float(),
"VersionId" => String.t()
}
"""
@type object_identifier() :: %{String.t() => any()}
@typedoc """
## Example:
intelligent_tiering_and_operator() :: %{
"Prefix" => String.t(),
"Tags" => list(tag()())
}
"""
@type intelligent_tiering_and_operator() :: %{String.t() => any()}
@typedoc """
## Example:
metadata_table_configuration_result() :: %{
"S3TablesDestinationResult" => s3_tables_destination_result()
}
"""
@type metadata_table_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
copy_object_output() :: %{
"BucketKeyEnabled" => boolean(),
"CopyObjectResult" => copy_object_result(),
"CopySourceVersionId" => String.t(),
"Expiration" => String.t(),
"RequestCharged" => list(any()),
"SSECustomerAlgorithm" => String.t(),
"SSECustomerKeyMD5" => String.t(),
"SSEKMSEncryptionContext" => String.t(),
"SSEKMSKeyId" => String.t(),
"ServerSideEncryption" => list(any()),
"VersionId" => String.t()
}
"""
@type copy_object_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_website_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_website_request() :: %{String.t() => any()}
@typedoc """
## Example:
json_output() :: %{
"RecordDelimiter" => String.t()
}
"""
@type json_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_intelligent_tiering_configuration_request() :: %{
required("Id") => String.t()
}
"""
@type get_bucket_intelligent_tiering_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
grant() :: %{
"Grantee" => grantee(),
"Permission" => list(any())
}
"""
@type grant() :: %{String.t() => any()}
@typedoc """
## Example:
notification_configuration_filter() :: %{
"Key" => s3_key_filter()
}
"""
@type notification_configuration_filter() :: %{String.t() => any()}
@typedoc """
## Example:
create_session_output() :: %{
"BucketKeyEnabled" => boolean(),
"Credentials" => session_credentials(),
"SSEKMSEncryptionContext" => String.t(),
"SSEKMSKeyId" => String.t(),
"ServerSideEncryption" => list(any())
}
"""
@type create_session_output() :: %{String.t() => any()}
@typedoc """
## Example:
parquet_input() :: %{}
"""
@type parquet_input() :: %{}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t(),
"Value" => String.t()
}
"""
@type tag() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_tagging_output() :: %{
"TagSet" => list(tag()()),
"VersionId" => String.t()
}
"""
@type get_object_tagging_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_attributes_output() :: %{
"Checksum" => checksum(),
"DeleteMarker" => boolean(),
"ETag" => String.t(),
"LastModified" => non_neg_integer(),
"ObjectParts" => get_object_attributes_parts(),
"ObjectSize" => float(),
"RequestCharged" => list(any()),
"StorageClass" => list(any()),
"VersionId" => String.t()
}
"""
@type get_object_attributes_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_encryption_output() :: %{
"ServerSideEncryptionConfiguration" => server_side_encryption_configuration()
}
"""
@type get_bucket_encryption_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_cors_output() :: %{
"CORSRules" => list(c_o_r_s_rule()())
}
"""
@type get_bucket_cors_output() :: %{String.t() => any()}
@typedoc """
## Example:
noncurrent_version_transition() :: %{
"NewerNoncurrentVersions" => integer(),
"NoncurrentDays" => integer(),
"StorageClass" => list(any())
}
"""
@type noncurrent_version_transition() :: %{String.t() => any()}
@typedoc """
## Example:
bucket_info() :: %{
"DataRedundancy" => list(any()),
"Type" => list(any())
}
"""
@type bucket_info() :: %{String.t() => any()}
@typedoc """
## Example:
delete_object_tagging_output() :: %{
"VersionId" => String.t()
}
"""
@type delete_object_tagging_output() :: %{String.t() => any()}
@typedoc """
## Example:
abort_multipart_upload_output() :: %{
"RequestCharged" => list(any())
}
"""
@type abort_multipart_upload_output() :: %{String.t() => any()}
@typedoc """
## Example:
select_object_content_output() :: %{
"Payload" => list()
}
"""
@type select_object_content_output() :: %{String.t() => any()}
@typedoc """
## Example:
lifecycle_rule_filter() :: %{
"And" => lifecycle_rule_and_operator(),
"ObjectSizeGreaterThan" => float(),
"ObjectSizeLessThan" => float(),
"Prefix" => String.t(),
"Tag" => tag()
}
"""
@type lifecycle_rule_filter() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_intelligent_tiering_configuration_request() :: %{
required("Id") => String.t()
}
"""
@type delete_bucket_intelligent_tiering_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_lifecycle_configuration_output() :: %{
"TransitionDefaultMinimumObjectSize" => list(any())
}
"""
@type put_bucket_lifecycle_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
create_multipart_upload_request() :: %{
optional("ACL") => list(any()),
optional("BucketKeyEnabled") => boolean(),
optional("CacheControl") => String.t(),
optional("ChecksumAlgorithm") => list(any()),
optional("ChecksumType") => list(any()),
optional("ContentDisposition") => String.t(),
optional("ContentEncoding") => String.t(),
optional("ContentLanguage") => String.t(),
optional("ContentType") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("Expires") => non_neg_integer(),
optional("GrantFullControl") => String.t(),
optional("GrantRead") => String.t(),
optional("GrantReadACP") => String.t(),
optional("GrantWriteACP") => String.t(),
optional("Metadata") => map(),
optional("ObjectLockLegalHoldStatus") => list(any()),
optional("ObjectLockMode") => list(any()),
optional("ObjectLockRetainUntilDate") => non_neg_integer(),
optional("RequestPayer") => list(any()),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
optional("SSEKMSEncryptionContext") => String.t(),
optional("SSEKMSKeyId") => String.t(),
optional("ServerSideEncryption") => list(any()),
optional("StorageClass") => list(any()),
optional("Tagging") => String.t(),
optional("WebsiteRedirectLocation") => String.t()
}
"""
@type create_multipart_upload_request() :: %{String.t() => any()}
@typedoc """
## Example:
csv_input() :: %{
"AllowQuotedRecordDelimiter" => boolean(),
"Comments" => String.t(),
"FieldDelimiter" => String.t(),
"FileHeaderInfo" => list(any()),
"QuoteCharacter" => String.t(),
"QuoteEscapeCharacter" => String.t(),
"RecordDelimiter" => String.t()
}
"""
@type csv_input() :: %{String.t() => any()}
@typedoc """
## Example:
stats() :: %{
"BytesProcessed" => float(),
"BytesReturned" => float(),
"BytesScanned" => float()
}
"""
@type stats() :: %{String.t() => any()}
@typedoc """
## Example:
list_buckets_output() :: %{
"Buckets" => list(bucket()()),
"ContinuationToken" => String.t(),
"Owner" => owner(),
"Prefix" => String.t()
}
"""
@type list_buckets_output() :: %{String.t() => any()}
@typedoc """
## Example:
create_bucket_configuration() :: %{
"Bucket" => bucket_info(),
"Location" => location_info(),
"LocationConstraint" => list(any())
}
"""
@type create_bucket_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
bucket_already_exists() :: %{}
"""
@type bucket_already_exists() :: %{}
@typedoc """
## Example:
server_side_encryption_rule() :: %{
"ApplyServerSideEncryptionByDefault" => server_side_encryption_by_default(),
"BucketKeyEnabled" => boolean()
}
"""
@type server_side_encryption_rule() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_intelligent_tiering_configurations_output() :: %{
"ContinuationToken" => String.t(),
"IntelligentTieringConfigurationList" => list(intelligent_tiering_configuration()()),
"IsTruncated" => boolean(),
"NextContinuationToken" => String.t()
}
"""
@type list_bucket_intelligent_tiering_configurations_output() :: %{String.t() => any()}
@typedoc """
## Example:
initiator() :: %{
"DisplayName" => String.t(),
"ID" => String.t()
}
"""
@type initiator() :: %{String.t() => any()}
@typedoc """
## Example:
select_object_content_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("RequestProgress") => request_progress(),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
optional("ScanRange") => scan_range(),
required("Expression") => String.t(),
required("ExpressionType") => list(any()),
required("InputSerialization") => input_serialization(),
required("OutputSerialization") => output_serialization()
}
"""
@type select_object_content_request() :: %{String.t() => any()}
@typedoc """
## Example:
completed_part() :: %{
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ETag" => String.t(),
"PartNumber" => integer()
}
"""
@type completed_part() :: %{String.t() => any()}
@typedoc """
## Example:
analytics_s3_bucket_destination() :: %{
"Bucket" => String.t(),
"BucketAccountId" => String.t(),
"Format" => list(any()),
"Prefix" => String.t()
}
"""
@type analytics_s3_bucket_destination() :: %{String.t() => any()}
@typedoc """
## Example:
encryption() :: %{
"EncryptionType" => list(any()),
"KMSContext" => String.t(),
"KMSKeyId" => String.t()
}
"""
@type encryption() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_encryption_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_encryption_request() :: %{String.t() => any()}
@typedoc """
## Example:
continuation_event() :: %{}
"""
@type continuation_event() :: %{}
@typedoc """
## Example:
s3_key_filter() :: %{
"FilterRules" => list(filter_rule()())
}
"""
@type s3_key_filter() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_metrics_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t()
}
"""
@type delete_bucket_metrics_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
intelligent_tiering_configuration() :: %{
"Filter" => intelligent_tiering_filter(),
"Id" => String.t(),
"Status" => list(any()),
"Tierings" => list(tiering()())
}
"""
@type intelligent_tiering_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
redirect_all_requests_to() :: %{
"HostName" => String.t(),
"Protocol" => list(any())
}
"""
@type redirect_all_requests_to() :: %{String.t() => any()}
@typedoc """
## Example:
tagging() :: %{
"TagSet" => list(tag()())
}
"""
@type tagging() :: %{String.t() => any()}
@typedoc """
## Example:
request_payment_configuration() :: %{
"Payer" => list(any())
}
"""
@type request_payment_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
error_details() :: %{
"ErrorCode" => String.t(),
"ErrorMessage" => String.t()
}
"""
@type error_details() :: %{String.t() => any()}
@typedoc """
## Example:
access_control_translation() :: %{
"Owner" => list(any())
}
"""
@type access_control_translation() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_request_payment_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("RequestPaymentConfiguration") => request_payment_configuration()
}
"""
@type put_bucket_request_payment_request() :: %{String.t() => any()}
@typedoc """
## Example:
server_side_encryption_by_default() :: %{
"KMSMasterKeyID" => String.t(),
"SSEAlgorithm" => list(any())
}
"""
@type server_side_encryption_by_default() :: %{String.t() => any()}
@typedoc """
## Example:
website_configuration() :: %{
"ErrorDocument" => error_document(),
"IndexDocument" => index_document(),
"RedirectAllRequestsTo" => redirect_all_requests_to(),
"RoutingRules" => list(routing_rule()())
}
"""
@type website_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
output_location() :: %{
"S3" => s3_location()
}
"""
@type output_location() :: %{String.t() => any()}
@typedoc """
## Example:
target_object_key_format() :: %{
"PartitionedPrefix" => partitioned_prefix(),
"SimplePrefix" => simple_prefix()
}
"""
@type target_object_key_format() :: %{String.t() => any()}
@typedoc """
## Example:
storage_class_analysis() :: %{
"DataExport" => storage_class_analysis_data_export()
}
"""
@type storage_class_analysis() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_attributes_parts() :: %{
"IsTruncated" => boolean(),
"MaxParts" => integer(),
"NextPartNumberMarker" => String.t(),
"PartNumberMarker" => String.t(),
"Parts" => list(object_part()()),
"TotalPartsCount" => integer()
}
"""
@type get_object_attributes_parts() :: %{String.t() => any()}
@typedoc """
## Example:
list_objects_v2_output() :: %{
"CommonPrefixes" => list(common_prefix()()),
"Contents" => list(object()()),
"ContinuationToken" => String.t(),
"Delimiter" => String.t(),
"EncodingType" => list(any()),
"IsTruncated" => boolean(),
"KeyCount" => integer(),
"MaxKeys" => integer(),
"Name" => String.t(),
"NextContinuationToken" => String.t(),
"Prefix" => String.t(),
"RequestCharged" => list(any()),
"StartAfter" => String.t()
}
"""
@type list_objects_v2_output() :: %{String.t() => any()}
@typedoc """
## Example:
condition() :: %{
"HttpErrorCodeReturnedEquals" => String.t(),
"KeyPrefixEquals" => String.t()
}
"""
@type condition() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_output() :: %{
"ContentLength" => float(),
"VersionId" => String.t(),
"Expiration" => String.t(),
"BucketKeyEnabled" => boolean(),
"SSEKMSKeyId" => String.t(),
"StorageClass" => list(any()),
"ETag" => String.t(),
"ObjectLockRetainUntilDate" => non_neg_integer(),
"ObjectLockMode" => list(any()),
"Body" => binary(),
"WebsiteRedirectLocation" => String.t(),
"DeleteMarker" => boolean(),
"AcceptRanges" => String.t(),
"ServerSideEncryption" => list(any()),
"ChecksumSHA1" => String.t(),
"CacheControl" => String.t(),
"ObjectLockLegalHoldStatus" => list(any()),
"ChecksumType" => list(any()),
"ContentType" => String.t(),
"SSECustomerKeyMD5" => String.t(),
"LastModified" => non_neg_integer(),
"Expires" => non_neg_integer(),
"TagCount" => integer(),
"ReplicationStatus" => list(any()),
"ContentDisposition" => String.t(),
"ContentEncoding" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC32" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"Metadata" => map(),
"PartsCount" => integer(),
"ChecksumSHA256" => String.t(),
"RequestCharged" => list(any()),
"MissingMeta" => integer(),
"Restore" => String.t(),
"ContentRange" => String.t(),
"SSECustomerAlgorithm" => String.t(),
"ContentLanguage" => String.t()
}
"""
@type get_object_output() :: %{String.t() => any()}
@typedoc """
## Example:
s3_location() :: %{
"AccessControlList" => list(grant()()),
"BucketName" => String.t(),
"CannedACL" => list(any()),
"Encryption" => encryption(),
"Prefix" => String.t(),
"StorageClass" => list(any()),
"Tagging" => tagging(),
"UserMetadata" => list(metadata_entry()())
}
"""
@type s3_location() :: %{String.t() => any()}
@typedoc """
## Example:
object() :: %{
"ChecksumAlgorithm" => list(list(any())()),
"ChecksumType" => list(any()),
"ETag" => String.t(),
"Key" => String.t(),
"LastModified" => non_neg_integer(),
"Owner" => owner(),
"RestoreStatus" => restore_status(),
"Size" => float(),
"StorageClass" => list(any())
}
"""
@type object() :: %{String.t() => any()}
@typedoc """
## Example:
progress_event() :: %{
"Details" => progress()
}
"""
@type progress_event() :: %{String.t() => any()}
@typedoc """
## Example:
complete_multipart_upload_output() :: %{
"Bucket" => String.t(),
"BucketKeyEnabled" => boolean(),
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ChecksumType" => list(any()),
"ETag" => String.t(),
"Expiration" => String.t(),
"Key" => String.t(),
"Location" => String.t(),
"RequestCharged" => list(any()),
"SSEKMSKeyId" => String.t(),
"ServerSideEncryption" => list(any()),
"VersionId" => String.t()
}
"""
@type complete_multipart_upload_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_metadata_table_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_metadata_table_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
server_side_encryption_configuration() :: %{
"Rules" => list(server_side_encryption_rule()())
}
"""
@type server_side_encryption_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_acl_output() :: %{
"Grants" => list(grant()()),
"Owner" => owner(),
"RequestCharged" => list(any())
}
"""
@type get_object_acl_output() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_encryption_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("ServerSideEncryptionConfiguration") => server_side_encryption_configuration()
}
"""
@type put_bucket_encryption_request() :: %{String.t() => any()}
@typedoc """
## Example:
default_retention() :: %{
"Days" => integer(),
"Mode" => list(any()),
"Years" => integer()
}
"""
@type default_retention() :: %{String.t() => any()}
@typedoc """
## Example:
ownership_controls() :: %{
"Rules" => list(ownership_controls_rule()())
}
"""
@type ownership_controls() :: %{String.t() => any()}
@typedoc """
## Example:
notification_configuration() :: %{
"EventBridgeConfiguration" => event_bridge_configuration(),
"LambdaFunctionConfigurations" => list(lambda_function_configuration()()),
"QueueConfigurations" => list(queue_configuration()()),
"TopicConfigurations" => list(topic_configuration()())
}
"""
@type notification_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
object_lock_configuration() :: %{
"ObjectLockEnabled" => list(any()),
"Rule" => object_lock_rule()
}
"""
@type object_lock_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_lifecycle_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_lifecycle_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_objects_output() :: %{
"Deleted" => list(deleted_object()()),
"Errors" => list(error()()),
"RequestCharged" => list(any())
}
"""
@type delete_objects_output() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_acl_output() :: %{
"RequestCharged" => list(any())
}
"""
@type put_object_acl_output() :: %{String.t() => any()}
@typedoc """
## Example:
list_objects_output() :: %{
"CommonPrefixes" => list(common_prefix()()),
"Contents" => list(object()()),
"Delimiter" => String.t(),
"EncodingType" => list(any()),
"IsTruncated" => boolean(),
"Marker" => String.t(),
"MaxKeys" => integer(),
"Name" => String.t(),
"NextMarker" => String.t(),
"Prefix" => String.t(),
"RequestCharged" => list(any())
}
"""
@type list_objects_output() :: %{String.t() => any()}
@typedoc """
## Example:
checksum() :: %{
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ChecksumType" => list(any())
}
"""
@type checksum() :: %{String.t() => any()}
@typedoc """
## Example:
event_bridge_configuration() :: %{}
"""
@type event_bridge_configuration() :: %{}
@typedoc """
## Example:
get_bucket_versioning_output() :: %{
"MFADelete" => list(any()),
"Status" => list(any())
}
"""
@type get_bucket_versioning_output() :: %{String.t() => any()}
@typedoc """
## Example:
no_such_bucket() :: %{}
"""
@type no_such_bucket() :: %{}
@typedoc """
## Example:
delete_bucket_metadata_table_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_metadata_table_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_metrics_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t()
}
"""
@type get_bucket_metrics_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_policy_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
bucket_logging_status() :: %{
"LoggingEnabled" => logging_enabled()
}
"""
@type bucket_logging_status() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_lock_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_object_lock_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
copy_object_request() :: %{
optional("GrantRead") => String.t(),
optional("Expires") => non_neg_integer(),
optional("CopySourceIfNoneMatch") => String.t(),
optional("CopySourceSSECustomerKeyMD5") => String.t(),
optional("GrantFullControl") => String.t(),
required("CopySource") => String.t(),
optional("CopySourceIfUnmodifiedSince") => non_neg_integer(),
optional("CopySourceSSECustomerAlgorithm") => String.t(),
optional("CopySourceIfModifiedSince") => non_neg_integer(),
optional("Metadata") => map(),
optional("SSECustomerAlgorithm") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("ACL") => list(any()),
optional("WebsiteRedirectLocation") => String.t(),
optional("BucketKeyEnabled") => boolean(),
optional("SSECustomerKeyMD5") => String.t(),
optional("MetadataDirective") => list(any()),
optional("CopySourceIfMatch") => String.t(),
optional("ContentDisposition") => String.t(),
optional("TaggingDirective") => list(any()),
optional("ContentLanguage") => String.t(),
optional("CopySourceSSECustomerKey") => String.t(),
optional("GrantReadACP") => String.t(),
optional("ChecksumAlgorithm") => list(any()),
optional("ServerSideEncryption") => list(any()),
optional("ContentEncoding") => String.t(),
optional("ObjectLockRetainUntilDate") => non_neg_integer(),
optional("ExpectedSourceBucketOwner") => String.t(),
optional("GrantWriteACP") => String.t(),
optional("ContentType") => String.t(),
optional("RequestPayer") => list(any()),
optional("CacheControl") => String.t(),
optional("Tagging") => String.t(),
optional("ObjectLockLegalHoldStatus") => list(any()),
optional("SSEKMSEncryptionContext") => String.t(),
optional("StorageClass") => list(any()),
optional("SSEKMSKeyId") => String.t(),
optional("ObjectLockMode") => list(any()),
optional("SSECustomerKey") => String.t()
}
"""
@type copy_object_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_directory_buckets_request() :: %{
optional("ContinuationToken") => String.t(),
optional("MaxDirectoryBuckets") => integer()
}
"""
@type list_directory_buckets_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_ownership_controls_request() :: %{
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("OwnershipControls") => ownership_controls()
}
"""
@type put_bucket_ownership_controls_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_lifecycle_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_lifecycle_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_objects_request() :: %{
optional("BypassGovernanceRetention") => boolean(),
optional("ChecksumAlgorithm") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("MFA") => String.t(),
optional("RequestPayer") => list(any()),
required("Delete") => delete()
}
"""
@type delete_objects_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_public_access_block_output() :: %{
"PublicAccessBlockConfiguration" => public_access_block_configuration()
}
"""
@type get_public_access_block_output() :: %{String.t() => any()}
@typedoc """
## Example:
restore_status() :: %{
"IsRestoreInProgress" => boolean(),
"RestoreExpiryDate" => non_neg_integer()
}
"""
@type restore_status() :: %{String.t() => any()}
@typedoc """
## Example:
analytics_and_operator() :: %{
"Prefix" => String.t(),
"Tags" => list(tag()())
}
"""
@type analytics_and_operator() :: %{String.t() => any()}
@typedoc """
## Example:
bucket() :: %{
"BucketRegion" => String.t(),
"CreationDate" => non_neg_integer(),
"Name" => String.t()
}
"""
@type bucket() :: %{String.t() => any()}
@typedoc """
## Example:
delete_marker_replication() :: %{
"Status" => list(any())
}
"""
@type delete_marker_replication() :: %{String.t() => any()}
@typedoc """
## Example:
inventory_encryption() :: %{
"SSEKMS" => sse_kms(),
"SSES3" => sse_s3()
}
"""
@type inventory_encryption() :: %{String.t() => any()}
@typedoc """
## Example:
create_bucket_request() :: %{
optional("ACL") => list(any()),
optional("CreateBucketConfiguration") => create_bucket_configuration(),
optional("GrantFullControl") => String.t(),
optional("GrantRead") => String.t(),
optional("GrantReadACP") => String.t(),
optional("GrantWrite") => String.t(),
optional("GrantWriteACP") => String.t(),
optional("ObjectLockEnabledForBucket") => boolean(),
optional("ObjectOwnership") => list(any())
}
"""
@type create_bucket_request() :: %{String.t() => any()}
@typedoc """
## Example:
storage_class_analysis_data_export() :: %{
"Destination" => analytics_export_destination(),
"OutputSchemaVersion" => list(any())
}
"""
@type storage_class_analysis_data_export() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_accelerate_configuration_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
required("AccelerateConfiguration") => accelerate_configuration()
}
"""
@type put_bucket_accelerate_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
c_o_r_s_rule() :: %{
"AllowedHeaders" => list(String.t()()),
"AllowedMethods" => list(String.t()()),
"AllowedOrigins" => list(String.t()()),
"ExposeHeaders" => list(String.t()()),
"ID" => String.t(),
"MaxAgeSeconds" => integer()
}
"""
@type c_o_r_s_rule() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_acl_request() :: %{
optional("ACL") => list(any()),
optional("AccessControlPolicy") => access_control_policy(),
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("GrantFullControl") => String.t(),
optional("GrantRead") => String.t(),
optional("GrantReadACP") => String.t(),
optional("GrantWrite") => String.t(),
optional("GrantWriteACP") => String.t()
}
"""
@type put_bucket_acl_request() :: %{String.t() => any()}
@typedoc """
## Example:
simple_prefix() :: %{}
"""
@type simple_prefix() :: %{}
@typedoc """
## Example:
existing_object_replication() :: %{
"Status" => list(any())
}
"""
@type existing_object_replication() :: %{String.t() => any()}
@typedoc """
## Example:
transition() :: %{
"Date" => non_neg_integer(),
"Days" => integer(),
"StorageClass" => list(any())
}
"""
@type transition() :: %{String.t() => any()}
@typedoc """
## Example:
index_document() :: %{
"Suffix" => String.t()
}
"""
@type index_document() :: %{String.t() => any()}
@typedoc """
## Example:
intelligent_tiering_filter() :: %{
"And" => intelligent_tiering_and_operator(),
"Prefix" => String.t(),
"Tag" => tag()
}
"""
@type intelligent_tiering_filter() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_torrent_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any())
}
"""
@type get_object_torrent_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_metrics_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t(),
required("MetricsConfiguration") => metrics_configuration()
}
"""
@type put_bucket_metrics_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_retention_request() :: %{
optional("BypassGovernanceRetention") => boolean(),
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("Retention") => object_lock_retention(),
optional("VersionId") => String.t()
}
"""
@type put_object_retention_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_buckets_request() :: %{
optional("BucketRegion") => String.t(),
optional("ContinuationToken") => String.t(),
optional("MaxBuckets") => integer(),
optional("Prefix") => String.t()
}
"""
@type list_buckets_request() :: %{String.t() => any()}
@typedoc """
## Example:
part() :: %{
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"ETag" => String.t(),
"LastModified" => non_neg_integer(),
"PartNumber" => integer(),
"Size" => float()
}
"""
@type part() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_tagging_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_tagging_request() :: %{String.t() => any()}
@typedoc """
## Example:
object_part() :: %{
"ChecksumCRC32" => String.t(),
"ChecksumCRC32C" => String.t(),
"ChecksumCRC64NVME" => String.t(),
"ChecksumSHA1" => String.t(),
"ChecksumSHA256" => String.t(),
"PartNumber" => integer(),
"Size" => float()
}
"""
@type object_part() :: %{String.t() => any()}
@typedoc """
## Example:
end_event() :: %{}
"""
@type end_event() :: %{}
@typedoc """
## Example:
metadata_entry() :: %{
"Name" => String.t(),
"Value" => String.t()
}
"""
@type metadata_entry() :: %{String.t() => any()}
@typedoc """
## Example:
sse_s3() :: %{}
"""
@type sse_s3() :: %{}
@typedoc """
## Example:
get_bucket_logging_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_logging_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_acl_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t()
}
"""
@type get_object_acl_request() :: %{String.t() => any()}
@typedoc """
## Example:
replication_rule() :: %{
"DeleteMarkerReplication" => delete_marker_replication(),
"Destination" => destination(),
"ExistingObjectReplication" => existing_object_replication(),
"Filter" => replication_rule_filter(),
"ID" => String.t(),
"Prefix" => String.t(),
"Priority" => integer(),
"SourceSelectionCriteria" => source_selection_criteria(),
"Status" => list(any())
}
"""
@type replication_rule() :: %{String.t() => any()}
@typedoc """
## Example:
list_objects_v2_request() :: %{
optional("ContinuationToken") => String.t(),
optional("Delimiter") => String.t(),
optional("EncodingType") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("FetchOwner") => boolean(),
optional("MaxKeys") => integer(),
optional("OptionalObjectAttributes") => list(list(any())()),
optional("Prefix") => String.t(),
optional("RequestPayer") => list(any()),
optional("StartAfter") => String.t()
}
"""
@type list_objects_v2_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_bucket_output() :: %{
"Location" => String.t()
}
"""
@type create_bucket_output() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_intelligent_tiering_configuration_request() :: %{
required("Id") => String.t(),
required("IntelligentTieringConfiguration") => intelligent_tiering_configuration()
}
"""
@type put_bucket_intelligent_tiering_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
destination() :: %{
"AccessControlTranslation" => access_control_translation(),
"Account" => String.t(),
"Bucket" => String.t(),
"EncryptionConfiguration" => encryption_configuration(),
"Metrics" => metrics(),
"ReplicationTime" => replication_time(),
"StorageClass" => list(any())
}
"""
@type destination() :: %{String.t() => any()}
@typedoc """
## Example:
head_bucket_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type head_bucket_request() :: %{String.t() => any()}
@typedoc """
## Example:
lifecycle_expiration() :: %{
"Date" => non_neg_integer(),
"Days" => integer(),
"ExpiredObjectDeleteMarker" => boolean()
}
"""
@type lifecycle_expiration() :: %{String.t() => any()}
@typedoc """
## Example:
access_control_policy() :: %{
"Grants" => list(grant()()),
"Owner" => owner()
}
"""
@type access_control_policy() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_analytics_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("AnalyticsConfiguration") => analytics_configuration(),
required("Id") => String.t()
}
"""
@type put_bucket_analytics_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
object_lock_retention() :: %{
"Mode" => list(any()),
"RetainUntilDate" => non_neg_integer()
}
"""
@type object_lock_retention() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_tagging_output() :: %{
"VersionId" => String.t()
}
"""
@type put_object_tagging_output() :: %{String.t() => any()}
@typedoc """
## Example:
upload_part_copy_output() :: %{
"BucketKeyEnabled" => boolean(),
"CopyPartResult" => copy_part_result(),
"CopySourceVersionId" => String.t(),
"RequestCharged" => list(any()),
"SSECustomerAlgorithm" => String.t(),
"SSECustomerKeyMD5" => String.t(),
"SSEKMSKeyId" => String.t(),
"ServerSideEncryption" => list(any())
}
"""
@type upload_part_copy_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_location_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_location_request() :: %{String.t() => any()}
@typedoc """
## Example:
multipart_upload() :: %{
"ChecksumAlgorithm" => list(any()),
"ChecksumType" => list(any()),
"Initiated" => non_neg_integer(),
"Initiator" => initiator(),
"Key" => String.t(),
"Owner" => owner(),
"StorageClass" => list(any()),
"UploadId" => String.t()
}
"""
@type multipart_upload() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_tagging_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("Tagging") => tagging()
}
"""
@type put_bucket_tagging_request() :: %{String.t() => any()}
@typedoc """
## Example:
partitioned_prefix() :: %{
"PartitionDateSource" => list(any())
}
"""
@type partitioned_prefix() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_inventory_configurations_request() :: %{
optional("ContinuationToken") => String.t(),
optional("ExpectedBucketOwner") => String.t()
}
"""
@type list_bucket_inventory_configurations_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_multipart_uploads_output() :: %{
"Bucket" => String.t(),
"CommonPrefixes" => list(common_prefix()()),
"Delimiter" => String.t(),
"EncodingType" => list(any()),
"IsTruncated" => boolean(),
"KeyMarker" => String.t(),
"MaxUploads" => integer(),
"NextKeyMarker" => String.t(),
"NextUploadIdMarker" => String.t(),
"Prefix" => String.t(),
"RequestCharged" => list(any()),
"UploadIdMarker" => String.t(),
"Uploads" => list(multipart_upload()())
}
"""
@type list_multipart_uploads_output() :: %{String.t() => any()}
@typedoc """
## Example:
encryption_type_mismatch() :: %{}
"""
@type encryption_type_mismatch() :: %{}
@typedoc """
## Example:
sse_kms() :: %{
"KeyId" => String.t()
}
"""
@type sse_kms() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_lock_configuration_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("ObjectLockConfiguration") => object_lock_configuration(),
optional("RequestPayer") => list(any()),
optional("Token") => String.t()
}
"""
@type put_object_lock_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_object_output() :: %{
"DeleteMarker" => boolean(),
"RequestCharged" => list(any()),
"VersionId" => String.t()
}
"""
@type delete_object_output() :: %{String.t() => any()}
@typedoc """
## Example:
completed_multipart_upload() :: %{
"Parts" => list(completed_part()())
}
"""
@type completed_multipart_upload() :: %{String.t() => any()}
@typedoc """
## Example:
list_parts_output() :: %{
"AbortDate" => non_neg_integer(),
"AbortRuleId" => String.t(),
"Bucket" => String.t(),
"ChecksumAlgorithm" => list(any()),
"ChecksumType" => list(any()),
"Initiator" => initiator(),
"IsTruncated" => boolean(),
"Key" => String.t(),
"MaxParts" => integer(),
"NextPartNumberMarker" => String.t(),
"Owner" => owner(),
"PartNumberMarker" => String.t(),
"Parts" => list(part()()),
"RequestCharged" => list(any()),
"StorageClass" => list(any()),
"UploadId" => String.t()
}
"""
@type list_parts_output() :: %{String.t() => any()}
@typedoc """
## Example:
csv_output() :: %{
"FieldDelimiter" => String.t(),
"QuoteCharacter" => String.t(),
"QuoteEscapeCharacter" => String.t(),
"QuoteFields" => list(any()),
"RecordDelimiter" => String.t()
}
"""
@type csv_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_analytics_configuration_output() :: %{
"AnalyticsConfiguration" => analytics_configuration()
}
"""
@type get_bucket_analytics_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
not_found() :: %{}
"""
@type not_found() :: %{}
@typedoc """
## Example:
replication_rule_and_operator() :: %{
"Prefix" => String.t(),
"Tags" => list(tag()())
}
"""
@type replication_rule_and_operator() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_retention_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t()
}
"""
@type get_object_retention_request() :: %{String.t() => any()}
@typedoc """
## Example:
abort_multipart_upload_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("IfMatchInitiatedTime") => non_neg_integer(),
optional("RequestPayer") => list(any()),
required("UploadId") => String.t()
}
"""
@type abort_multipart_upload_request() :: %{String.t() => any()}
@typedoc """
## Example:
tiering() :: %{
"AccessTier" => list(any()),
"Days" => integer()
}
"""
@type tiering() :: %{String.t() => any()}
@typedoc """
## Example:
head_object_request() :: %{
optional("ChecksumMode") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("IfMatch") => String.t(),
optional("IfModifiedSince") => non_neg_integer(),
optional("IfNoneMatch") => String.t(),
optional("IfUnmodifiedSince") => non_neg_integer(),
optional("PartNumber") => integer(),
optional("Range") => String.t(),
optional("RequestPayer") => list(any()),
optional("ResponseCacheControl") => String.t(),
optional("ResponseContentDisposition") => String.t(),
optional("ResponseContentEncoding") => String.t(),
optional("ResponseContentLanguage") => String.t(),
optional("ResponseContentType") => String.t(),
optional("ResponseExpires") => non_neg_integer(),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
optional("VersionId") => String.t()
}
"""
@type head_object_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_public_access_block_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_public_access_block_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_metadata_table_configuration_output() :: %{
"GetBucketMetadataTableConfigurationResult" => get_bucket_metadata_table_configuration_result()
}
"""
@type get_bucket_metadata_table_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_cors_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_cors_request() :: %{String.t() => any()}
@typedoc """
## Example:
glacier_job_parameters() :: %{
"Tier" => list(any())
}
"""
@type glacier_job_parameters() :: %{String.t() => any()}
@typedoc """
## Example:
no_such_upload() :: %{}
"""
@type no_such_upload() :: %{}
@typedoc """
## Example:
inventory_destination() :: %{
"S3BucketDestination" => inventory_s3_bucket_destination()
}
"""
@type inventory_destination() :: %{String.t() => any()}
@typedoc """
## Example:
list_parts_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("MaxParts") => integer(),
optional("PartNumberMarker") => String.t(),
optional("RequestPayer") => list(any()),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
required("UploadId") => String.t()
}
"""
@type list_parts_request() :: %{String.t() => any()}
@typedoc """
## Example:
object_lock_legal_hold() :: %{
"Status" => list(any())
}
"""
@type object_lock_legal_hold() :: %{String.t() => any()}
@typedoc """
## Example:
replication_time() :: %{
"Status" => list(any()),
"Time" => replication_time_value()
}
"""
@type replication_time() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_metrics_configuration_output() :: %{
"MetricsConfiguration" => metrics_configuration()
}
"""
@type get_bucket_metrics_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
list_directory_buckets_output() :: %{
"Buckets" => list(bucket()()),
"ContinuationToken" => String.t()
}
"""
@type list_directory_buckets_output() :: %{String.t() => any()}
@typedoc """
## Example:
request_progress() :: %{
"Enabled" => boolean()
}
"""
@type request_progress() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_lifecycle_configuration_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("LifecycleConfiguration") => bucket_lifecycle_configuration(),
optional("TransitionDefaultMinimumObjectSize") => list(any())
}
"""
@type put_bucket_lifecycle_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
output_serialization() :: %{
"CSV" => csv_output(),
"JSON" => json_output()
}
"""
@type output_serialization() :: %{String.t() => any()}
@typedoc """
## Example:
invalid_request() :: %{}
"""
@type invalid_request() :: %{}
@typedoc """
## Example:
get_object_request() :: %{
optional("ChecksumMode") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("IfMatch") => String.t(),
optional("IfModifiedSince") => non_neg_integer(),
optional("IfNoneMatch") => String.t(),
optional("IfUnmodifiedSince") => non_neg_integer(),
optional("PartNumber") => integer(),
optional("Range") => String.t(),
optional("RequestPayer") => list(any()),
optional("ResponseCacheControl") => String.t(),
optional("ResponseContentDisposition") => String.t(),
optional("ResponseContentEncoding") => String.t(),
optional("ResponseContentLanguage") => String.t(),
optional("ResponseContentType") => String.t(),
optional("ResponseExpires") => non_neg_integer(),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
optional("VersionId") => String.t()
}
"""
@type get_object_request() :: %{String.t() => any()}
@typedoc """
## Example:
metrics_and_operator() :: %{
"AccessPointArn" => String.t(),
"Prefix" => String.t(),
"Tags" => list(tag()())
}
"""
@type metrics_and_operator() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_website_output() :: %{
"ErrorDocument" => error_document(),
"IndexDocument" => index_document(),
"RedirectAllRequestsTo" => redirect_all_requests_to(),
"RoutingRules" => list(routing_rule()())
}
"""
@type get_bucket_website_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_request_payment_output() :: %{
"Payer" => list(any())
}
"""
@type get_bucket_request_payment_output() :: %{String.t() => any()}
@typedoc """
## Example:
bucket_lifecycle_configuration() :: %{
"Rules" => list(lifecycle_rule()())
}
"""
@type bucket_lifecycle_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
routing_rule() :: %{
"Condition" => condition(),
"Redirect" => redirect()
}
"""
@type routing_rule() :: %{String.t() => any()}
@typedoc """
## Example:
invalid_object_state() :: %{
"AccessTier" => list(any()),
"StorageClass" => list(any())
}
"""
@type invalid_object_state() :: %{String.t() => any()}
@typedoc """
## Example:
complete_multipart_upload_request() :: %{
optional("ChecksumCRC32") => String.t(),
optional("ChecksumCRC32C") => String.t(),
optional("ChecksumCRC64NVME") => String.t(),
optional("ChecksumSHA1") => String.t(),
optional("ChecksumSHA256") => String.t(),
optional("ChecksumType") => list(any()),
optional("ExpectedBucketOwner") => String.t(),
optional("IfMatch") => String.t(),
optional("IfNoneMatch") => String.t(),
optional("MpuObjectSize") => float(),
optional("MultipartUpload") => completed_multipart_upload(),
optional("RequestPayer") => list(any()),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
required("UploadId") => String.t()
}
"""
@type complete_multipart_upload_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_website_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
required("WebsiteConfiguration") => website_configuration()
}
"""
@type put_bucket_website_request() :: %{String.t() => any()}
@typedoc """
## Example:
restore_request() :: %{
"Days" => integer(),
"Description" => String.t(),
"GlacierJobParameters" => glacier_job_parameters(),
"OutputLocation" => output_location(),
"SelectParameters" => select_parameters(),
"Tier" => list(any()),
"Type" => list(any())
}
"""
@type restore_request() :: %{String.t() => any()}
@typedoc """
## Example:
analytics_configuration() :: %{
"Filter" => list(),
"Id" => String.t(),
"StorageClassAnalysis" => storage_class_analysis()
}
"""
@type analytics_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_replication_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_replication_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_object_tagging_request() :: %{
optional("ChecksumAlgorithm") => list(any()),
optional("ContentMD5") => String.t(),
optional("ExpectedBucketOwner") => String.t(),
optional("RequestPayer") => list(any()),
optional("VersionId") => String.t(),
required("Tagging") => tagging()
}
"""
@type put_object_tagging_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_replication_output() :: %{
"ReplicationConfiguration" => replication_configuration()
}
"""
@type get_bucket_replication_output() :: %{String.t() => any()}
@typedoc """
## Example:
list_bucket_intelligent_tiering_configurations_request() :: %{
optional("ContinuationToken") => String.t()
}
"""
@type list_bucket_intelligent_tiering_configurations_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_bucket_notification_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type get_bucket_notification_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_bucket_cors_request() :: %{
optional("ExpectedBucketOwner") => String.t()
}
"""
@type delete_bucket_cors_request() :: %{String.t() => any()}
@typedoc """
## Example:
object_already_in_active_tier_error() :: %{}
"""
@type object_already_in_active_tier_error() :: %{}
@typedoc """
## Example:
get_object_lock_configuration_output() :: %{
"ObjectLockConfiguration" => object_lock_configuration()
}
"""
@type get_object_lock_configuration_output() :: %{String.t() => any()}
@typedoc """
## Example:
get_object_attributes_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
optional("MaxParts") => integer(),
optional("PartNumberMarker") => String.t(),
optional("RequestPayer") => list(any()),
optional("SSECustomerAlgorithm") => String.t(),
optional("SSECustomerKey") => String.t(),
optional("SSECustomerKeyMD5") => String.t(),
optional("VersionId") => String.t(),
required("ObjectAttributes") => list(list(any())())
}
"""
@type get_object_attributes_request() :: %{String.t() => any()}
@typedoc """
## Example:
owner() :: %{
"DisplayName" => String.t(),
"ID" => String.t()
}
"""
@type owner() :: %{String.t() => any()}
@typedoc """
## Example:
metrics_configuration() :: %{
"Filter" => list(),
"Id" => String.t()
}
"""
@type metrics_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
accelerate_configuration() :: %{
"Status" => list(any())
}
"""
@type accelerate_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
error_document() :: %{
"Key" => String.t()
}
"""
@type error_document() :: %{String.t() => any()}
@typedoc """
## Example:
put_bucket_inventory_configuration_request() :: %{
optional("ExpectedBucketOwner") => String.t(),
required("Id") => String.t(),
required("InventoryConfiguration") => inventory_configuration()
}
"""
@type put_bucket_inventory_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
lifecycle_rule_and_operator() :: %{
"ObjectSizeGreaterThan" => float(),
"ObjectSizeLessThan" => float(),
"Prefix" => String.t(),
"Tags" => list(tag()())
}
"""
@type lifecycle_rule_and_operator() :: %{String.t() => any()}
@type abort_multipart_upload_errors() :: no_such_upload()
@type copy_object_errors() :: object_not_in_active_tier_error()
@type create_bucket_errors() :: bucket_already_exists() | bucket_already_owned_by_you()
@type create_session_errors() :: no_such_bucket()
@type get_object_errors() :: invalid_object_state() | no_such_key()
@type get_object_acl_errors() :: no_such_key()
@type get_object_attributes_errors() :: no_such_key()
@type head_bucket_errors() :: not_found()
@type head_object_errors() :: not_found()
@type list_objects_errors() :: no_such_bucket()
@type list_objects_v2_errors() :: no_such_bucket()
@type put_object_errors() ::
invalid_request()
| encryption_type_mismatch()
| invalid_write_offset()
| too_many_parts()
@type put_object_acl_errors() :: no_such_key()
@type restore_object_errors() :: object_already_in_active_tier_error()
def metadata do
%{
api_version: "2006-03-01",
content_type: "text/xml",
credential_scope: nil,
endpoint_prefix: "s3",
global?: false,
hostname: nil,
protocol: "rest-xml",
service_id: "S3",
signature_version: "v4",
signing_name: "s3",
target_prefix: nil
}
end
@doc """
This operation aborts a multipart upload.
After a multipart upload is aborted, no
additional parts can be uploaded using that upload ID. The storage consumed by
any
previously uploaded parts will be freed. However, if any part uploads are
currently in
progress, those part uploads might or might not succeed. As a result, it might
be necessary
to abort a given multipart upload multiple times in order to completely free all
storage
consumed by all parts.
To verify that all parts have been removed and prevent getting charged for the
part
storage, you should call the
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) API operation and ensure
that the parts list is empty.
**Directory buckets** - If multipart
uploads in a directory bucket are in progress, you can't delete the bucket until
all the in-progress multipart uploads are aborted or completed. To delete these
in-progress multipart uploads, use the `ListMultipartUploads` operation
to list the in-progress multipart uploads in the bucket and use the
`AbortMultipartUpload` operation to abort all the in-progress
multipart uploads.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in
Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - For
information about permissions required to use the multipart upload, see
[Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
in the *Amazon S3 User Guide*.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `AbortMultipartUpload`:
*
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
[CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
[ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
"""
@spec abort_multipart_upload(
map(),
String.t(),
String.t(),
abort_multipart_upload_request(),
list()
) ::
{:ok, abort_multipart_upload_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, abort_multipart_upload_errors()}
def abort_multipart_upload(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=AbortMultipartUpload"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"IfMatchInitiatedTime", "x-amz-if-match-initiated-time"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"UploadId", "uploadId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) operation or the
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)
operation.
After successfully uploading all relevant parts of an upload, you call this
`CompleteMultipartUpload` operation to complete the upload. Upon receiving
this request, Amazon S3 concatenates all the parts in ascending order by part
number to create a
new object. In the CompleteMultipartUpload request, you must provide the parts
list and
ensure that the parts list is complete. The CompleteMultipartUpload API
operation
concatenates the parts that you provide in the list. For each part in the list,
you must
provide the `PartNumber` value and the `ETag` value that are returned
after that part was uploaded.
The processing of a CompleteMultipartUpload request could take several minutes
to
finalize. After Amazon S3 begins processing the request, it sends an HTTP
response header that
specifies a `200 OK` response. While processing is in progress, Amazon S3
periodically sends white space characters to keep the connection from timing
out. A request
could fail after the initial `200 OK` response has been sent. This means that a
`200 OK` response can contain either a success or an error. The error
response might be embedded in the `200 OK` response. If you call this API
operation directly, make sure to design your application to parse the contents
of the
response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs
handle this condition.
The SDKs detect the embedded error and apply error handling per your
configuration settings
(including automatically retrying the request as appropriate). If the condition
persists,
the SDKs throw an exception (or, for the SDKs that don't use exceptions, they
return an
error).
Note that if `CompleteMultipartUpload` fails, applications should be prepared
to retry any failed requests (including 500 error responses). For more
information, see
[Amazon S3 Error Best
Practices](https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html).
You can't use `Content-Type: application/x-www-form-urlencoded` for the
CompleteMultipartUpload requests. Also, if you don't provide a `Content-Type`
header, `CompleteMultipartUpload` can still return a `200 OK`
response.
For more information about multipart uploads, see [Uploading Objects Using Multipart
Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)
in the *Amazon S3 User Guide*.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - For
information about permissions required to use the multipart upload API, see
[Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
in the *Amazon S3 User Guide*.
If you provide an [additional checksum value](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html) in
your `MultipartUpload` requests and the
object is encrypted with Key Management Service, you must have permission to use
the
`kms:Decrypt` action for the
`CompleteMultipartUpload` request to succeed.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
If the object is encrypted with SSE-KMS, you must also have the
`kms:GenerateDataKey` and `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the KMS
key.
### Special errors
Error Code: `EntityTooSmall`
Description: Your proposed upload is smaller than the minimum
allowed object size. Each part must be at least 5 MB in size, except
the last part.
HTTP Status Code: 400 Bad Request
Error Code: `InvalidPart`
Description: One or more of the specified parts could not be found.
The part might not have been uploaded, or the specified ETag might not
have matched the uploaded part's ETag.
HTTP Status Code: 400 Bad Request
Error Code: `InvalidPartOrder`
Description: The list of parts was not in ascending order. The
parts list must be specified in order by part number.
HTTP Status Code: 400 Bad Request
Error Code: `NoSuchUpload`
Description: The specified multipart upload does not exist. The
upload ID might be invalid, or the multipart upload might have been
aborted or completed.
HTTP Status Code: 404 Not Found
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `CompleteMultipartUpload`:
*
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
[AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
[ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
"""
@spec complete_multipart_upload(
map(),
String.t(),
String.t(),
complete_multipart_upload_request(),
list()
) ::
{:ok, complete_multipart_upload_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def complete_multipart_upload(%Client{} = client, bucket, key, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}"
{headers, input} =
[
{"ChecksumCRC32", "x-amz-checksum-crc32"},
{"ChecksumCRC32C", "x-amz-checksum-crc32c"},
{"ChecksumCRC64NVME", "x-amz-checksum-crc64nvme"},
{"ChecksumSHA1", "x-amz-checksum-sha1"},
{"ChecksumSHA256", "x-amz-checksum-sha256"},
{"ChecksumType", "x-amz-checksum-type"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"IfMatch", "If-Match"},
{"IfNoneMatch", "If-None-Match"},
{"MpuObjectSize", "x-amz-mp-object-size"},
{"RequestPayer", "x-amz-request-payer"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"UploadId", "uploadId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"x-amz-expiration", "Expiration"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-server-side-encryption", "ServerSideEncryption"},
{"x-amz-version-id", "VersionId"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy
of your
object up to 5 GB in size in a single atomic action using this API. However, to
copy an
object greater than 5 GB, you must use the multipart upload Upload Part - Copy
(UploadPartCopy) API. For more information, see [Copy Object Using the REST Multipart Upload
API](https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html).
You can copy individual objects between general purpose buckets, between
directory buckets,
and between general purpose buckets and directory buckets.
Amazon S3 supports copy operations using Multi-Region Access Points only as a
destination when using the Multi-Region Access Point ARN.
**Directory buckets ** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
VPC endpoints don't support cross-Region requests (including copies). If you're
using VPC endpoints, your source and destination buckets should be in the same
Amazon Web Services Region as your VPC endpoint.
Both the Region that you want to copy the object from and the Region that you
want to
copy the object to must be enabled for your account. For more information about
how to
enable a Region for your account, see [Enable or disable a Region for standalone accounts](https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone)
in the *Amazon Web Services
Account Management Guide*.
Amazon S3 transfer acceleration does not support cross-Region copies. If you
request a
cross-Region copy using a transfer acceleration endpoint, you get a
```
400 Bad
Request
```
error. For more information, see [Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
## Definitions
### Authentication and authorization
All `CopyObject` requests must be authenticated and signed by using
IAM credentials (access key ID and secret access key for the IAM identities).
All headers with the `x-amz-` prefix, including
`x-amz-copy-source`, must be signed. For more information, see
[REST Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
**Directory buckets** - You must use the
IAM credentials to authenticate and authorize your access to the
`CopyObject` API operation, instead of using the temporary security
credentials through the `CreateSession` API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your
behalf.
### Permissions
You must have *read* access to the source object and
*write* access to the destination bucket.
**General purpose bucket permissions## - You
must have permissions in an IAM policy based on the source and destination
bucket types in a `CopyObject` operation.
If the source object is in a general purpose bucket, you must have
`s3:GetObject`
##
permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have
`s3:PutObject`
**
permission to write the object copy to the destination bucket.
**Directory bucket permissions## -
You must have permissions in a bucket policy or an IAM identity-based policy
based on the
source and destination bucket types in a `CopyObject`
operation.
If the source object that you want to copy is in a
directory bucket, you must have the
`s3express:CreateSession`
## permission in
the `Action` element of a policy to read the object. By
default, the session is in the `ReadWrite` mode. If you
want to restrict the access, you can explicitly set the
`s3express:SessionMode` condition key to
`ReadOnly` on the copy source bucket.
If the copy destination is a directory bucket, you must have the
`s3express:CreateSession`
** permission in the
`Action` element of a policy to write the object to the
destination. The `s3express:SessionMode` condition key
can't be set to `ReadOnly` on the copy destination bucket.
If the object is encrypted with SSE-KMS, you must also have the
`kms:GenerateDataKey` and `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the KMS
key.
For example policies, see [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)
and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for
S3 Express One
Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)
in the *Amazon S3 User Guide*.
### Response and special errors
When the request is an HTTP 1.1 request, the response is chunk encoded. When
the request is not an HTTP 1.1 request, the response would not contain the
`Content-Length`. You always need to read the entire response body
to check if the copy succeeds.
If the copy is successful, you receive a response with information about
the copied object.
A copy request might return an error when Amazon S3 receives the copy request
or while Amazon S3 is copying the files. A `200 OK` response can
contain either a success or an error.
If the error occurs before the copy action starts, you receive a
standard Amazon S3 error.
If the error occurs during the copy operation, the error response
is embedded in the `200 OK` response. For example, in a
cross-region copy, you may encounter throttling and receive a
`200 OK` response. For more information, see [Resolve the Error 200 response when copying objects to
Amazon S3](https://repost.aws/knowledge-center/s3-resolve-200-internalerror).
The `200 OK` status code means the copy
was accepted, but it doesn't mean the copy is complete. Another
example is when you disconnect from Amazon S3 before the copy is complete,
Amazon S3 might cancel the copy and you may receive a `200 OK`
response. You must stay connected to Amazon S3 until the entire response is
successfully received and processed.
If you call this API operation directly, make sure to design your
application to parse the content of the response and handle it
appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition.
The
SDKs detect the embedded error and apply error handling per your
configuration settings (including automatically retrying the request
as appropriate). If the condition persists, the SDKs throw an
exception (or, for the SDKs that don't use exceptions, they return an
error).
### Charge
The copy request charge is based on the storage class and Region that you
specify for the destination object. The request can also result in a data
retrieval charge for the source if the source storage class bills for data
retrieval. If the copy source is in a different region, the data transfer is
billed to the copy source account. For pricing information, see [Amazon S3 pricing](http://aws.amazon.com/s3/pricing/).
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
**Amazon S3 on Outposts** - When you use this action with S3 on Outposts through
the REST API, 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
```
. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.
The following operations are related to `CopyObject`:
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
"""
@spec copy_object(map(), String.t(), String.t(), copy_object_request(), list()) ::
{:ok, copy_object_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, copy_object_errors()}
def copy_object(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=CopyObject"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-checksum-algorithm"},
{"CopySourceSSECustomerAlgorithm",
"x-amz-copy-source-server-side-encryption-customer-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"CopySource", "x-amz-copy-source"},
{"GrantFullControl", "x-amz-grant-full-control"},
{"ACL", "x-amz-acl"},
{"ObjectLockRetainUntilDate", "x-amz-object-lock-retain-until-date"},
{"RequestPayer", "x-amz-request-payer"},
{"BucketKeyEnabled", "x-amz-server-side-encryption-bucket-key-enabled"},
{"ContentType", "Content-Type"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"},
{"ObjectLockLegalHoldStatus", "x-amz-object-lock-legal-hold"},
{"Tagging", "x-amz-tagging"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"CopySourceSSECustomerKey", "x-amz-copy-source-server-side-encryption-customer-key"},
{"WebsiteRedirectLocation", "x-amz-website-redirect-location"},
{"ContentLanguage", "Content-Language"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"ContentEncoding", "Content-Encoding"},
{"CopySourceSSECustomerKeyMD5",
"x-amz-copy-source-server-side-encryption-customer-key-MD5"},
{"CopySourceIfMatch", "x-amz-copy-source-if-match"},
{"CopySourceIfUnmodifiedSince", "x-amz-copy-source-if-unmodified-since"},
{"Expires", "Expires"},
{"GrantWriteACP", "x-amz-grant-write-acp"},
{"SSEKMSEncryptionContext", "x-amz-server-side-encryption-context"},
{"CacheControl", "Cache-Control"},
{"ExpectedSourceBucketOwner", "x-amz-source-expected-bucket-owner"},
{"MetadataDirective", "x-amz-metadata-directive"},
{"StorageClass", "x-amz-storage-class"},
{"CopySourceIfModifiedSince", "x-amz-copy-source-if-modified-since"},
{"GrantRead", "x-amz-grant-read"},
{"TaggingDirective", "x-amz-tagging-directive"},
{"ObjectLockMode", "x-amz-object-lock-mode"},
{"ContentDisposition", "Content-Disposition"},
{"ServerSideEncryption", "x-amz-server-side-encryption"},
{"CopySourceIfNoneMatch", "x-amz-copy-source-if-none-match"},
{"SSEKMSKeyId", "x-amz-server-side-encryption-aws-kms-key-id"},
{"GrantReadACP", "x-amz-grant-read-acp"}
]
|> Request.build_params(input)
{custom_headers, input} =
[
{"Metadata", "x-amz-meta-"}
]
|> Request.build_params(input)
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"x-amz-copy-source-version-id", "CopySourceVersionId"},
{"x-amz-expiration", "Expiration"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption-customer-algorithm", "SSECustomerAlgorithm"},
{"x-amz-server-side-encryption-customer-key-MD5", "SSECustomerKeyMD5"},
{"x-amz-server-side-encryption-context", "SSEKMSEncryptionContext"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-server-side-encryption", "ServerSideEncryption"},
{"x-amz-version-id", "VersionId"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This action creates an Amazon S3 bucket.
To create an Amazon S3 on Outposts bucket, see [
`CreateBucket`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html).
Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have
a valid Amazon Web Services
Access Key ID to authenticate requests. Anonymous requests are never allowed to
create
buckets. By creating the bucket, you become the bucket owner.
There are two types of buckets: general purpose buckets and directory buckets.
For more
information about these bucket types, see [Creating, configuring, and working with Amazon S3
buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html)
in the *Amazon S3 User Guide*.
**General purpose buckets** - If you send your
`CreateBucket` request to the `s3.amazonaws.com` global
endpoint, the request goes to the `us-east-1` Region. So the signature
calculations in Signature Version 4 must use `us-east-1` as the Region,
even if the location constraint in the request specifies another Region where
the
bucket is to be created. If you create a bucket in a Region other than US East
(N.
Virginia), your application must be able to handle 307 redirect. For more
information, see [Virtual hosting of buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html) in
the *Amazon S3 User Guide*.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - In
addition to the `s3:CreateBucket` permission, the following
permissions are required in a policy when your `CreateBucket`
request includes specific headers:
## Access control lists (ACLs)
- In your `CreateBucket` request, if you specify an
access control list (ACL) and set it to `public-read`,
`public-read-write`, `authenticated-read`, or
if you explicitly specify any other custom ACLs, both
`s3:CreateBucket` and `s3:PutBucketAcl`
permissions are required. In your `CreateBucket` request,
if you set the ACL to `private`, or if you don't specify
any ACLs, only the `s3:CreateBucket` permission is
required.
**Object Lock** - In your
`CreateBucket` request, if you set
`x-amz-bucket-object-lock-enabled` to true, the
`s3:PutBucketObjectLockConfiguration` and
`s3:PutBucketVersioning` permissions are
required.
**S3 Object Ownership** - If
your `CreateBucket` request includes the
`x-amz-object-ownership` header, then the
`s3:PutBucketOwnershipControls` permission is
required.
To set an ACL on a bucket as part of a
`CreateBucket` request, you must explicitly set S3
Object Ownership for the bucket to a different value than the
default, `BucketOwnerEnforced`. Additionally, if your
desired bucket ACL grants public access, you must first create the
bucket (without the bucket ACL) and then explicitly disable Block
Public Access on the bucket before using `PutBucketAcl`
to set the ACL. If you try to create a bucket with a public ACL,
the request will fail.
For the majority of modern use cases in S3, we recommend that
you keep all Block Public Access settings enabled and keep ACLs
disabled. If you would like to share data with users outside of
your account, you can use bucket policies as needed. For more
information, see [Controlling ownership of objects and disabling ACLs for your bucket
](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
and [Blocking public access to your Amazon S3 storage
](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html)
in
the *Amazon S3 User Guide*.
**S3 Block Public Access** - If
your specific use case requires granting public access to your S3
resources, you can disable Block Public Access. Specifically, you can
create a new bucket with Block Public Access enabled, then separately
call the [
`DeletePublicAccessBlock`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
API. To use this operation, you must have the
`s3:PutBucketPublicAccessBlock` permission. For more
information about S3 Block Public Access, see [Blocking public access to your Amazon S3 storage
](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** -
You must have the `s3express:CreateBucket` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
Block Public Access are not supported for directory buckets. For
directory buckets, all Block Public Access settings are enabled at the
bucket level and S3 Object Ownership is set to Bucket owner enforced
(ACLs disabled). These settings can't be modified.
For more information about permissions for creating and working with
directory buckets, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)
in the
*Amazon S3 User Guide*. For more information about
supported S3 features for directory buckets, see [Features of S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features)
in the
*Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following operations are related to `CreateBucket`:
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
"""
@spec create_bucket(map(), String.t(), create_bucket_request(), list()) ::
{:ok, create_bucket_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_bucket_errors()}
def create_bucket(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}"
{headers, input} =
[
{"ACL", "x-amz-acl"},
{"GrantFullControl", "x-amz-grant-full-control"},
{"GrantRead", "x-amz-grant-read"},
{"GrantReadACP", "x-amz-grant-read-acp"},
{"GrantWrite", "x-amz-grant-write"},
{"GrantWriteACP", "x-amz-grant-write-acp"},
{"ObjectLockEnabledForBucket", "x-amz-bucket-object-lock-enabled"},
{"ObjectOwnership", "x-amz-object-ownership"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[{"Location", "Location"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a metadata table configuration for a general purpose bucket.
For more
information, see [Accelerating data discovery with S3
Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)
in the *Amazon S3 User Guide*.
## Definitions
### Permissions
To use this operation, you must have the following permissions. For more
information, see [Setting up permissions for configuring metadata
tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)
in the
*Amazon S3 User Guide*.
If you also want to integrate your table bucket with Amazon Web Services
analytics services so that you
can query your metadata table, you need additional permissions. For more
information, see
[
Integrating Amazon S3 Tables with Amazon Web Services analytics
services](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-integrating-aws.html)
in the
*Amazon S3 User Guide*.
`s3:CreateBucketMetadataTableConfiguration`
`s3tables:CreateNamespace`
`s3tables:GetTable`
`s3tables:CreateTable`
`s3tables:PutTablePolicy`
The following operations are related to
`CreateBucketMetadataTableConfiguration`:
*
[DeleteBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html)
*
[GetBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html)
"""
@spec create_bucket_metadata_table_configuration(
map(),
String.t(),
create_bucket_metadata_table_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def create_bucket_metadata_table_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?metadataTable"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This action initiates a multipart upload and returns an upload ID.
This upload ID is
used to associate all of the parts in the specific multipart upload. You specify
this
upload ID in each of your subsequent upload part requests (see
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)). You also include this
upload ID in the final request to either complete or abort the multipart upload
request.
For more information about multipart uploads, see [Multipart Upload
Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) in
the
*Amazon S3 User Guide*.
After you initiate a multipart upload and upload one or more parts, to stop
being
charged for storing the uploaded parts, you must either complete or abort the
multipart
upload. Amazon S3 frees up the space used to store the parts and stops charging
you for
storing them only after you either complete or abort a multipart upload.
If you have configured a lifecycle rule to abort incomplete multipart uploads,
the
created multipart upload must be completed within the number of days specified
in the
bucket lifecycle configuration. Otherwise, the incomplete multipart upload
becomes eligible
for an abort action and Amazon S3 aborts the multipart upload. For more
information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).
**Directory buckets ** -
S3 Lifecycle is not supported by directory buckets.
**Directory buckets ** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Request signing
For request signing, multipart upload is just a series of regular requests. You
initiate a multipart upload, send one or more requests to upload parts, and then
complete the multipart upload process. You sign each request individually. There
is nothing special about signing multipart upload requests. For more information
about signing, see [Authenticating Requests (Amazon Web Services Signature Version
4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html)
in the
*Amazon S3 User Guide*.
### Permissions
**General purpose bucket permissions** - To
perform a multipart upload with encryption using an Key Management Service (KMS)
KMS key, the requester must have permission to the
`kms:Decrypt` and `kms:GenerateDataKey` actions on
the key. The requester must also have permissions for the
`kms:GenerateDataKey` action for the
`CreateMultipartUpload` API. Then, the requester needs
permissions for the `kms:Decrypt` action on the
`UploadPart` and `UploadPartCopy` APIs. These
permissions are required because Amazon S3 must decrypt and read data from the
encrypted file parts before it completes the multipart upload. For more
information, see [Multipart upload API and permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)
and [Protecting data using server-side encryption with Amazon Web Services
KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
### Encryption
**General purpose buckets** - Server-side
encryption is for data encryption at rest. Amazon S3 encrypts your data as it
writes it to disks in its data centers and decrypts it when you access it.
Amazon S3 automatically encrypts all new objects that are uploaded to an S3
bucket. When doing a multipart upload, if you don't specify encryption
information in your request, the encryption setting of the uploaded parts is
set to the default encryption configuration of the destination bucket. By
default, all buckets have a base level of encryption configuration that uses
server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination
bucket has a default encryption configuration that uses server-side
encryption with an Key Management Service (KMS) key (SSE-KMS), or a
customer-provided
encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a
customer-provided key to encrypt the uploaded parts. When you perform a
CreateMultipartUpload operation, if you want to use a different type of
encryption setting for the uploaded parts, you can request that Amazon S3
encrypts the object with a different encryption key (such as an Amazon S3
managed
key, a KMS key, or a customer-provided key). When the encryption setting
in your request is different from the default encryption configuration of
the destination bucket, the encryption setting in your request takes
precedence. If you choose to provide your own encryption key, the request
headers you provide in
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) and
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)
requests must match the headers you used in the
`CreateMultipartUpload` request.
Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key
(`aws/s3`) and KMS customer managed keys stored in Key Management Service
(KMS) – If you want Amazon Web Services to manage the keys used to encrypt data,
specify the following headers in the request.
`x-amz-server-side-encryption`
`x-amz-server-side-encryption-aws-kms-key-id`
`x-amz-server-side-encryption-context`
If you specify
`x-amz-server-side-encryption:aws:kms`, but
don't provide
`x-amz-server-side-encryption-aws-kms-key-id`,
Amazon S3 uses the Amazon Web Services managed key (`aws/s3` key) in
KMS to protect the data.
To perform a multipart upload with encryption by using an
Amazon Web Services KMS key, the requester must have permission to the
`kms:Decrypt` and
`kms:GenerateDataKey*` actions on the key.
These permissions are required because Amazon S3 must decrypt and
read data from the encrypted file parts before it completes
the multipart upload. For more information, see [Multipart upload API and permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)
and [Protecting data using server-side encryption with Amazon Web Services KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)
in the
*Amazon S3 User Guide*.
If your Identity and Access Management (IAM) user or role is in the same
Amazon Web Services account as the KMS key, then you must have these
permissions on the key policy. If your IAM user or role is
in a different account from the key, then you must have the
permissions on both the key policy and your IAM user or
role.
All `GET` and `PUT` requests for an
object protected by KMS fail if you don't make them by
using Secure Sockets Layer (SSL), Transport Layer Security
(TLS), or Signature Version 4. For information about
configuring any of the officially supported Amazon Web Services SDKs and
Amazon Web Services CLI, see [Specifying the Signature Version in Request
Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)
in the
*Amazon S3 User Guide*.
For more information about server-side encryption with KMS keys
(SSE-KMS), see [Protecting Data Using Server-Side Encryption with KMS
keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)
in the
*Amazon S3 User Guide*.
Use customer-provided encryption keys (SSE-C) – If you want to
manage your own encryption keys, provide all the following headers in
the request.
`x-amz-server-side-encryption-customer-algorithm`
`x-amz-server-side-encryption-customer-key`
`x-amz-server-side-encryption-customer-key-MD5`
For more information about server-side encryption with
customer-provided encryption keys (SSE-C), see [ Protecting data using server-side encryption with
customer-provided encryption keys
(SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html)
in the
*Amazon S3 User Guide*.
**Directory buckets** -
For directory buckets, there are only two supported options for server-side
encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)
(`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We
recommend that the bucket's default encryption uses the desired encryption
configuration and you don't override the bucket default encryption in your
`CreateSession` requests or `PUT` object requests. Then, new objects
are automatically encrypted with the desired encryption settings. For more
information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)
in the *Amazon S3 User Guide*. For more information about the encryption
overriding behaviors in directory buckets, see [Specifying server-side encryption with KMS for new object
uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).
In the Zonal endpoint API calls (except
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) and
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))
using the REST API, the encryption request headers must match the encryption
settings that are specified in the `CreateSession` request.
You can't override the values of the encryption settings
(`x-amz-server-side-encryption`, `x-amz-server-side-encryption-aws-kms-key-id`,
`x-amz-server-side-encryption-context`, and
`x-amz-server-side-encryption-bucket-key-enabled`) that are specified in the
`CreateSession` request.
You don't need to explicitly specify these encryption settings values in Zonal
endpoint API calls, and
Amazon S3 will use the encryption settings values from the `CreateSession`
request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for `CreateSession`, the
session token refreshes automatically to avoid service interruptions when a
session expires. The CLI or the Amazon Web Services SDKs use the bucket's
default encryption configuration for the
`CreateSession` request. It's not supported to override the encryption settings
values in the `CreateSession` request.
So in the Zonal endpoint API calls (except
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) and
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),
the encryption request headers must match the default encryption configuration
of the directory bucket.
For directory buckets, when you perform a
`CreateMultipartUpload` operation and an
`UploadPartCopy` operation, the request headers you provide
in the `CreateMultipartUpload` request must match the default
encryption configuration of the destination bucket.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `CreateMultipartUpload`:
*
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
[CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
[AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
[ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
"""
@spec create_multipart_upload(
map(),
String.t(),
String.t(),
create_multipart_upload_request(),
list()
) ::
{:ok, create_multipart_upload_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def create_multipart_upload(%Client{} = client, bucket, key, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?uploads"
{headers, input} =
[
{"ACL", "x-amz-acl"},
{"BucketKeyEnabled", "x-amz-server-side-encryption-bucket-key-enabled"},
{"CacheControl", "Cache-Control"},
{"ChecksumAlgorithm", "x-amz-checksum-algorithm"},
{"ChecksumType", "x-amz-checksum-type"},
{"ContentDisposition", "Content-Disposition"},
{"ContentEncoding", "Content-Encoding"},
{"ContentLanguage", "Content-Language"},
{"ContentType", "Content-Type"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"Expires", "Expires"},
{"GrantFullControl", "x-amz-grant-full-control"},
{"GrantRead", "x-amz-grant-read"},
{"GrantReadACP", "x-amz-grant-read-acp"},
{"GrantWriteACP", "x-amz-grant-write-acp"},
{"ObjectLockLegalHoldStatus", "x-amz-object-lock-legal-hold"},
{"ObjectLockMode", "x-amz-object-lock-mode"},
{"ObjectLockRetainUntilDate", "x-amz-object-lock-retain-until-date"},
{"RequestPayer", "x-amz-request-payer"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"},
{"SSEKMSEncryptionContext", "x-amz-server-side-encryption-context"},
{"SSEKMSKeyId", "x-amz-server-side-encryption-aws-kms-key-id"},
{"ServerSideEncryption", "x-amz-server-side-encryption"},
{"StorageClass", "x-amz-storage-class"},
{"Tagging", "x-amz-tagging"},
{"WebsiteRedirectLocation", "x-amz-website-redirect-location"}
]
|> Request.build_params(input)
{custom_headers, input} =
[
{"Metadata", "x-amz-meta-"}
]
|> Request.build_params(input)
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-abort-date", "AbortDate"},
{"x-amz-abort-rule-id", "AbortRuleId"},
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"x-amz-checksum-algorithm", "ChecksumAlgorithm"},
{"x-amz-checksum-type", "ChecksumType"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption-customer-algorithm", "SSECustomerAlgorithm"},
{"x-amz-server-side-encryption-customer-key-MD5", "SSECustomerKeyMD5"},
{"x-amz-server-side-encryption-context", "SSEKMSEncryptionContext"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-server-side-encryption", "ServerSideEncryption"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a session that establishes temporary security credentials to support
fast
authentication and authorization for the Zonal endpoint API operations on
directory buckets.
For more
information about Zonal endpoint API operations that include the Availability
Zone in the request endpoint, see [S3 Express One Zone APIs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html)
in the *Amazon S3 User Guide*.
To make Zonal endpoint API requests on a directory bucket, use the
`CreateSession`
API operation. Specifically, you grant `s3express:CreateSession` permission to a
bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM
credentials to make the
`CreateSession` API request on the bucket, which returns temporary security
credentials that include the access key ID, secret access key, session token,
and
expiration. These credentials have associated permissions to access the Zonal
endpoint API operations. After
the session is created, you don’t need to use other policies to grant
permissions to each
Zonal endpoint API individually. Instead, in your Zonal endpoint API requests,
you sign your requests by
applying the temporary security credentials of the session to the request
headers and
following the SigV4 protocol for authentication. You also apply the session
token to the
`x-amz-s3session-token` request header for authorization. Temporary security
credentials are scoped to the bucket and expire after 5 minutes. After the
expiration time,
any calls that you make with those credentials will fail. You must use IAM
credentials
again to make a `CreateSession` API request that generates a new set of
temporary credentials for use. Temporary credentials cannot be extended or
refreshed beyond
the original specified interval.
If you use Amazon Web Services SDKs, SDKs handle the session token refreshes
automatically to avoid
service interruptions when a session expires. We recommend that you use the
Amazon Web Services SDKs to
initiate and manage requests to the CreateSession API. For more information, see
[Performance guidelines and design patterns](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication)
in the
*Amazon S3 User Guide*.
You must make requests for this API operation to the Zonal endpoint. These
endpoints support virtual-hosted-style requests in the format
`https://*bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com`.
Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
**
`CopyObject` API operation## -
Unlike other Zonal endpoint API operations, the `CopyObject` API operation
doesn't use
the temporary security credentials returned from the `CreateSession`
API operation for authentication and authorization. For information about
authentication and authorization of the `CopyObject` API operation on
directory buckets, see
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html).
`HeadBucket` API operation** -
Unlike other Zonal endpoint API operations, the `HeadBucket` API operation
doesn't use
the temporary security credentials returned from the `CreateSession`
API operation for authentication and authorization. For information about
authentication and authorization of the `HeadBucket` API operation on
directory buckets, see
[HeadBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html).
## Definitions
### Permissions
To obtain temporary security credentials, you must create
a bucket policy or an IAM identity-based policy that grants
`s3express:CreateSession`
permission to the bucket. In a policy, you can have the
`s3express:SessionMode` condition key to control who can create a
`ReadWrite` or `ReadOnly` session. For more information
about `ReadWrite` or `ReadOnly` sessions, see [
`x-amz-create-session-mode`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters).
For example policies, see
[Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)
and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for
S3 Express One
Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)
in the *Amazon S3 User Guide*.
To grant cross-account access to Zonal endpoint API operations, the bucket
policy should also
grant both accounts the `s3express:CreateSession` permission.
If you want to encrypt objects with SSE-KMS, you must also have the
`kms:GenerateDataKey` and the `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the target KMS
key.
### Encryption
For directory buckets, there are only two supported options for server-side
encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)
(`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We
recommend that the bucket's default encryption uses the desired encryption
configuration and you don't override the bucket default encryption in your
`CreateSession` requests or `PUT` object requests. Then, new objects
are automatically encrypted with the desired encryption settings. For more
information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)
in the *Amazon S3 User Guide*. For more information about the encryption
overriding behaviors in directory buckets, see [Specifying server-side encryption with KMS for new object
uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).
For [Zonal endpoint (object-level) API operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-differences.html#s3-express-differences-api-operations)
except
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) and
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html),
you authenticate and authorize requests through
[CreateSession](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) for low latency.
To encrypt new objects in a directory bucket with SSE-KMS, you must specify
SSE-KMS as the directory bucket's default encryption configuration with a KMS
key (specifically, a [customer managed
key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)).
Then, when a session is created for Zonal endpoint API operations, new objects
are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys during
the session.
Only 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)
is supported per directory bucket for the lifetime of the bucket. The [Amazon Web Services managed
key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)
(`aws/s3`) isn't supported.
After you specify SSE-KMS as your bucket's default encryption configuration with
a customer managed key, you can't change the customer managed key for the
bucket's SSE-KMS configuration.
In the Zonal endpoint API calls (except
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) and
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html))
using the REST API,
you can't override the values of the encryption settings
(`x-amz-server-side-encryption`, `x-amz-server-side-encryption-aws-kms-key-id`,
`x-amz-server-side-encryption-context`, and
`x-amz-server-side-encryption-bucket-key-enabled`) from the `CreateSession`
request.
You don't need to explicitly specify these encryption settings values in Zonal
endpoint API calls, and
Amazon S3 will use the encryption settings values from the `CreateSession`
request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for `CreateSession`, the
session token refreshes automatically to avoid service interruptions when a
session expires. The CLI or the Amazon Web Services SDKs use the bucket's
default encryption configuration for the
`CreateSession` request. It's not supported to override the encryption settings
values in the `CreateSession` request.
Also, in the Zonal endpoint API calls (except
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) and
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)),
it's not supported to override the values of the encryption settings from the
`CreateSession` request.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
"""
@spec create_session(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, create_session_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_session_errors()}
def create_session(
%Client{} = client,
bucket,
bucket_key_enabled \\ nil,
sse_kms_encryption_context \\ nil,
sse_kms_key_id \\ nil,
server_side_encryption \\ nil,
session_mode \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?session"
headers = []
headers =
if !is_nil(bucket_key_enabled) do
[{"x-amz-server-side-encryption-bucket-key-enabled", bucket_key_enabled} | headers]
else
headers
end
headers =
if !is_nil(sse_kms_encryption_context) do
[{"x-amz-server-side-encryption-context", sse_kms_encryption_context} | headers]
else
headers
end
headers =
if !is_nil(sse_kms_key_id) do
[{"x-amz-server-side-encryption-aws-kms-key-id", sse_kms_key_id} | headers]
else
headers
end
headers =
if !is_nil(server_side_encryption) do
[{"x-amz-server-side-encryption", server_side_encryption} | headers]
else
headers
end
headers =
if !is_nil(session_mode) do
[{"x-amz-create-session-mode", session_mode} | headers]
else
headers
end
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"x-amz-server-side-encryption-context", "SSEKMSEncryptionContext"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-server-side-encryption", "ServerSideEncryption"}
]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Deletes the S3 bucket.
All objects (including all object versions and delete markers) in
the bucket must be deleted before the bucket itself can be deleted.
**Directory buckets** - If multipart
uploads in a directory bucket are in progress, you can't delete the bucket until
all the in-progress multipart uploads are aborted or completed.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - You
must have the `s3:DeleteBucket` permission on the specified
bucket in a policy.
**Directory bucket permissions** -
You must have the `s3express:DeleteBucket` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following operations are related to `DeleteBucket`:
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
"""
@spec delete_bucket(map(), String.t(), delete_bucket_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Deletes an analytics configuration for the bucket (specified by the analytics
configuration ID).
To use this operation, you must have permissions to perform the
`s3:PutAnalyticsConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class
Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
The following operations are related to
`DeleteBucketAnalyticsConfiguration`:
*
[GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
*
[ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
*
[PutBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
"""
@spec delete_bucket_analytics_configuration(
map(),
String.t(),
delete_bucket_analytics_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_analytics_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?analytics"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Deletes the `cors` configuration information set for the bucket.
To use this operation, you must have permission to perform the
`s3:PutBucketCORS` action. The bucket owner has this permission by default
and can grant this permission to others.
For information about `cors`, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in
the *Amazon S3 User Guide*.
## Related Resources
*
[PutBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html)
*
[RESTOPTIONSobject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html)
"""
@spec delete_bucket_cors(map(), String.t(), delete_bucket_cors_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_cors(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?cors"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This implementation of the DELETE action resets the default encryption for the
bucket as
server-side encryption with Amazon S3 managed keys (SSE-S3).
**General purpose buckets** - For information
about the bucket default encryption feature, see [Amazon S3 Bucket Default Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
in the *Amazon S3 User Guide*.
**Directory buckets** -
For directory buckets, there are only two supported options for server-side
encryption: SSE-S3 and SSE-KMS. For information about the default encryption
configuration in directory buckets, see [Setting default server-side encryption behavior for directory
buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html).
## Definitions
### Permissions
**General purpose bucket permissions** - The
`s3:PutEncryptionConfiguration` permission is required in a
policy. The bucket owner has this permission by default. The bucket owner
can grant this permission to others. For more information about permissions,
see [Permissions Related to Bucket Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
**Directory bucket permissions** -
To grant access to this API operation, you must have the
`s3express:PutEncryptionConfiguration` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following operations are related to `DeleteBucketEncryption`:
*
[PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)
*
[GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)
"""
@spec delete_bucket_encryption(map(), String.t(), delete_bucket_encryption_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_encryption(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?encryption"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs
by automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data
with unknown, changing, or unpredictable access patterns, independent of object
size or retention period. If the size of an object is less than 128 KB, it is
not monitored and not eligible for auto-tiering. Smaller objects can be stored,
but they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class.
For more information, see [Storage class for automatically optimizing frequently and infrequently accessed
objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to `DeleteBucketIntelligentTieringConfiguration` include:
*
[GetBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
*
[PutBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
*
[ListBucketIntelligentTieringConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
"""
@spec delete_bucket_intelligent_tiering_configuration(
map(),
String.t(),
delete_bucket_intelligent_tiering_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_intelligent_tiering_configuration(
%Client{} = client,
bucket,
input,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?intelligent-tiering"
headers = []
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Deletes an inventory configuration (identified by the inventory ID) from the
bucket.
To use this operation, you must have permissions to perform the
`s3:PutInventoryConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html).
Operations related to `DeleteBucketInventoryConfiguration` include:
*
[GetBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
*
[PutBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
*
[ListBucketInventoryConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
"""
@spec delete_bucket_inventory_configuration(
map(),
String.t(),
delete_bucket_inventory_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_inventory_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?inventory"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes the lifecycle configuration from the specified bucket.
Amazon S3 removes all the
lifecycle configuration rules in the lifecycle subresource associated with the
bucket. Your
objects never expire, and Amazon S3 no longer automatically deletes any objects
on the basis of
rules contained in the deleted lifecycle configuration.
## Definitions
### Permissions
**General purpose bucket permissions** - By
default, all Amazon S3 resources are private, including buckets, objects, and
related subresources (for example, lifecycle configuration and website
configuration). Only the resource owner (that is, the Amazon Web Services
account that
created it) can access the resource. The resource owner can optionally grant
access permissions to others by writing an access policy. For this
operation, a user must have the `s3:PutLifecycleConfiguration`
permission.
For more information about permissions, see [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
**Directory bucket permissions** -
You must have the `s3express:PutLifecycleConfiguration`
permission in an IAM identity-based policy to use this operation.
Cross-account access to this API operation isn't supported. The resource
owner can optionally grant access permissions to others by creating a role
or user for them as long as they are within the same account as the owner
and resource.
For more information about directory bucket policies and permissions, see
[Authorizing Regional endpoint APIs with IAM](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the
*Amazon S3 User Guide*.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host
header syntax is
`s3express-control.*region*.amazonaws.com`.
For more information about the object expiration, see [Elements to Describe Lifecycle
Actions](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions).
Related actions include:
*
[PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
*
[GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
"""
@spec delete_bucket_lifecycle(map(), String.t(), delete_bucket_lifecycle_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_lifecycle(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?lifecycle"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes a metadata table configuration from a general purpose bucket.
For more
information, see [Accelerating data discovery with S3
Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)
in the *Amazon S3 User Guide*.
## Definitions
### Permissions
To use this operation, you must have the
`s3:DeleteBucketMetadataTableConfiguration` permission. For more
information, see [Setting up permissions for configuring metadata
tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)
in the
*Amazon S3 User Guide*.
The following operations are related to
`DeleteBucketMetadataTableConfiguration`:
*
[CreateBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html)
*
[GetBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html)
"""
@spec delete_bucket_metadata_table_configuration(
map(),
String.t(),
delete_bucket_metadata_table_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_metadata_table_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?metadataTable"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Deletes a metrics configuration for the Amazon CloudWatch request metrics
(specified by the
metrics configuration ID) from the bucket. Note that this doesn't include the
daily storage
metrics.
To use this operation, you must have permissions to perform the
`s3:PutMetricsConfiguration` action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about
permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with
Amazon
CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to
`DeleteBucketMetricsConfiguration`:
*
[GetBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
*
[PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
*
[ListBucketMetricsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
*
[Monitoring Metrics with Amazon
CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)
"""
@spec delete_bucket_metrics_configuration(
map(),
String.t(),
delete_bucket_metrics_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_metrics_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?metrics"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Removes `OwnershipControls` for an Amazon S3 bucket. To use this operation, you
must have the `s3:PutBucketOwnershipControls` permission. For more information
about Amazon S3 permissions, see [Specifying Permissions in a Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
For information about Amazon S3 Object Ownership, see [Using Object Ownership](https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html).
The following operations are related to
`DeleteBucketOwnershipControls`:
*
`GetBucketOwnershipControls`
*
`PutBucketOwnershipControls`
"""
@spec delete_bucket_ownership_controls(
map(),
String.t(),
delete_bucket_ownership_controls_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_ownership_controls(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?ownershipControls"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes the policy of a specified bucket.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
If you are using an identity other than the root user of the Amazon Web Services
account that
owns the bucket, the calling identity must both have the
`DeleteBucketPolicy` permissions on the specified bucket and belong
to the bucket owner's account in order to use this operation.
If you don't have `DeleteBucketPolicy` permissions, Amazon S3 returns a
`403 Access Denied` error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's account, Amazon
S3
returns a `405 Method Not Allowed` error.
To ensure that bucket owners don't inadvertently lock themselves out of
their own buckets, the root principal in a bucket owner's Amazon Web Services
account can
perform the `GetBucketPolicy`, `PutBucketPolicy`, and
`DeleteBucketPolicy` API actions, even if their bucket policy
explicitly denies the root principal's access. Bucket owner root principals can
only be blocked from performing these API actions by VPC endpoint policies and
Amazon Web Services Organizations policies.
**General purpose bucket permissions** - The
`s3:DeleteBucketPolicy` permission is required in a policy.
For more information about general purpose buckets bucket policies, see [Using Bucket Policies and User
Policies](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** -
To grant access to this API operation, you must have the
`s3express:DeleteBucketPolicy` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following operations are related to `DeleteBucketPolicy`
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
"""
@spec delete_bucket_policy(map(), String.t(), delete_bucket_policy_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_policy(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?policy"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the
`s3:PutReplicationConfiguration` action. The bucket owner has these
permissions by default and can grant it to others. For more information about
permissions,
see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
It can take a while for the deletion of a replication configuration to fully
propagate.
For information about replication configuration, see
[Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the
*Amazon S3 User Guide*.
The following operations are related to `DeleteBucketReplication`:
*
[PutBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html)
*
[GetBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html)
"""
@spec delete_bucket_replication(map(), String.t(), delete_bucket_replication_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_replication(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?replication"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the
`s3:PutBucketTagging` action. By default, the bucket owner has this
permission and can grant this permission to others.
The following operations are related to `DeleteBucketTagging`:
*
[GetBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html)
*
[PutBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html)
"""
@spec delete_bucket_tagging(map(), String.t(), delete_bucket_tagging_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_tagging(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?tagging"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
This action removes the website configuration for a bucket. Amazon S3 returns a
```
200
OK
```
response upon successfully deleting a website configuration on the specified
bucket. You will get a `200 OK` response if the website configuration you are
trying to delete does not exist on the bucket. Amazon S3 returns a `404`
response if
the bucket specified in the request does not exist.
This DELETE action requires the `S3:DeleteBucketWebsite` permission. By
default, only the bucket owner can delete the website configuration attached to
a bucket.
However, bucket owners can grant other users permission to delete the website
configuration
by writing a bucket policy granting them the `S3:DeleteBucketWebsite`
permission.
For more information about hosting websites, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
The following operations are related to `DeleteBucketWebsite`:
*
[GetBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html)
*
[PutBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html)
"""
@spec delete_bucket_website(map(), String.t(), delete_bucket_website_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_bucket_website(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?website"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Removes an object from a bucket.
The behavior depends on the bucket's versioning state:
*
If bucket versioning is not enabled, the operation permanently deletes the
object.
*
If bucket versioning is enabled, the operation inserts a delete marker, which
becomes the current version of the object. To permanently delete an object in a
versioned bucket, you must include the object’s `versionId` in the request. For
more information about versioning-enabled buckets, see [Deleting object versions from a versioning-enabled
bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html).
*
If bucket versioning is suspended, the operation removes the object that has a
null `versionId`, if there is one, and inserts a delete marker that becomes the
current version of the object. If there isn't an object with a null `versionId`,
and all versions of the object have a `versionId`, Amazon S3 does not remove the
object and only inserts a delete marker. To permanently delete an object that
has a `versionId`, you must include the object’s `versionId` in the request. For
more information about versioning-suspended buckets, see [Deleting objects from versioning-suspended
buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html).
**Directory buckets** - S3 Versioning isn't enabled and supported for directory
buckets. For this API operation, only the `null` value of the version ID is
supported by directory buckets. You can only specify `null`
to the `versionId` query parameter in the request.
**Directory buckets** - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
To remove a specific version, you must use the `versionId` query parameter.
Using this
query parameter permanently deletes the version. If the object deleted is a
delete marker, Amazon S3
sets the response header `x-amz-delete-marker` to true.
If the object you want to delete is in a bucket where the bucket versioning
configuration is MFA Delete enabled, you must include the `x-amz-mfa` request
header in the DELETE `versionId` request. Requests that include
`x-amz-mfa` must use HTTPS. For more information about MFA Delete, see [Using MFA Delete](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html)
in the *Amazon S3
User Guide*. To see sample
requests that use versioning, see [Sample Request](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete).
**Directory buckets** - MFA delete is not supported by directory buckets.
You can delete objects by explicitly calling DELETE Object or calling
([PutBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)) to enable Amazon S3 to remove them for you. If you want to block
users or accounts from removing or deleting objects from your bucket, you must
deny them
the `s3:DeleteObject`, `s3:DeleteObjectVersion`, and
`s3:PutLifeCycleConfiguration` actions.
**Directory buckets** - S3 Lifecycle is not supported by directory buckets.
## Definitions
### Permissions
**General purpose bucket permissions## - The following permissions are required
in your policies when your
`DeleteObjects` request includes specific headers.
`s3:DeleteObject`
## - To delete an object from a bucket, you must always have the
`s3:DeleteObject` permission.
`s3:DeleteObjectVersion`
** - To delete a specific version of an object from a versioning-enabled bucket,
you must have the `s3:DeleteObjectVersion` permission.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following action is related to `DeleteObject`:
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
"""
@spec delete_object(map(), String.t(), String.t(), delete_object_request(), list()) ::
{:ok, delete_object_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_object(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=DeleteObject"
{headers, input} =
[
{"BypassGovernanceRetention", "x-amz-bypass-governance-retention"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"IfMatch", "If-Match"},
{"IfMatchLastModifiedTime", "x-amz-if-match-last-modified-time"},
{"IfMatchSize", "x-amz-if-match-size"},
{"MFA", "x-amz-mfa"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-delete-marker", "DeleteMarker"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-version-id", "VersionId"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
Removes the entire tag set from the specified object. For more information about
managing object tags, see [ Object Tagging](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).
To use this operation, you must have permission to perform the
`s3:DeleteObjectTagging` action.
To delete tags of a specific object version, add the `versionId` query
parameter in the request. You will need permission for the
`s3:DeleteObjectVersionTagging` action.
The following operations are related to `DeleteObjectTagging`:
*
[PutObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html)
*
[GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
"""
@spec delete_object_tagging(
map(),
String.t(),
String.t(),
delete_object_tagging_request(),
list()
) ::
{:ok, delete_object_tagging_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_object_tagging(%Client{} = client, bucket, key, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?tagging"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-version-id", "VersionId"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation enables you to delete multiple objects from a bucket using a
single HTTP
request.
If you know the object keys that you want to delete, then this operation
provides
a suitable alternative to sending individual delete requests, reducing
per-request
overhead.
The request can contain a list of up to 1,000 keys that you want to delete. In
the XML, you
provide the object key names, and optionally, version IDs if you want to delete
a specific
version of the object from a versioning-enabled bucket. For each key, Amazon S3
performs a
delete operation and returns the result of that delete, success or failure, in
the response.
If the object specified in the request isn't found, Amazon S3 confirms the
deletion by returning the result as deleted.
**Directory buckets** -
S3 Versioning isn't enabled and supported for directory buckets.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
The operation supports two modes for the response: verbose and quiet. By
default, the
operation uses verbose mode in which the response includes the result of
deletion of each
key in your request. In quiet mode the response includes only keys where the
delete
operation encountered an error. For a successful deletion in a quiet mode, the
operation
does not return any information about the delete in the response body.
When performing this action on an MFA Delete enabled bucket, that attempts to
delete any
versioned objects, you must include an MFA token. If you do not provide one, the
entire
request will fail, even if there are non-versioned objects you are trying to
delete. If you
provide an invalid token, whether there are versioned keys in the request or
not, the
entire Multi-Object Delete request will fail. For information about MFA Delete,
see [MFA Delete](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete)
in the *Amazon S3 User Guide*.
**Directory buckets** -
MFA delete is not supported by directory buckets.
## Definitions
### Permissions
**General purpose bucket permissions## - The
following permissions are required in your policies when your
`DeleteObjects` request includes specific headers.
`s3:DeleteObject`
##
- To delete an object from a bucket, you must always specify
the `s3:DeleteObject` permission.
`s3:DeleteObjectVersion`
** - To delete a specific version of an object from a
versioning-enabled bucket, you must specify the
`s3:DeleteObjectVersion` permission.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
### Content-MD5 request header
**General purpose bucket** - The Content-MD5
request header is required for all Multi-Object Delete requests. Amazon S3 uses
the header value to ensure that your request body has not been altered in
transit.
**Directory bucket** - The
Content-MD5 request header or a additional checksum request header
(including `x-amz-checksum-crc32`,
`x-amz-checksum-crc32c`, `x-amz-checksum-sha1`, or
`x-amz-checksum-sha256`) is required for all Multi-Object
Delete requests.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `DeleteObjects`:
*
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
[CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
[AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
"""
@spec delete_objects(map(), String.t(), delete_objects_request(), list()) ::
{:ok, delete_objects_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_objects(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?delete"
{headers, input} =
[
{"BypassGovernanceRetention", "x-amz-bypass-governance-retention"},
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"MFA", "x-amz-mfa"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
options =
Keyword.put(
options,
:append_sha256_content_hash,
true
)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Removes the `PublicAccessBlock` configuration for an Amazon S3 bucket. To use
this
operation, you must have the `s3:PutBucketPublicAccessBlock` permission. For
more information about permissions, see [Permissions Related to Bucket Subresource
Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
The following operations are related to `DeletePublicAccessBlock`:
*
[Using Amazon S3 Block Public
Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
*
[GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
[PutPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
*
[GetBucketPolicyStatus](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html)
"""
@spec delete_public_access_block(
map(),
String.t(),
delete_public_access_block_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def delete_public_access_block(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?publicAccessBlock"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
This operation is not supported for directory buckets.
This implementation of the GET action uses the `accelerate` subresource to
return the Transfer Acceleration state of a bucket, which is either `Enabled` or
`Suspended`. Amazon S3 Transfer Acceleration is a bucket-level feature that
enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the
`s3:GetAccelerateConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the
*Amazon S3 User Guide*.
You set the Transfer Acceleration state of an existing bucket to `Enabled` or
`Suspended` by using the
[PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) operation.
A GET `accelerate` request does not return a state value for a bucket that
has no transfer acceleration state. A bucket has no Transfer Acceleration state
if a state
has never been set on the bucket.
For more information about transfer acceleration, see [Transfer
Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html)
in
the Amazon S3 User Guide.
The following operations are related to
`GetBucketAccelerateConfiguration`:
*
[PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html)
"""
@spec get_bucket_accelerate_configuration(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_bucket_accelerate_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_accelerate_configuration(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?accelerate"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
This implementation of the `GET` action uses the `acl` subresource
to return the access control list (ACL) of a bucket. To use `GET` to return the
ACL of the bucket, you must have the `READ_ACP` access to the bucket. If
`READ_ACP` permission is granted to the anonymous user, you can return the
ACL of the bucket without using an authorization header.
When you use this API operation with an access point, provide the alias of the
access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name.
If the Object Lambda access point alias in a request is not valid, the error
code `InvalidAccessPointAliasError` is returned.
For more information about `InvalidAccessPointAliasError`, see [List of Error
Codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
requests to read ACLs are still supported and return the
`bucket-owner-full-control` ACL with the owner being the account that
created the bucket. For more information, see [ Controlling object ownership and disabling
ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the
*Amazon S3 User Guide*.
The following operations are related to `GetBucketAcl`:
*
[ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)
"""
@spec get_bucket_acl(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_acl_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_acl(%Client{} = client, bucket, expected_bucket_owner \\ nil, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?acl"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
This implementation of the GET action returns an analytics configuration
(identified by
the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
`s3:GetAnalyticsConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [ Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the
*Amazon S3 User Guide*.
For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class
Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html)
in the *Amazon S3 User Guide*.
The following operations are related to
`GetBucketAnalyticsConfiguration`:
*
[DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
*
[ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
*
[PutBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
"""
@spec get_bucket_analytics_configuration(
map(),
String.t(),
String.t(),
String.t() | nil,
list()
) ::
{:ok, get_bucket_analytics_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_analytics_configuration(
%Client{} = client,
bucket,
id,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?analytics&x-id=GetBucketAnalyticsConfiguration"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(id) do
[{"id", id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the Cross-Origin Resource Sharing (CORS) configuration information set
for the
bucket.
To use this operation, you must have permission to perform the
`s3:GetBucketCORS` action. By default, the bucket owner has this permission
and can grant it to others.
When you use this API operation with an access point, provide the alias of the
access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name.
If the Object Lambda access point alias in a request is not valid, the error
code `InvalidAccessPointAliasError` is returned.
For more information about `InvalidAccessPointAliasError`, see [List of Error
Codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).
For more information about CORS, see [ Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html).
The following operations are related to `GetBucketCors`:
*
[PutBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html)
*
[DeleteBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html)
"""
@spec get_bucket_cors(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_cors_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_cors(%Client{} = client, bucket, expected_bucket_owner \\ nil, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?cors"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the default encryption configuration for an Amazon S3 bucket.
By default, all buckets
have a default encryption configuration that uses server-side encryption with
Amazon S3 managed
keys (SSE-S3).
**General purpose buckets** - For information
about the bucket default encryption feature, see [Amazon S3 Bucket Default Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
in the *Amazon S3 User Guide*.
**Directory buckets** -
For directory buckets, there are only two supported options for server-side
encryption: SSE-S3 and SSE-KMS. For information about the default encryption
configuration in directory buckets, see [Setting default server-side encryption behavior for directory
buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html).
## Definitions
### Permissions
**General purpose bucket permissions** - The
`s3:GetEncryptionConfiguration` permission is required in a
policy. The bucket owner has this permission by default. The bucket owner
can grant this permission to others. For more information about permissions,
see [Permissions Related to Bucket Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
**Directory bucket permissions** -
To grant access to this API operation, you must have the
`s3express:GetEncryptionConfiguration` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following operations are related to `GetBucketEncryption`:
*
[PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)
*
[DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)
"""
@spec get_bucket_encryption(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_encryption_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_encryption(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?encryption"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs
by automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data
with unknown, changing, or unpredictable access patterns, independent of object
size or retention period. If the size of an object is less than 128 KB, it is
not monitored and not eligible for auto-tiering. Smaller objects can be stored,
but they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class.
For more information, see [Storage class for automatically optimizing frequently and infrequently accessed
objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to `GetBucketIntelligentTieringConfiguration` include:
*
[DeleteBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
*
[PutBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
*
[ListBucketIntelligentTieringConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
"""
@spec get_bucket_intelligent_tiering_configuration(map(), String.t(), String.t(), list()) ::
{:ok, get_bucket_intelligent_tiering_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_intelligent_tiering_configuration(%Client{} = client, bucket, id, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}?intelligent-tiering&x-id=GetBucketIntelligentTieringConfiguration"
headers = []
query_params = []
query_params =
if !is_nil(id) do
[{"id", id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns an inventory configuration (identified by the inventory configuration
ID) from
the bucket.
To use this operation, you must have permissions to perform the
`s3:GetInventoryConfiguration` action. The bucket owner has this permission
by default and can grant this permission to others. For more information about
permissions,
see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html).
The following operations are related to
`GetBucketInventoryConfiguration`:
*
[DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
*
[ListBucketInventoryConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
*
[PutBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
"""
@spec get_bucket_inventory_configuration(
map(),
String.t(),
String.t(),
String.t() | nil,
list()
) ::
{:ok, get_bucket_inventory_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_inventory_configuration(
%Client{} = client,
bucket,
id,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?inventory&x-id=GetBucketInventoryConfiguration"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(id) do
[{"id", id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the lifecycle configuration information set on the bucket.
For information about
lifecycle configuration, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html).
Bucket lifecycle configuration now supports specifying a lifecycle rule using an
object
key name prefix, one or more object tags, object size, or any combination of
these.
Accordingly, this section describes the latest API, which is compatible with the
new
functionality. The previous version of the API supported filtering based only on
an object
key name prefix, which is supported for general purpose buckets for backward
compatibility.
For the related API description, see
[GetBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html).
Lifecyle configurations for directory buckets only support expiring objects and
cancelling multipart uploads. Expiring of versioned objects, transitions and tag
filters
are not supported.
## Definitions
### Permissions
**General purpose bucket permissions** - By
default, all Amazon S3 resources are private, including buckets, objects, and
related subresources (for example, lifecycle configuration and website
configuration). Only the resource owner (that is, the Amazon Web Services
account that
created it) can access the resource. The resource owner can optionally grant
access permissions to others by writing an access policy. For this
operation, a user must have the `s3:GetLifecycleConfiguration`
permission.
For more information about permissions, see [Managing Access
Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
**Directory bucket permissions** -
You must have the `s3express:GetLifecycleConfiguration`
permission in an IAM identity-based policy to use this operation.
Cross-account access to this API operation isn't supported. The resource
owner can optionally grant access permissions to others by creating a role
or user for them as long as they are within the same account as the owner
and resource.
For more information about directory bucket policies and permissions, see
[Authorizing Regional endpoint APIs with IAM](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the
*Amazon S3 User Guide*.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host
header syntax is
`s3express-control.*region*.amazonaws.com`.
`GetBucketLifecycleConfiguration` has the following special error:
*
Error code: `NoSuchLifecycleConfiguration`
*
Description: The lifecycle configuration does not exist.
*
HTTP Status Code: 404 Not Found
*
SOAP Fault Code Prefix: Client
The following operations are related to
`GetBucketLifecycleConfiguration`:
*
[GetBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html)
*
[PutBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)
*
[DeleteBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)
"""
@spec get_bucket_lifecycle_configuration(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_lifecycle_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_lifecycle_configuration(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?lifecycle"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-transition-default-minimum-object-size", "TransitionDefaultMinimumObjectSize"}
]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the Region the bucket resides in. You set the bucket's Region using the
`LocationConstraint` request parameter in a `CreateBucket`
request. For more information, see
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). When you use this API operation with an access point, provide the alias of the
access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name.
If the Object Lambda access point alias in a request is not valid, the error
code `InvalidAccessPointAliasError` is returned.
For more information about `InvalidAccessPointAliasError`, see [List of
Error
Codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).
We recommend that you use
[HeadBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html) to return the Region
that a bucket resides in. For backward compatibility, Amazon S3 continues to
support
GetBucketLocation.
The following operations are related to `GetBucketLocation`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
"""
@spec get_bucket_location(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_location_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_location(%Client{} = client, bucket, expected_bucket_owner \\ nil, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?location"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the logging status of a bucket and the permissions users have to view
and modify
that status.
The following operations are related to `GetBucketLogging`:
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[PutBucketLogging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html)
"""
@spec get_bucket_logging(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_logging_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_logging(%Client{} = client, bucket, expected_bucket_owner \\ nil, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?logging"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the metadata table configuration for a general purpose bucket.
For more
information, see [Accelerating data discovery with S3
Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html)
in the *Amazon S3 User Guide*.
## Definitions
### Permissions
To use this operation, you must have the
`s3:GetBucketMetadataTableConfiguration` permission. For more
information, see [Setting up permissions for configuring metadata
tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html)
in the
*Amazon S3 User Guide*.
The following operations are related to `GetBucketMetadataTableConfiguration`:
*
[CreateBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html)
*
[DeleteBucketMetadataTableConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html)
"""
@spec get_bucket_metadata_table_configuration(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_metadata_table_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_metadata_table_configuration(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?metadataTable"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Gets a metrics configuration (specified by the metrics configuration ID) from
the
bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the
`s3:GetMetricsConfiguration` action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about
permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon
CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to
`GetBucketMetricsConfiguration`:
*
[PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
*
[DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
*
[ListBucketMetricsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
*
[Monitoring Metrics with Amazon
CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)
"""
@spec get_bucket_metrics_configuration(map(), String.t(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_metrics_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_metrics_configuration(
%Client{} = client,
bucket,
id,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?metrics&x-id=GetBucketMetricsConfiguration"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(id) do
[{"id", id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the action returns an empty
`NotificationConfiguration` element.
By default, you must be the bucket owner to read the notification configuration
of a
bucket. However, the bucket owner can use a bucket policy to grant permission to
other
users to read this configuration with the `s3:GetBucketNotification`
permission.
When you use this API operation with an access point, provide the alias of the
access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name.
If the Object Lambda access point alias in a request is not valid, the error
code `InvalidAccessPointAliasError` is returned.
For more information about `InvalidAccessPointAliasError`, see [List of Error
Codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).
For more information about setting and reading the notification configuration on
a
bucket, see [Setting Up Notification of Bucket Events](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
For more information about bucket
policies, see [Using Bucket Policies](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
The following action is related to `GetBucketNotification`:
*
[PutBucketNotification](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html)
"""
@spec get_bucket_notification_configuration(map(), String.t(), String.t() | nil, list()) ::
{:ok, notification_configuration(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_notification_configuration(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?notification"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Retrieves `OwnershipControls` for an Amazon S3 bucket. To use this operation,
you
must have the `s3:GetBucketOwnershipControls` permission. For more information
about Amazon S3 permissions, see [Specifying permissions in a policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html).
For information about Amazon S3 Object Ownership, see [Using Object Ownership](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html).
The following operations are related to `GetBucketOwnershipControls`:
*
`PutBucketOwnershipControls`
*
`DeleteBucketOwnershipControls`
"""
@spec get_bucket_ownership_controls(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_ownership_controls_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_ownership_controls(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?ownershipControls"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the policy of a specified bucket.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
If you are using an identity other than the root user of the Amazon Web Services
account that
owns the bucket, the calling identity must both have the
`GetBucketPolicy` permissions on the specified bucket and belong to
the bucket owner's account in order to use this operation.
If you don't have `GetBucketPolicy` permissions, Amazon S3 returns a
`403 Access Denied` error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's account, Amazon
S3
returns a `405 Method Not Allowed` error.
To ensure that bucket owners don't inadvertently lock themselves out of
their own buckets, the root principal in a bucket owner's Amazon Web Services
account can
perform the `GetBucketPolicy`, `PutBucketPolicy`, and
`DeleteBucketPolicy` API actions, even if their bucket policy
explicitly denies the root principal's access. Bucket owner root principals can
only be blocked from performing these API actions by VPC endpoint policies and
Amazon Web Services Organizations policies.
**General purpose bucket permissions** - The
`s3:GetBucketPolicy` permission is required in a policy. For
more information about general purpose buckets bucket policies, see [Using Bucket Policies and User
Policies](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** -
To grant access to this API operation, you must have the
`s3express:GetBucketPolicy` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
### Example bucket policies
## General purpose buckets example bucket policies
- See [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html)
in the *Amazon S3 User Guide*.
## Directory bucket example bucket policies
- See [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)
in the
*Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following action is related to `GetBucketPolicy`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
"""
@spec get_bucket_policy(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_policy_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_policy(%Client{} = client, bucket, expected_bucket_owner \\ nil, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?policy"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Retrieves the policy status for an Amazon S3 bucket, indicating whether the
bucket is public.
In order to use this operation, you must have the `s3:GetBucketPolicyStatus`
permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a
Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
For more information about when Amazon S3 considers a bucket public, see [The Meaning of
"Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
The following operations are related to `GetBucketPolicyStatus`:
*
[Using Amazon S3 Block Public
Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
*
[GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
[PutPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
*
[DeletePublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
"""
@spec get_bucket_policy_status(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_policy_status_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_policy_status(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?policyStatus"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration
to
all Amazon S3 systems. Therefore, a get request soon after put or delete can
return a wrong
result.
For information about replication configuration, see
[Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the
*Amazon S3 User Guide*.
This action requires permissions for the `s3:GetReplicationConfiguration`
action. For more information about permissions, see [Using Bucket Policies and
User
Policies](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
If you include the `Filter` element in a replication configuration, you must
also include the `DeleteMarkerReplication` and `Priority` elements.
The response also returns those elements.
For information about `GetBucketReplication` errors, see [List of replication-related error
codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList)
The following operations are related to `GetBucketReplication`:
*
[PutBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html)
*
[DeleteBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html)
"""
@spec get_bucket_replication(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_replication_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_replication(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?replication"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the request payment configuration of a bucket. To use this version of
the
operation, you must be the bucket owner. For more information, see [Requester Pays
Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html).
The following operations are related to `GetBucketRequestPayment`:
*
[ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)
"""
@spec get_bucket_request_payment(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_request_payment_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_request_payment(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?requestPayment"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the
`s3:GetBucketTagging` action. By default, the bucket owner has this
permission and can grant this permission to others.
`GetBucketTagging` has the following special error:
*
Error code: `NoSuchTagSet`
*
Description: There is no tag set associated with the bucket.
The following operations are related to `GetBucketTagging`:
*
[PutBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html)
*
[DeleteBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html)
"""
@spec get_bucket_tagging(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_tagging_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_tagging(%Client{} = client, bucket, expected_bucket_owner \\ nil, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?tagging"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state.
If the
MFA Delete status is `enabled`, the bucket owner must use an authentication
device to change the versioning state of the bucket.
The following operations are related to `GetBucketVersioning`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
"""
@spec get_bucket_versioning(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_versioning_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_versioning(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?versioning"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the website configuration for a bucket. To host website on Amazon S3,
you can
configure a bucket as website by adding a website configuration. For more
information about
hosting websites, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
This GET action requires the `S3:GetBucketWebsite` permission. By default,
only the bucket owner can read the bucket website configuration. However, bucket
owners can
allow other users to read the website configuration by writing a bucket policy
granting
them the `S3:GetBucketWebsite` permission.
The following operations are related to `GetBucketWebsite`:
*
[DeleteBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html)
*
[PutBucketWebsite](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html)
"""
@spec get_bucket_website(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_bucket_website_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_bucket_website(%Client{} = client, bucket, expected_bucket_owner \\ nil, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?website"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves an object from Amazon S3.
In the `GetObject` request, specify the full key name for the object.
**General purpose buckets** - Both the virtual-hosted-style
requests and the path-style requests are supported. For a virtual hosted-style
request
example, if you have the object `photos/2006/February/sample.jpg`, specify the
object key name as `/photos/2006/February/sample.jpg`. For a path-style request
example, if you have the object `photos/2006/February/sample.jpg` in the bucket
named `examplebucket`, specify the object key name as
`/examplebucket/photos/2006/February/sample.jpg`. For more information about
request types, see [HTTP Host Header Bucket
Specification](https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket)
in the *Amazon S3 User Guide*.
**Directory buckets** -
Only virtual-hosted-style requests are supported. For a virtual hosted-style
request example, if you have the object `photos/2006/February/sample.jpg` in the
bucket named `amzn-s3-demo-bucket--usw2-az1--x-s3`, specify the object key name
as `/photos/2006/February/sample.jpg`. Also, when you make requests to this API
operation, your requests are sent to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
```
https://*bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - You
must have the required permissions in a policy. To use
`GetObject`, you must have the `READ` access to the
object (or version). If you grant `READ` access to the anonymous
user, the `GetObject` operation returns the object without using
an authorization header. For more information, see [Specifying permissions in a policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
in the
*Amazon S3 User Guide*.
If you include a `versionId` in your request header, you must
have the `s3:GetObjectVersion` permission to access a specific
version of an object. The `s3:GetObject` permission is not
required in this scenario.
If you request the current version of an object without a specific
`versionId` in the request header, only the
`s3:GetObject` permission is required. The
`s3:GetObjectVersion` permission is not required in this
scenario.
If the object that you request doesn’t exist, the error that Amazon S3 returns
depends on whether you also have the `s3:ListBucket`
permission.
If you have the `s3:ListBucket` permission on the
bucket, Amazon S3 returns an HTTP status code `404 Not Found`
error.
If you don’t have the `s3:ListBucket` permission, Amazon S3
returns an HTTP status code `403 Access Denied`
error.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
If
the
object is encrypted using SSE-KMS, you must also have the
`kms:GenerateDataKey` and `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the KMS
key.
### Storage classes
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval
storage class, the S3 Glacier Deep Archive storage class, the
S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep
Archive Access tier,
before you can retrieve the object you must first restore a copy using
[RestoreObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). Otherwise, this operation returns an
`InvalidObjectState` error. For information about restoring archived
objects, see [Restoring Archived
Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html)
in the *Amazon S3 User Guide*.
**Directory buckets ** -
Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One Zone
storage class) in Availability Zones and `ONEZONE_IA` (the S3 One
Zone-Infrequent Access storage class) in Dedicated Local Zones.
Unsupported storage class values won't write a destination object and will
respond with the HTTP status code `400 Bad Request`.
### Encryption
Encryption request headers, like `x-amz-server-side-encryption`,
should not be sent for the `GetObject` requests, if your object uses
server-side encryption with Amazon S3 managed encryption keys (SSE-S3),
server-side
encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer
server-side
encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the
header in your
`GetObject` requests for the object that uses these types of keys,
you’ll get an HTTP `400 Bad Request` error.
**Directory buckets** -
For directory buckets, there are only two supported options for server-side
encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more
information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)
in the *Amazon S3 User Guide*.
### Overriding response header values through the request
There are times when you want to override certain response header values of a
`GetObject` response. For example, you might override the
`Content-Disposition` response header value through your
`GetObject` request.
You can override values for a set of response headers. These modified response
header values are included only in a successful response, that is, when the HTTP
status code `200 OK` is returned. The headers you can override using
the following query parameters in the request are a subset of the headers that
Amazon S3 accepts when you create an object.
The response headers that you can override for the `GetObject`
response are `Cache-Control`, `Content-Disposition`,
`Content-Encoding`, `Content-Language`,
`Content-Type`, and `Expires`.
To override values for a set of response headers in the `GetObject`
response, you can use the following query parameters in the request.
`response-cache-control`
`response-content-disposition`
`response-content-encoding`
`response-content-language`
`response-content-type`
`response-expires`
When you use these parameters, you must sign the request by using either an
Authorization header or a presigned URL. These parameters cannot be used with
an unsigned (anonymous) request.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `GetObject`:
*
[ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)
*
[GetObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
"""
@spec get_object(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_object_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_object_errors()}
def get_object(
%Client{} = client,
bucket,
key,
part_number \\ nil,
response_cache_control \\ nil,
response_content_disposition \\ nil,
response_content_encoding \\ nil,
response_content_language \\ nil,
response_content_type \\ nil,
response_expires \\ nil,
version_id \\ nil,
checksum_mode \\ nil,
expected_bucket_owner \\ nil,
if_match \\ nil,
if_modified_since \\ nil,
if_none_match \\ nil,
if_unmodified_since \\ nil,
range \\ nil,
request_payer \\ nil,
sse_customer_algorithm \\ nil,
sse_customer_key \\ nil,
sse_customer_key_md5 \\ nil,
options \\ []
) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=GetObject"
headers = []
headers =
if !is_nil(checksum_mode) do
[{"x-amz-checksum-mode", checksum_mode} | headers]
else
headers
end
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(if_match) do
[{"If-Match", if_match} | headers]
else
headers
end
headers =
if !is_nil(if_modified_since) do
[{"If-Modified-Since", if_modified_since} | headers]
else
headers
end
headers =
if !is_nil(if_none_match) do
[{"If-None-Match", if_none_match} | headers]
else
headers
end
headers =
if !is_nil(if_unmodified_since) do
[{"If-Unmodified-Since", if_unmodified_since} | headers]
else
headers
end
headers =
if !is_nil(range) do
[{"Range", range} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_algorithm) do
[{"x-amz-server-side-encryption-customer-algorithm", sse_customer_algorithm} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_key) do
[{"x-amz-server-side-encryption-customer-key", sse_customer_key} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_key_md5) do
[{"x-amz-server-side-encryption-customer-key-MD5", sse_customer_key_md5} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(version_id) do
[{"versionId", version_id} | query_params]
else
query_params
end
query_params =
if !is_nil(response_expires) do
[{"response-expires", response_expires} | query_params]
else
query_params
end
query_params =
if !is_nil(response_content_type) do
[{"response-content-type", response_content_type} | query_params]
else
query_params
end
query_params =
if !is_nil(response_content_language) do
[{"response-content-language", response_content_language} | query_params]
else
query_params
end
query_params =
if !is_nil(response_content_encoding) do
[{"response-content-encoding", response_content_encoding} | query_params]
else
query_params
end
query_params =
if !is_nil(response_content_disposition) do
[{"response-content-disposition", response_content_disposition} | query_params]
else
query_params
end
query_params =
if !is_nil(response_cache_control) do
[{"response-cache-control", response_cache_control} | query_params]
else
query_params
end
query_params =
if !is_nil(part_number) do
[{"partNumber", part_number} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-checksum-crc32c", "ChecksumCRC32C"},
{"x-amz-delete-marker", "DeleteMarker"},
{"x-amz-object-lock-retain-until-date", "ObjectLockRetainUntilDate"},
{"x-amz-restore", "Restore"},
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"Content-Type", "ContentType"},
{"x-amz-server-side-encryption-customer-key-MD5", "SSECustomerKeyMD5"},
{"x-amz-object-lock-legal-hold", "ObjectLockLegalHoldStatus"},
{"x-amz-version-id", "VersionId"},
{"accept-ranges", "AcceptRanges"},
{"x-amz-website-redirect-location", "WebsiteRedirectLocation"},
{"Content-Language", "ContentLanguage"},
{"x-amz-checksum-crc64nvme", "ChecksumCRC64NVME"},
{"x-amz-server-side-encryption-customer-algorithm", "SSECustomerAlgorithm"},
{"Content-Encoding", "ContentEncoding"},
{"x-amz-checksum-sha256", "ChecksumSHA256"},
{"ETag", "ETag"},
{"Last-Modified", "LastModified"},
{"Content-Range", "ContentRange"},
{"Expires", "Expires"},
{"x-amz-tagging-count", "TagCount"},
{"x-amz-expiration", "Expiration"},
{"x-amz-replication-status", "ReplicationStatus"},
{"Cache-Control", "CacheControl"},
{"x-amz-storage-class", "StorageClass"},
{"x-amz-checksum-type", "ChecksumType"},
{"x-amz-missing-meta", "MissingMeta"},
{"Content-Length", "ContentLength"},
{"x-amz-object-lock-mode", "ObjectLockMode"},
{"Content-Disposition", "ContentDisposition"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption", "ServerSideEncryption"},
{"x-amz-mp-parts-count", "PartsCount"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-checksum-crc32", "ChecksumCRC32"},
{"x-amz-checksum-sha1", "ChecksumSHA1"}
]
)
options =
Keyword.put(
options,
:receive_body_as_binary?,
true
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the access control list (ACL) of an object. To use this operation, you
must have
`s3:GetObjectAcl` permissions or `READ_ACP` access to the object.
For more information, see [Mapping of ACL permissions and access policy permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping)
in the *Amazon S3
User Guide*
This functionality is not supported for Amazon S3 on Outposts.
By default, GET returns ACL information about the current version of an object.
To
return ACL information about a different version, use the versionId subresource.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
requests to read ACLs are still supported and return the
`bucket-owner-full-control` ACL with the owner being the account that
created the bucket. For more information, see [ Controlling object ownership and disabling
ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the
*Amazon S3 User Guide*.
The following operations are related to `GetObjectAcl`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
*
[DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
"""
@spec get_object_acl(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_object_acl_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_object_acl_errors()}
def get_object_acl(
%Client{} = client,
bucket,
key,
version_id \\ nil,
expected_bucket_owner \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?acl"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(version_id) do
[{"versionId", version_id} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves all the metadata from an object without returning the object itself.
This
operation is useful if you're interested only in an object's metadata.
`GetObjectAttributes` combines the functionality of `HeadObject`
and `ListParts`. All of the data returned with each of those individual calls
can be returned with a single call to `GetObjectAttributes`.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - To
use `GetObjectAttributes`, you must have READ access to the
object. The permissions that you need to use this operation depend on
whether the bucket is versioned. If the bucket is versioned, you need both
the `s3:GetObjectVersion` and
`s3:GetObjectVersionAttributes` permissions for this
operation. If the bucket is not versioned, you need the
`s3:GetObject` and `s3:GetObjectAttributes`
permissions. For more information, see [Specifying Permissions in a
Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
in the
*Amazon S3 User Guide*. If the object that you request does
not exist, the error Amazon S3 returns depends on whether you also have the
`s3:ListBucket` permission.
If you have the `s3:ListBucket` permission on the
bucket, Amazon S3 returns an HTTP status code `404 Not Found`
("no such key") error.
If you don't have the `s3:ListBucket` permission, Amazon S3
returns an HTTP status code `403 Forbidden` ("access
denied") error.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
If
the
object is encrypted with SSE-KMS, you must also have the
`kms:GenerateDataKey` and `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the KMS
key.
### Encryption
Encryption request headers, like `x-amz-server-side-encryption`,
should not be sent for `HEAD` requests if your object uses
server-side encryption with Key Management Service (KMS) keys (SSE-KMS),
dual-layer
server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or
server-side
encryption with Amazon S3 managed encryption keys (SSE-S3). The
`x-amz-server-side-encryption` header is used when you
`PUT` an object to S3 and want to specify the encryption method.
If you include this header in a `GET` request for an object that
uses these types of keys, you’ll get an HTTP `400 Bad Request`
error. It's because the encryption method can't be changed when you retrieve
the object.
If you encrypt an object by using server-side encryption with customer-provided
encryption keys (SSE-C) when you store the object in Amazon S3, then when you
retrieve
the metadata from the object, you must use the following headers to provide the
encryption key for the server to be able to retrieve the object's metadata. The
headers are:
`x-amz-server-side-encryption-customer-algorithm`
`x-amz-server-side-encryption-customer-key`
`x-amz-server-side-encryption-customer-key-MD5`
For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption
Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** -
For directory buckets, there are only two supported options for server-side
encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)
(`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We
recommend that the bucket's default encryption uses the desired encryption
configuration and you don't override the bucket default encryption in your
`CreateSession` requests or `PUT` object requests. Then, new objects
are automatically encrypted with the desired encryption settings. For more
information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)
in the *Amazon S3 User Guide*. For more information about the encryption
overriding behaviors in directory buckets, see [Specifying server-side encryption with KMS for new object
uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).
### Versioning
**Directory buckets** -
S3 Versioning isn't enabled and supported for directory buckets. For this API
operation, only the `null` value of the version ID is supported by directory
buckets. You can only specify `null` to the
`versionId` query parameter in the request.
### Conditional request headers
Consider the following when using request headers:
If both of the `If-Match` and `If-Unmodified-Since`
headers are present in the request as follows, then Amazon S3 returns the HTTP
status code `200 OK` and the data requested:
`If-Match` condition evaluates to
`true`.
`If-Unmodified-Since` condition evaluates to
`false`.
For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).
If both of the `If-None-Match` and
`If-Modified-Since` headers are present in the request as
follows, then Amazon S3 returns the HTTP status code
```
304 Not
Modified
```
:
`If-None-Match` condition evaluates to
`false`.
`If-Modified-Since` condition evaluates to
`true`.
For more information about conditional requests, see [RFC 7232](https://tools.ietf.org/html/rfc7232).
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following actions are related to `GetObjectAttributes`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[GetObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
*
[GetObjectLegalHold](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html)
*
[GetObjectLockConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html)
*
[GetObjectRetention](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html)
*
[GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
*
[HeadObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
"""
@spec get_object_attributes(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_object_attributes_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_object_attributes_errors()}
def get_object_attributes(
%Client{} = client,
bucket,
key,
version_id \\ nil,
expected_bucket_owner \\ nil,
max_parts \\ nil,
object_attributes,
part_number_marker \\ nil,
request_payer \\ nil,
sse_customer_algorithm \\ nil,
sse_customer_key \\ nil,
sse_customer_key_md5 \\ nil,
options \\ []
) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?attributes"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(max_parts) do
[{"x-amz-max-parts", max_parts} | headers]
else
headers
end
headers =
if !is_nil(object_attributes) do
[{"x-amz-object-attributes", object_attributes} | headers]
else
headers
end
headers =
if !is_nil(part_number_marker) do
[{"x-amz-part-number-marker", part_number_marker} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_algorithm) do
[{"x-amz-server-side-encryption-customer-algorithm", sse_customer_algorithm} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_key) do
[{"x-amz-server-side-encryption-customer-key", sse_customer_key} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_key_md5) do
[{"x-amz-server-side-encryption-customer-key-MD5", sse_customer_key_md5} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(version_id) do
[{"versionId", version_id} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-delete-marker", "DeleteMarker"},
{"Last-Modified", "LastModified"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-version-id", "VersionId"}
]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Gets an object's current legal hold status. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to `GetObjectLegalHold`:
*
[GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
"""
@spec get_object_legal_hold(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_object_legal_hold_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_object_legal_hold(
%Client{} = client,
bucket,
key,
version_id \\ nil,
expected_bucket_owner \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?legal-hold"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(version_id) do
[{"versionId", version_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Gets the Object Lock configuration for a bucket. The rule specified in the
Object Lock
configuration will be applied by default to every new object placed in the
specified
bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
The following action is related to `GetObjectLockConfiguration`:
*
[GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
"""
@spec get_object_lock_configuration(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_object_lock_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_object_lock_configuration(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?object-lock"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Retrieves an object's retention settings. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to `GetObjectRetention`:
*
[GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
"""
@spec get_object_retention(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_object_retention_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_object_retention(
%Client{} = client,
bucket,
key,
version_id \\ nil,
expected_bucket_owner \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?retention"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(version_id) do
[{"versionId", version_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns the tag-set of an object. You send the GET request against the tagging
subresource associated with the object.
To use this operation, you must have permission to perform the
`s3:GetObjectTagging` action. By default, the GET action returns information
about current version of an object. For a versioned bucket, you can have
multiple versions
of an object in your bucket. To retrieve tags of any other version, use the
versionId query
parameter. You also need permission for the `s3:GetObjectVersionTagging`
action.
By default, the bucket owner has this permission and can grant this permission
to
others.
For information about the Amazon S3 object tagging feature, see [Object Tagging](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).
The following actions are related to `GetObjectTagging`:
*
[DeleteObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html)
*
[GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
*
[PutObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html)
"""
@spec get_object_tagging(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_object_tagging_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_object_tagging(
%Client{} = client,
bucket,
key,
version_id \\ nil,
expected_bucket_owner \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?tagging"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(version_id) do
[{"versionId", version_id} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-version-id", "VersionId"}]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns torrent files from a bucket. BitTorrent can save you bandwidth when
you're
distributing large files.
You can get torrent only for objects that are less than 5 GB in size, and that
are
not encrypted using server-side encryption with a customer-provided encryption
key.
To use GET, you must have READ access to the object.
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to `GetObjectTorrent`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
"""
@spec get_object_torrent(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, get_object_torrent_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_object_torrent(
%Client{} = client,
bucket,
key,
expected_bucket_owner \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?torrent"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
options =
Keyword.put(
options,
:receive_body_as_binary?,
true
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Retrieves the `PublicAccessBlock` configuration for an Amazon S3 bucket. To use
this operation, you must have the `s3:GetBucketPublicAccessBlock` permission.
For more information about Amazon S3 permissions, see [Specifying Permissions in a
Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
When Amazon S3 evaluates the `PublicAccessBlock` configuration for a bucket or
an object, it checks the `PublicAccessBlock` configuration for both the
bucket (or the bucket that contains the object) and the bucket owner's account.
If the
`PublicAccessBlock` settings are different between the bucket and the
account, Amazon S3 uses the most restrictive combination of the bucket-level and
account-level settings.
For more information about when Amazon S3 considers a bucket or an object
public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
The following operations are related to `GetPublicAccessBlock`:
*
[Using Amazon S3 Block Public
Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
*
[PutPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
*
[GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
[DeletePublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
"""
@spec get_public_access_block(map(), String.t(), String.t() | nil, list()) ::
{:ok, get_public_access_block_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def get_public_access_block(
%Client{} = client,
bucket,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?publicAccessBlock"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
You can use this operation to determine if a bucket exists and if you have
permission to
access it.
The action returns a `200 OK` if the bucket exists and you have
permission to access it.
If the bucket does not exist or you do not have permission to access it, the
`HEAD` request returns a generic `400 Bad Request`,
```
403
Forbidden
```
or `404 Not Found` code. A message body is not included,
so you cannot determine the exception beyond these HTTP response codes.
## Definitions
### Authentication and authorization
**General purpose buckets** - Request to public
buckets that grant the s3:ListBucket permission publicly do not need to be
signed.
All other `HeadBucket` requests must be authenticated and signed by
using IAM credentials (access key ID and secret access key for the IAM
identities). All headers with the `x-amz-` prefix, including
`x-amz-copy-source`, must be signed. For more information, see
[REST Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
**Directory buckets** - You must use IAM
credentials to authenticate and authorize your access to the
`HeadBucket` API operation, instead of using the temporary security
credentials through the `CreateSession` API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your
behalf.
### Permissions
**General purpose bucket permissions** - To
use this operation, you must have permissions to perform the
`s3:ListBucket` action. The bucket owner has this permission
by default and can grant this permission to others. For more information
about permissions, see [Managing access permissions to your Amazon S3
resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions## -
You must have the
`s3express:CreateSession`
** permission in the
`Action` element of a policy. By default, the session is in
the `ReadWrite` mode. If you want to restrict the access, you can
explicitly set the `s3express:SessionMode` condition key to
`ReadOnly` on the bucket.
For more information about example bucket policies, see [Example bucket policies for S3 Express One
Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)
and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for
S3 Express One
Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)
in the *Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
You must make requests for this API operation to the Zonal endpoint. These
endpoints support virtual-hosted-style requests in the format
`https://*bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com`.
Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
"""
@spec head_bucket(map(), String.t(), head_bucket_request(), list()) ::
{:ok, head_bucket_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, head_bucket_errors()}
def head_bucket(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-access-point-alias", "AccessPointAlias"},
{"x-amz-bucket-location-name", "BucketLocationName"},
{"x-amz-bucket-location-type", "BucketLocationType"},
{"x-amz-bucket-region", "BucketRegion"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:head,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
The `HEAD` operation retrieves metadata from an object without returning the
object itself.
This operation is useful if you're interested only in an object's
metadata.
A `HEAD` request has the same options as a `GET` operation on
an object. The response is identical to the `GET` response except that there
is no response body. Because of this, if the `HEAD` request generates an
error, it returns a generic code, such as `400 Bad Request`,
```
403
Forbidden
```
, `404 Not Found`, `405 Method Not Allowed`,
`412 Precondition Failed`, or `304 Not Modified`. It's not
possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see [Common Request
Headers](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html).
## Definitions
### Permissions
**General purpose bucket permissions** - To
use `HEAD`, you must have the `s3:GetObject`
permission. You need the relevant read object (or version) permission for
this operation. For more information, see [Actions, resources, and condition keys for Amazon
S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html) in the
*Amazon S3 User
Guide*. For more information about the permissions to S3 API
operations by S3 resource types, see [Required permissions for Amazon S3 API operations](/AmazonS3/latest/userguide/using-with-s3-policy-actions.html) in the
*Amazon S3 User Guide*.
If the object you request doesn't exist, the error that Amazon S3 returns
depends on whether you also have the `s3:ListBucket`
permission.
If you have the `s3:ListBucket` permission on the
bucket, Amazon S3 returns an HTTP status code `404 Not Found`
error.
If you don’t have the `s3:ListBucket` permission, Amazon S3
returns an HTTP status code `403 Forbidden` error.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
If you enable `x-amz-checksum-mode` in the request and the
object is encrypted with Amazon Web Services Key Management Service (Amazon Web
Services KMS), you must
also have the `kms:GenerateDataKey` and `kms:Decrypt`
permissions in IAM identity-based policies and KMS key policies for the
KMS key to retrieve the checksum of the object.
### Encryption
Encryption request headers, like `x-amz-server-side-encryption`,
should not be sent for `HEAD` requests if your object uses
server-side encryption with Key Management Service (KMS) keys (SSE-KMS),
dual-layer
server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or
server-side
encryption with Amazon S3 managed encryption keys (SSE-S3). The
`x-amz-server-side-encryption` header is used when you
`PUT` an object to S3 and want to specify the encryption method.
If you include this header in a `HEAD` request for an object that
uses these types of keys, you’ll get an HTTP `400 Bad Request`
error. It's because the encryption method can't be changed when you retrieve
the object.
If you encrypt an object by using server-side encryption with customer-provided
encryption keys (SSE-C) when you store the object in Amazon S3, then when you
retrieve
the metadata from the object, you must use the following headers to provide the
encryption key for the server to be able to retrieve the object's metadata. The
headers are:
`x-amz-server-side-encryption-customer-algorithm`
`x-amz-server-side-encryption-customer-key`
`x-amz-server-side-encryption-customer-key-MD5`
For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption
Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the
*Amazon S3 User Guide*.
**Directory bucket ** -
For directory buckets, there are only two supported options for server-side
encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more
information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)
in the *Amazon S3 User Guide*.
### Versioning
If the current version of the object is a delete marker, Amazon S3 behaves as
if the object was deleted and includes
```
x-amz-delete-marker:
true
```
in the response.
If the specified version is a delete marker, the response returns a
`405 Method Not Allowed` error and the
```
Last-Modified:
timestamp
```
response header.
**Directory buckets** -
Delete marker is not supported for directory buckets.
**Directory buckets** -
S3 Versioning isn't enabled and supported for directory buckets. For this API
operation, only the `null` value of the version ID is supported by directory
buckets. You can only specify `null`
to the `versionId` query parameter in the request.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
The following actions are related to `HeadObject`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
"""
@spec head_object(map(), String.t(), String.t(), head_object_request(), list()) ::
{:ok, head_object_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, head_object_errors()}
def head_object(%Client{} = client, bucket, key, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}"
{headers, input} =
[
{"ChecksumMode", "x-amz-checksum-mode"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"IfMatch", "If-Match"},
{"IfModifiedSince", "If-Modified-Since"},
{"IfNoneMatch", "If-None-Match"},
{"IfUnmodifiedSince", "If-Unmodified-Since"},
{"Range", "Range"},
{"RequestPayer", "x-amz-request-payer"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"PartNumber", "partNumber"},
{"ResponseCacheControl", "response-cache-control"},
{"ResponseContentDisposition", "response-content-disposition"},
{"ResponseContentEncoding", "response-content-encoding"},
{"ResponseContentLanguage", "response-content-language"},
{"ResponseContentType", "response-content-type"},
{"ResponseExpires", "response-expires"},
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-checksum-crc32c", "ChecksumCRC32C"},
{"x-amz-delete-marker", "DeleteMarker"},
{"x-amz-object-lock-retain-until-date", "ObjectLockRetainUntilDate"},
{"x-amz-restore", "Restore"},
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"Content-Type", "ContentType"},
{"x-amz-server-side-encryption-customer-key-MD5", "SSECustomerKeyMD5"},
{"x-amz-object-lock-legal-hold", "ObjectLockLegalHoldStatus"},
{"x-amz-version-id", "VersionId"},
{"accept-ranges", "AcceptRanges"},
{"x-amz-website-redirect-location", "WebsiteRedirectLocation"},
{"Content-Language", "ContentLanguage"},
{"x-amz-checksum-crc64nvme", "ChecksumCRC64NVME"},
{"x-amz-server-side-encryption-customer-algorithm", "SSECustomerAlgorithm"},
{"Content-Encoding", "ContentEncoding"},
{"x-amz-checksum-sha256", "ChecksumSHA256"},
{"ETag", "ETag"},
{"x-amz-archive-status", "ArchiveStatus"},
{"Last-Modified", "LastModified"},
{"Content-Range", "ContentRange"},
{"Expires", "Expires"},
{"x-amz-expiration", "Expiration"},
{"x-amz-replication-status", "ReplicationStatus"},
{"Cache-Control", "CacheControl"},
{"x-amz-storage-class", "StorageClass"},
{"x-amz-checksum-type", "ChecksumType"},
{"x-amz-missing-meta", "MissingMeta"},
{"Content-Length", "ContentLength"},
{"x-amz-object-lock-mode", "ObjectLockMode"},
{"Content-Disposition", "ContentDisposition"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption", "ServerSideEncryption"},
{"x-amz-mp-parts-count", "PartsCount"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-checksum-crc32", "ChecksumCRC32"},
{"x-amz-checksum-sha1", "ChecksumSHA1"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:head,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Lists the analytics configurations for the bucket. You can have up to 1,000
analytics
configurations per bucket.
This action supports list pagination and does not return more than 100
configurations at
a time. You should always check the `IsTruncated` element in the response. If
there are no more configurations to list, `IsTruncated` is set to false. If
there are more configurations to list, `IsTruncated` is set to true, and there
will be a value in `NextContinuationToken`. You use the
`NextContinuationToken` value to continue the pagination of the list by
passing the value in continuation-token in the request to `GET` the next
page.
To use this operation, you must have permissions to perform the
`s3:GetAnalyticsConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class
Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
The following operations are related to
`ListBucketAnalyticsConfigurations`:
*
[GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
*
[DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
*
[PutBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
"""
@spec list_bucket_analytics_configurations(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_bucket_analytics_configurations_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_bucket_analytics_configurations(
%Client{} = client,
bucket,
continuation_token \\ nil,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?analytics&x-id=ListBucketAnalyticsConfigurations"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(continuation_token) do
[{"continuation-token", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs
by automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data
with unknown, changing, or unpredictable access patterns, independent of object
size or retention period. If the size of an object is less than 128 KB, it is
not monitored and not eligible for auto-tiering. Smaller objects can be stored,
but they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class.
For more information, see [Storage class for automatically optimizing frequently and infrequently accessed
objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to `ListBucketIntelligentTieringConfigurations` include:
*
[DeleteBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
*
[PutBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
*
[GetBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
"""
@spec list_bucket_intelligent_tiering_configurations(
map(),
String.t(),
String.t() | nil,
list()
) ::
{:ok, list_bucket_intelligent_tiering_configurations_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_bucket_intelligent_tiering_configurations(
%Client{} = client,
bucket,
continuation_token \\ nil,
options \\ []
) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}?intelligent-tiering&x-id=ListBucketIntelligentTieringConfigurations"
headers = []
query_params = []
query_params =
if !is_nil(continuation_token) do
[{"continuation-token", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns a list of inventory configurations for the bucket. You can have up to
1,000
analytics configurations per bucket.
This action supports list pagination and does not return more than 100
configurations at
a time. Always check the `IsTruncated` element in the response. If there are no
more configurations to list, `IsTruncated` is set to false. If there are more
configurations to list, `IsTruncated` is set to true, and there is a value in
`NextContinuationToken`. You use the `NextContinuationToken` value
to continue the pagination of the list by passing the value in
continuation-token in the
request to `GET` the next page.
To use this operation, you must have permissions to perform the
`s3:GetInventoryConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html)
The following operations are related to
`ListBucketInventoryConfigurations`:
*
[GetBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
*
[DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
*
[PutBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
"""
@spec list_bucket_inventory_configurations(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_bucket_inventory_configurations_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_bucket_inventory_configurations(
%Client{} = client,
bucket,
continuation_token \\ nil,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?inventory&x-id=ListBucketInventoryConfigurations"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(continuation_token) do
[{"continuation-token", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Lists the metrics configurations for the bucket. The metrics configurations are
only for
the request metrics of the bucket and do not provide information on daily
storage metrics.
You can have up to 1,000 configurations per bucket.
This action supports list pagination and does not return more than 100
configurations at
a time. Always check the `IsTruncated` element in the response. If there are no
more configurations to list, `IsTruncated` is set to false. If there are more
configurations to list, `IsTruncated` is set to true, and there is a value in
`NextContinuationToken`. You use the `NextContinuationToken` value
to continue the pagination of the list by passing the value in
`continuation-token` in the request to `GET` the next page.
To use this operation, you must have permissions to perform the
`s3:GetMetricsConfiguration` action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about
permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For more information about metrics configurations and CloudWatch request
metrics, see
[Monitoring Metrics with Amazon CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to
`ListBucketMetricsConfigurations`:
*
[PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
*
[GetBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
*
[DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
"""
@spec list_bucket_metrics_configurations(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_bucket_metrics_configurations_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_bucket_metrics_configurations(
%Client{} = client,
bucket,
continuation_token \\ nil,
expected_bucket_owner \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?metrics&x-id=ListBucketMetricsConfigurations"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(continuation_token) do
[{"continuation-token", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns a list of all buckets owned by the authenticated sender of the request.
To grant IAM permission to use
this operation, you must add the `s3:ListAllMyBuckets` policy action.
For information about Amazon S3 buckets, see [Creating, configuring, and working with Amazon S3
buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html).
We strongly recommend using only paginated `ListBuckets` requests. Unpaginated
`ListBuckets` requests are only supported for
Amazon Web Services accounts set to the default general purpose bucket quota of
10,000. If you have an approved
general purpose bucket quota above 10,000, you must send paginated `ListBuckets`
requests to list your account’s buckets.
All unpaginated `ListBuckets` requests will be rejected for Amazon Web Services
accounts with a general purpose bucket quota
greater than 10,000.
"""
@spec list_buckets(
map(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_buckets_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_buckets(
%Client{} = client,
bucket_region \\ nil,
continuation_token \\ nil,
max_buckets \\ nil,
prefix \\ nil,
options \\ []
) do
url_path = "/?x-id=ListBuckets"
headers = []
query_params = []
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(max_buckets) do
[{"max-buckets", max_buckets} | query_params]
else
query_params
end
query_params =
if !is_nil(continuation_token) do
[{"continuation-token", continuation_token} | query_params]
else
query_params
end
query_params =
if !is_nil(bucket_region) do
[{"bucket-region", bucket_region} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of all Amazon S3 directory buckets owned by the authenticated
sender of the
request.
For more information about directory buckets, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)
in the *Amazon S3 User Guide*.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
You must have the `s3express:ListAllMyDirectoryBuckets` permission
in an IAM identity-based policy instead of a bucket policy. Cross-account access
to this API operation isn't supported. This operation can only be performed by
the Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host
header syntax is
`s3express-control.*region*.amazonaws.com`.
The `BucketRegion` response element is not part of the
`ListDirectoryBuckets` Response Syntax.
"""
@spec list_directory_buckets(map(), String.t() | nil, String.t() | nil, list()) ::
{:ok, list_directory_buckets_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_directory_buckets(
%Client{} = client,
continuation_token \\ nil,
max_directory_buckets \\ nil,
options \\ []
) do
url_path = "/?x-id=ListDirectoryBuckets"
headers = []
query_params = []
query_params =
if !is_nil(max_directory_buckets) do
[{"max-directory-buckets", max_directory_buckets} | query_params]
else
query_params
end
query_params =
if !is_nil(continuation_token) do
[{"continuation-token", continuation_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation lists in-progress multipart uploads in a bucket.
An in-progress multipart
upload is a multipart upload that has been initiated by the
`CreateMultipartUpload` request, but has not yet been completed or
aborted.
**Directory buckets** - If multipart uploads in
a directory bucket are in progress, you can't delete the bucket until all the
in-progress multipart uploads are aborted or completed. To delete these
in-progress
multipart uploads, use the `ListMultipartUploads` operation to list the
in-progress multipart uploads in the bucket and use the
`AbortMultipartUpload` operation to abort all the in-progress multipart
uploads.
The `ListMultipartUploads` operation returns a maximum of 1,000 multipart
uploads in the response. The limit of 1,000 multipart uploads is also the
default value.
You can further limit the number of uploads in a response by specifying the
`max-uploads` request parameter. If there are more than 1,000 multipart
uploads that satisfy your `ListMultipartUploads` request, the response returns
an `IsTruncated` element with the value of `true`, a
`NextKeyMarker` element, and a `NextUploadIdMarker` element. To
list the remaining multipart uploads, you need to make subsequent
`ListMultipartUploads` requests. In these requests, include two query
parameters: `key-marker` and `upload-id-marker`. Set the value of
`key-marker` to the `NextKeyMarker` value from the previous
response. Similarly, set the value of `upload-id-marker` to the
`NextUploadIdMarker` value from the previous response.
**Directory buckets** - The
`upload-id-marker` element and the `NextUploadIdMarker` element
aren't supported by directory buckets. To list the additional multipart uploads,
you
only need to set the value of `key-marker` to the `NextKeyMarker`
value from the previous response.
For more information about multipart uploads, see [Uploading Objects Using Multipart
Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)
in the *Amazon S3 User Guide*.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - For
information about permissions required to use the multipart upload API, see
[Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
in the *Amazon S3 User Guide*.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
### Sorting of multipart uploads in response
**General purpose bucket** - In the
`ListMultipartUploads` response, the multipart uploads are
sorted based on two criteria:
Key-based sorting - Multipart uploads are initially sorted
in ascending order based on their object keys.
Time-based sorting - For uploads that share the same object
key, they are further sorted in ascending order based on the upload
initiation time. Among uploads with the same key, the one that was
initiated first will appear before the ones that were initiated
later.
**Directory bucket** - In the
`ListMultipartUploads` response, the multipart uploads aren't
sorted lexicographically based on the object keys.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `ListMultipartUploads`:
*
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
[CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
[AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
"""
@spec list_multipart_uploads(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_multipart_uploads_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_multipart_uploads(
%Client{} = client,
bucket,
delimiter \\ nil,
encoding_type \\ nil,
key_marker \\ nil,
max_uploads \\ nil,
prefix \\ nil,
upload_id_marker \\ nil,
expected_bucket_owner \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?uploads"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(upload_id_marker) do
[{"upload-id-marker", upload_id_marker} | query_params]
else
query_params
end
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(max_uploads) do
[{"max-uploads", max_uploads} | query_params]
else
query_params
end
query_params =
if !is_nil(key_marker) do
[{"key-marker", key_marker} | query_params]
else
query_params
end
query_params =
if !is_nil(encoding_type) do
[{"encoding-type", encoding_type} | query_params]
else
query_params
end
query_params =
if !is_nil(delimiter) do
[{"delimiter", delimiter} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns metadata about all versions of the objects in a bucket. You can also use
request
parameters as selection criteria to return metadata about a subset of all the
object
versions.
To use this operation, you must have permission to perform the
`s3:ListBucketVersions` action. Be aware of the name difference.
A `200 OK` response can contain valid or invalid XML. Make sure to design
your application to parse the contents of the response and handle it
appropriately.
To use this operation, you must have READ access to the bucket.
The following operations are related to `ListObjectVersions`:
*
[ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
"""
@spec list_object_versions(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_object_versions_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_object_versions(
%Client{} = client,
bucket,
delimiter \\ nil,
encoding_type \\ nil,
key_marker \\ nil,
max_keys \\ nil,
prefix \\ nil,
version_id_marker \\ nil,
expected_bucket_owner \\ nil,
optional_object_attributes \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?versions"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(optional_object_attributes) do
[{"x-amz-optional-object-attributes", optional_object_attributes} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(version_id_marker) do
[{"version-id-marker", version_id_marker} | query_params]
else
query_params
end
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(max_keys) do
[{"max-keys", max_keys} | query_params]
else
query_params
end
query_params =
if !is_nil(key_marker) do
[{"key-marker", key_marker} | query_params]
else
query_params
end
query_params =
if !is_nil(encoding_type) do
[{"encoding-type", encoding_type} | query_params]
else
query_params
end
query_params =
if !is_nil(delimiter) do
[{"delimiter", delimiter} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Returns some or all (up to 1,000) of the objects in a bucket. You can use the
request
parameters as selection criteria to return a subset of the objects in a bucket.
A 200 OK
response can contain valid or invalid XML. Be sure to design your application to
parse the
contents of the response and handle it appropriately.
This action has been revised. We recommend that you use the newer version,
[ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html), when developing applications. For backward compatibility,
Amazon S3 continues to support `ListObjects`.
The following operations are related to `ListObjects`:
*
[ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)
"""
@spec list_objects(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_objects_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_objects_errors()}
def list_objects(
%Client{} = client,
bucket,
delimiter \\ nil,
encoding_type \\ nil,
marker \\ nil,
max_keys \\ nil,
prefix \\ nil,
expected_bucket_owner \\ nil,
optional_object_attributes \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(optional_object_attributes) do
[{"x-amz-optional-object-attributes", optional_object_attributes} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(max_keys) do
[{"max-keys", max_keys} | query_params]
else
query_params
end
query_params =
if !is_nil(marker) do
[{"marker", marker} | query_params]
else
query_params
end
query_params =
if !is_nil(encoding_type) do
[{"encoding-type", encoding_type} | query_params]
else
query_params
end
query_params =
if !is_nil(delimiter) do
[{"delimiter", delimiter} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns some or all (up to 1,000) of the objects in a bucket with each request.
You can
use the request parameters as selection criteria to return a subset of the
objects in a
bucket. A `200 OK` response can contain valid or invalid XML. Make sure to
design your application to parse the contents of the response and handle it
appropriately.
For more information about listing objects, see [Listing object keys programmatically](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html)
in the *Amazon S3 User Guide*. To get a list of
your buckets, see
[ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html).
**General purpose bucket** - For general purpose buckets,
`ListObjectsV2` doesn't return prefixes that are related only to
in-progress multipart uploads.
**Directory buckets** - For
directory buckets, `ListObjectsV2` response includes the prefixes that
are related only to in-progress multipart uploads.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in
Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - To
use this operation, you must have READ access to the bucket. You must have
permission to perform the `s3:ListBucket` action. The bucket
owner has this permission by default and can grant this permission to
others. For more information about permissions, see [Permissions Related to Bucket Subresource
Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
### Sorting order of returned objects
**General purpose bucket** - For
general purpose buckets, `ListObjectsV2` returns objects in
lexicographical order based on their key names.
**Directory bucket** - For
directory buckets, `ListObjectsV2` does not return objects in
lexicographical order.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
This section describes the latest revision of this action. We recommend that you
use
this revised API operation for application development. For backward
compatibility, Amazon S3
continues to support the prior version of this API operation,
[ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html).
The following operations are related to `ListObjectsV2`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
"""
@spec list_objects_v2(
map(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_objects_v2_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_objects_v2_errors()}
def list_objects_v2(
%Client{} = client,
bucket,
continuation_token \\ nil,
delimiter \\ nil,
encoding_type \\ nil,
fetch_owner \\ nil,
max_keys \\ nil,
prefix \\ nil,
start_after \\ nil,
expected_bucket_owner \\ nil,
optional_object_attributes \\ nil,
request_payer \\ nil,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?list-type=2"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(optional_object_attributes) do
[{"x-amz-optional-object-attributes", optional_object_attributes} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(start_after) do
[{"start-after", start_after} | query_params]
else
query_params
end
query_params =
if !is_nil(prefix) do
[{"prefix", prefix} | query_params]
else
query_params
end
query_params =
if !is_nil(max_keys) do
[{"max-keys", max_keys} | query_params]
else
query_params
end
query_params =
if !is_nil(fetch_owner) do
[{"fetch-owner", fetch_owner} | query_params]
else
query_params
end
query_params =
if !is_nil(encoding_type) do
[{"encoding-type", encoding_type} | query_params]
else
query_params
end
query_params =
if !is_nil(delimiter) do
[{"delimiter", delimiter} | query_params]
else
query_params
end
query_params =
if !is_nil(continuation_token) do
[{"continuation-token", continuation_token} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the parts that have been uploaded for a specific multipart upload.
To use this operation, you must provide the `upload ID` in the request. You
obtain this uploadID by sending the initiate multipart upload request through
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html). The `ListParts` request returns a maximum of 1,000 uploaded parts. The limit
of 1,000 parts is also the default value. You can restrict the number of parts
in a
response by specifying the `max-parts` request parameter. If your multipart
upload consists of more than 1,000 parts, the response returns an `IsTruncated`
field with the value of `true`, and a `NextPartNumberMarker` element.
To list remaining uploaded parts, in subsequent `ListParts` requests, include
the `part-number-marker` query string parameter and set its value to the
`NextPartNumberMarker` field value from the previous response.
For more information on multipart uploads, see [Uploading Objects Using
Multipart
Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)
in the *Amazon S3 User Guide*.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - For
information about permissions required to use the multipart upload API, see
[Multipart Upload and Permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
in the *Amazon S3 User Guide*.
If the upload was created using server-side encryption with Key Management
Service
(KMS) keys (SSE-KMS) or dual-layer server-side encryption with
Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the
`kms:Decrypt` action for the `ListParts` request to
succeed.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `ListParts`:
*
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
[CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
[AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
[GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
*
[ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
"""
@spec list_parts(
map(),
String.t(),
String.t(),
String.t() | nil,
String.t() | nil,
String.t(),
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
String.t() | nil,
list()
) ::
{:ok, list_parts_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_parts(
%Client{} = client,
bucket,
key,
max_parts \\ nil,
part_number_marker \\ nil,
upload_id,
expected_bucket_owner \\ nil,
request_payer \\ nil,
sse_customer_algorithm \\ nil,
sse_customer_key \\ nil,
sse_customer_key_md5 \\ nil,
options \\ []
) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=ListParts"
headers = []
headers =
if !is_nil(expected_bucket_owner) do
[{"x-amz-expected-bucket-owner", expected_bucket_owner} | headers]
else
headers
end
headers =
if !is_nil(request_payer) do
[{"x-amz-request-payer", request_payer} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_algorithm) do
[{"x-amz-server-side-encryption-customer-algorithm", sse_customer_algorithm} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_key) do
[{"x-amz-server-side-encryption-customer-key", sse_customer_key} | headers]
else
headers
end
headers =
if !is_nil(sse_customer_key_md5) do
[{"x-amz-server-side-encryption-customer-key-MD5", sse_customer_key_md5} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(upload_id) do
[{"uploadId", upload_id} | query_params]
else
query_params
end
query_params =
if !is_nil(part_number_marker) do
[{"part-number-marker", part_number_marker} | query_params]
else
query_params
end
query_params =
if !is_nil(max_parts) do
[{"max-parts", max_parts} | query_params]
else
query_params
end
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-abort-date", "AbortDate"},
{"x-amz-abort-rule-id", "AbortRuleId"},
{"x-amz-request-charged", "RequestCharged"}
]
)
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
This operation is not supported for directory buckets.
Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer
Acceleration is a
bucket-level feature that enables you to perform faster data transfers to Amazon
S3.
To use this operation, you must have permission to perform the
`s3:PutAccelerateConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
The Transfer Acceleration state of a bucket can be set to one of the following
two
values:
*
Enabled – Enables accelerated data transfers to the bucket.
*
Suspended – Disables accelerated data transfers to the bucket.
The
[GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) action returns the transfer acceleration state
of a bucket.
After setting the Transfer Acceleration state of a bucket to Enabled, it might
take up
to thirty minutes before the data transfer rates to the bucket increase.
The name of the bucket used for Transfer Acceleration must be DNS-compliant and
must
not contain periods (".").
For more information about transfer acceleration, see [Transfer
Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
The following operations are related to
`PutBucketAccelerateConfiguration`:
*
[GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html)
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
"""
@spec put_bucket_accelerate_configuration(
map(),
String.t(),
put_bucket_accelerate_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_accelerate_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?accelerate"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets the permissions on an existing bucket using access control lists (ACL). For
more
information, see [Using ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).
To set the ACL of a
bucket, you must have the `WRITE_ACP` permission.
You can use one of the following two ways to set a bucket's permissions:
*
Specify the ACL in the request body
*
Specify permissions using request headers
You cannot specify access permission using both the body and the request
headers.
Depending on your application needs, you may choose to set the ACL on a bucket
using
either the request body or the headers. For example, if you have an existing
application
that updates a bucket ACL using the request body, then you can continue to use
that
approach.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
ACLs
are disabled and no longer affect permissions. You must use policies to grant
access to
your bucket and the objects in it. Requests to set ACLs or update ACLs fail and
return
the `AccessControlListNotSupported` error code. Requests to read ACLs are
still supported. For more information, see [Controlling object ownership](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the *Amazon S3 User Guide*.
## Definitions
### Permissions
You can set access permissions by using one of the following methods:
Specify a canned ACL with the `x-amz-acl` request header. Amazon S3
supports a set of predefined ACLs, known as *canned
ACLs*. Each canned ACL has a predefined set of grantees and
permissions. Specify the canned ACL name as the value of
`x-amz-acl`. If you use this header, you cannot use other
access control-specific headers in your request. For more information, see
[Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
Specify access permissions explicitly with the
`x-amz-grant-read`, `x-amz-grant-read-acp`,
`x-amz-grant-write-acp`, and
`x-amz-grant-full-control` headers. When using these headers,
you specify explicit access permissions and grantees (Amazon Web Services
accounts or Amazon S3
groups) who will receive the permission. If you use these ACL-specific
headers, you cannot use the `x-amz-acl` header to set a canned
ACL. These parameters map to the set of permissions that Amazon S3 supports in
an
ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
You specify each grantee as a type=value pair, where the type is one of
the following:
`id` – if the value specified is the canonical user ID
of an Amazon Web Services account
`uri` – if you are granting permissions to a predefined
group
`emailAddress` – if the value specified is the email
address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following
Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and
Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
in the Amazon Web Services General Reference.
For example, the following `x-amz-grant-write` header grants
create, overwrite, and delete objects permission to LogDelivery group
predefined by Amazon S3 and two Amazon Web Services accounts identified by their
email
addresses.
```
x-amz-grant-write:
uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333",
id="555566667777"
```
You can use either a canned ACL or specify access permissions explicitly. You
cannot do both.
### Grantee Values
You can specify the person (grantee) to whom you're assigning access rights
(using request elements) in the following ways:
By the person's ID:
```
<>ID<><>GranteesEmail<>
```
DisplayName is optional and ignored in the request
By URI:
`<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>`
By Email address:
`<>Grantees@email.com<>&`
The grantee is resolved to the CanonicalUser and, in a response to a GET
Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following
Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and
Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
in the Amazon Web Services General Reference.
The following operations are related to `PutBucketAcl`:
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
*
[GetObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
"""
@spec put_bucket_acl(map(), String.t(), put_bucket_acl_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_acl(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?acl"
{headers, input} =
[
{"ACL", "x-amz-acl"},
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"GrantFullControl", "x-amz-grant-full-control"},
{"GrantRead", "x-amz-grant-read"},
{"GrantReadACP", "x-amz-grant-read-acp"},
{"GrantWrite", "x-amz-grant-write"},
{"GrantWriteACP", "x-amz-grant-write-acp"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets an analytics configuration for the bucket (specified by the analytics
configuration
ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a
comma-separated values (CSV) flat file. See the `DataExport` request element.
Reports are updated daily and are based on the object filters that you
configure. When
selecting data export, you specify a destination bucket and an optional
destination prefix
where the file is written. You can export the data to a destination bucket in a
different
account. However, the destination bucket must be in the same Region as the
bucket that you
are making the PUT analytics configuration to. For more information, see [Amazon S3
Analytics – Storage Class
Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
You must create a bucket policy on the destination bucket where the exported
file is
written to grant permissions to Amazon S3 to write objects to the bucket. For an
example
policy, see [Granting Permissions for Amazon S3 Inventory and Storage Class Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).
To use this operation, you must have permissions to perform the
`s3:PutAnalyticsConfiguration` action. The bucket owner has this permission
by default. The bucket owner can grant this permission to others. For more
information
about permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
`PutBucketAnalyticsConfiguration` has the following special errors:
*
*
*HTTP Error: HTTP 400 Bad Request*
*
*Code: InvalidArgument*
*
*Cause: Invalid argument.*
*
*
*HTTP Error: HTTP 400 Bad Request*
*
*Code: TooManyConfigurations*
*
*Cause: You are attempting to create a new configuration but have
already reached the 1,000-configuration limit.*
*
*
*HTTP Error: HTTP 403 Forbidden*
*
*Code: AccessDenied*
*
*Cause: You are not the owner of the specified bucket, or you do
not have the s3:PutAnalyticsConfiguration bucket permission to set the
configuration on the bucket.*
The following operations are related to
`PutBucketAnalyticsConfiguration`:
*
[GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
*
[DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
*
[ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
"""
@spec put_bucket_analytics_configuration(
map(),
String.t(),
put_bucket_analytics_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_analytics_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?analytics"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets the `cors` configuration for your bucket. If the configuration exists,
Amazon S3 replaces it.
To use this operation, you must be allowed to perform the `s3:PutBucketCORS`
action. By default, the bucket owner has this permission and can grant it to
others.
You set this configuration on a bucket so that the bucket can service
cross-origin
requests. For example, you might want to enable a request whose origin is
`http://www.example.com` to access your Amazon S3 bucket at
`my.example.bucket.com` by using the browser's `XMLHttpRequest`
capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the
`cors` subresource to the bucket. The `cors` subresource is an XML
document in which you configure rules that identify origins and the HTTP methods
that can
be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request)
against a
bucket, it evaluates the `cors` configuration on the bucket and uses the first
`CORSRule` rule that matches the incoming browser request to enable a
cross-origin request. For a rule to match, the following conditions must be met:
*
The request's `Origin` header must match `AllowedOrigin`
elements.
*
The request method (for example, GET, PUT, HEAD, and so on) or the
`Access-Control-Request-Method` header in case of a pre-flight
`OPTIONS` request must be one of the `AllowedMethod`
elements.
*
Every header specified in the `Access-Control-Request-Headers` request
header of a pre-flight request must match an `AllowedHeader` element.
For more information about CORS, go to [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in
the *Amazon S3 User Guide*.
The following operations are related to `PutBucketCors`:
*
[GetBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html)
*
[DeleteBucketCors](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html)
*
[RESTOPTIONSobject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html)
"""
@spec put_bucket_cors(map(), String.t(), put_bucket_cors_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_cors(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?cors"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
options =
Keyword.put(
options,
:append_sha256_content_hash,
true
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation configures default encryption and Amazon S3 Bucket Keys for an
existing
bucket.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
By default, all buckets have a default encryption configuration that uses
server-side
encryption with Amazon S3 managed keys (SSE-S3).
## General purpose buckets
You can optionally configure default encryption for a bucket by using
server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or
dual-layer
server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you
specify
default encryption by using SSE-KMS, you can also configure [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html).
For information about the bucket default encryption
feature, see [Amazon S3 Bucket Default Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
in the *Amazon S3 User Guide*.
If you use PutBucketEncryption to set your [default bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
to SSE-KMS, you should verify that your KMS key ID
is correct. Amazon S3 doesn't validate the KMS key ID provided in
PutBucketEncryption requests.
**Directory buckets ** - You can
optionally configure default encryption for a bucket by using server-side
encryption with Key Management Service (KMS) keys (SSE-KMS).
We recommend that the bucket's default encryption uses the desired
encryption configuration and you don't override the bucket default
encryption in your `CreateSession` requests or `PUT`
object requests. Then, new objects are automatically encrypted with the
desired encryption settings.
For more information about the encryption overriding behaviors in directory
buckets, see [Specifying server-side encryption with KMS for new object uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html).
Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)
per directory bucket's lifetime.
The [Amazon Web Services managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)
(`aws/s3`) isn't supported.
S3 Bucket Keys are always enabled for `GET` and `PUT` operations in a directory
bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy
SSE-KMS encrypted objects from general purpose buckets
to directory buckets, from directory buckets to general purpose buckets, or
between directory buckets, through
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html),
[the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops),
or
[the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job).
In this case, Amazon S3 makes a call to KMS every time a copy request is made
for a KMS-encrypted object.
When you specify an [KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)
for encryption in your directory bucket, only use the key ID or key ARN. The key
alias format of the KMS key isn't supported.
For directory buckets, if you use PutBucketEncryption to set your [default bucket
encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
to SSE-KMS, Amazon S3 validates the
KMS key ID provided in PutBucketEncryption requests.
If you're specifying a customer managed KMS key, we recommend using a fully
qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the
key within the requester’s account. This behavior can result in data that's
encrypted
with a KMS key that belongs to the requester, and not the bucket owner.
Also, this action requires Amazon Web Services Signature Version 4. For more
information, see
[ Authenticating Requests (Amazon Web Services Signature Version
4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
## Definitions
### Permissions
**General purpose bucket permissions** - The
`s3:PutEncryptionConfiguration` permission is required in a
policy. The bucket owner has this permission by default. The bucket owner
can grant this permission to others. For more information about permissions,
see [Permissions Related to Bucket Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** -
To grant access to this API operation, you must have the
`s3express:PutEncryptionConfiguration` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
To set a directory bucket default encryption with SSE-KMS, you must also
have the `kms:GenerateDataKey` and the `kms:Decrypt`
permissions in IAM identity-based policies and KMS key policies for the
target KMS key.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following operations are related to `PutBucketEncryption`:
*
[GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)
*
[DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)
"""
@spec put_bucket_encryption(map(), String.t(), put_bucket_encryption_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_encryption(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?encryption"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can
have up to
1,000 S3 Intelligent-Tiering configurations per bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs
by automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering
delivers automatic cost savings in three low latency and high throughput access
tiers. To get the lowest storage cost on data that can be accessed in minutes to
hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data
with unknown, changing, or unpredictable access patterns, independent of object
size or retention period. If the size of an object is less than 128 KB, it is
not monitored and not eligible for auto-tiering. Smaller objects can be stored,
but they are always charged at the Frequent Access tier rates in the S3
Intelligent-Tiering storage class.
For more information, see [Storage class for automatically optimizing frequently and infrequently accessed
objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
Operations related to `PutBucketIntelligentTieringConfiguration` include:
*
[DeleteBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
*
[GetBucketIntelligentTieringConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
*
[ListBucketIntelligentTieringConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
You only need S3 Intelligent-Tiering enabled on a bucket if you want to
automatically
move objects stored in the S3 Intelligent-Tiering storage class to the Archive
Access
or Deep Archive Access tier.
`PutBucketIntelligentTieringConfiguration` has the following special
errors:
## Definitions
### HTTP 400 Bad Request Error
*Code:* InvalidArgument
*Cause:* Invalid Argument
### HTTP 400 Bad Request Error
*Code:* TooManyConfigurations
*Cause:* You are attempting to create a new configuration
but have already reached the 1,000-configuration limit.
### HTTP 403 Forbidden Error
*Cause:* You are not the owner of the specified bucket, or
you do not have the `s3:PutIntelligentTieringConfiguration` bucket
permission to set the configuration on the bucket.
"""
@spec put_bucket_intelligent_tiering_configuration(
map(),
String.t(),
put_bucket_intelligent_tiering_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_intelligent_tiering_configuration(
%Client{} = client,
bucket,
input,
options \\ []
) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?intelligent-tiering"
headers = []
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
This implementation of the `PUT` action adds an inventory configuration
(identified by the inventory ID) to the bucket. You can have up to 1,000
inventory
configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a
daily or weekly
basis, and the results are published to a flat file. The bucket that is
inventoried is
called the *source* bucket, and the bucket where the inventory flat file
is stored is called the *destination* bucket. The
*destination* bucket must be in the same Amazon Web Services Region as the
*source* bucket.
When you configure an inventory for a *source* bucket, you specify
the *destination* bucket where you want the inventory to be stored, and
whether to generate the inventory daily or weekly. You can also configure what
object
metadata to include and whether to inventory all object versions or only current
versions.
For more information, see [Amazon S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html)
in the
Amazon S3 User Guide.
You must create a bucket policy on the *destination* bucket to
grant permissions to Amazon S3 to write objects to the bucket in the defined
location. For an
example policy, see [ Granting Permissions for Amazon S3 Inventory and Storage Class
Analysis](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).
## Definitions
### Permissions
To use this operation, you must have permission to perform the
`s3:PutInventoryConfiguration` action. The bucket owner has this
permission by default and can grant this permission to others.
The `s3:PutInventoryConfiguration` permission allows a user to
create an [S3 Inventory](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html)
report that includes all object metadata fields available and to specify the
destination bucket to store the inventory. A user with read access to objects in
the destination bucket can also access all object metadata fields that are
available in the inventory report.
To restrict access to an inventory report, see [Restricting access to an Amazon S3 Inventory
report](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10)
in the
*Amazon S3 User Guide*. For more information about the metadata
fields available in S3 Inventory, see [Amazon S3 Inventory lists](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents)
in the *Amazon S3 User Guide*. For
more information about permissions, see [Permissions related to bucket subresource
operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Identity and access management in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the
*Amazon S3 User Guide*.
`PutBucketInventoryConfiguration` has the following special errors:
## Definitions
### HTTP 400 Bad Request Error
*Code:* InvalidArgument
*Cause:* Invalid Argument
### HTTP 400 Bad Request Error
*Code:* TooManyConfigurations
*Cause:* You are attempting to create a new configuration
but have already reached the 1,000-configuration limit.
### HTTP 403 Forbidden Error
*Cause:* You are not the owner of the specified bucket, or
you do not have the `s3:PutInventoryConfiguration` bucket permission to
set the configuration on the bucket.
The following operations are related to
`PutBucketInventoryConfiguration`:
*
[GetBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
*
[DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
*
[ListBucketInventoryConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
"""
@spec put_bucket_inventory_configuration(
map(),
String.t(),
put_bucket_inventory_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_inventory_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?inventory"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new lifecycle configuration for the bucket or replaces an existing
lifecycle
configuration.
Keep in mind that this will overwrite an existing lifecycle configuration,
so if you want to retain any configuration details, they must be included in the
new
lifecycle configuration. For information about lifecycle configuration, see
[Managing your storage
lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html).
Bucket lifecycle configuration now supports specifying a lifecycle rule using an
object key name prefix, one or more object tags, object size, or any combination
of these. Accordingly, this section describes the latest API. The previous
version of the API supported filtering based only on an object key name prefix,
which is supported for backward compatibility.
For the related API description, see
[PutBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html).
## Definitions
### Rules
### Permissions
### HTTP Host header syntax
You specify the lifecycle configuration in your request body. The lifecycle
configuration is specified as XML consisting of one or more rules. An Amazon S3
Lifecycle configuration can have up to 1,000 rules. This limit is not
adjustable.
Bucket lifecycle configuration supports specifying a lifecycle rule using an
object key name prefix, one or more object tags, object size, or any combination
of these. Accordingly, this section describes the latest API. The previous
version
of the API supported filtering based only on an object key name prefix, which is
supported for backward compatibility for general purpose buckets. For the
related
API description, see
[PutBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html).
Lifecyle configurations for directory buckets only support expiring objects and
cancelling multipart uploads. Expiring of versioned objects,transitions and tag
filters are not supported.
A lifecycle rule consists of the following:
A filter identifying a subset of objects to which the rule applies. The
filter can be based on a key name prefix, object tags, object size, or any
combination of these.
A status indicating whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want
Amazon S3 to perform on the objects identified by the filter. If the state of
your bucket is versioning-enabled or versioning-suspended, you can have many
versions of the same object (one current version and zero or more noncurrent
versions). Amazon S3 provides predefined actions that you can specify for
current
and noncurrent object versions.
For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)
and [Lifecycle Configuration Elements](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html).
**General purpose bucket permissions** - By
default, all Amazon S3 resources are private, including buckets, objects, and
related subresources (for example, lifecycle configuration and website
configuration). Only the resource owner (that is, the Amazon Web Services
account that
created it) can access the resource. The resource owner can optionally grant
access permissions to others by writing an access policy. For this
operation, a user must have the `s3:PutLifecycleConfiguration`
permission.
You can also explicitly deny permissions. An explicit deny also
supersedes any other permissions. If you want to block users or accounts
from removing or deleting objects from your bucket, you must deny them
permissions for the following actions:
`s3:DeleteObject`
`s3:DeleteObjectVersion`
`s3:PutLifecycleConfiguration`
For more information about permissions, see [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
**Directory bucket permissions** -
You must have the `s3express:PutLifecycleConfiguration`
permission in an IAM identity-based policy to use this operation.
Cross-account access to this API operation isn't supported. The resource
owner can optionally grant access permissions to others by creating a role
or user for them as long as they are within the same account as the owner
and resource.
For more information about directory bucket policies and permissions, see
[Authorizing Regional endpoint APIs with IAM](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the
*Amazon S3 User Guide*.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
**Directory buckets ** - The HTTP Host
header syntax is
`s3express-control.*region*.amazonaws.com`.
The following operations are related to
`PutBucketLifecycleConfiguration`:
[GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
[DeleteBucketLifecycle](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)
"""
@spec put_bucket_lifecycle_configuration(
map(),
String.t(),
put_bucket_lifecycle_configuration_request(),
list()
) ::
{:ok, put_bucket_lifecycle_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_lifecycle_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?lifecycle"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"TransitionDefaultMinimumObjectSize", "x-amz-transition-default-minimum-object-size"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-transition-default-minimum-object-size", "TransitionDefaultMinimumObjectSize"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Set the logging parameters for a bucket and to specify permissions for who can
view and
modify the logging parameters. All logs are saved to buckets in the same Amazon
Web Services Region as
the source bucket. To set the logging status of a bucket, you must be the bucket
owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the
`Grantee` request element to grant access to other people. The
`Permissions` request element specifies the kind of access the grantee has to
the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for
S3
Object Ownership, you can't use the `Grantee` request element to grant access
to others. Permissions can only be granted using policies. For more information,
see
[Permissions for server access log delivery](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general)
in the
*Amazon S3 User Guide*.
## Definitions
### Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (by
using request elements) in the following ways:
By the person's ID:
```
<>ID<><>GranteesEmail<>
```
`DisplayName` is optional and ignored in the request.
By Email address:
` <>Grantees@email.com<>`
The grantee is resolved to the `CanonicalUser` and, in a
response to a `GETObjectAcl` request, appears as the
CanonicalUser.
By URI:
`<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>`
To enable logging, you use `LoggingEnabled` and its children request
elements. To disable logging, you use an empty `BucketLoggingStatus` request
element:
``
For more information about server access logging, see [Server Access Logging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html)
in the
*Amazon S3 User Guide*.
For more information about creating a bucket, see
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). For more
information about returning the logging status of a bucket, see
[GetBucketLogging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html).
The following operations are related to `PutBucketLogging`:
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[GetBucketLogging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html)
"""
@spec put_bucket_logging(map(), String.t(), put_bucket_logging_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_logging(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?logging"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets a metrics configuration (specified by the metrics configuration ID) for the
bucket.
You can have up to 1,000 metrics configurations per bucket. If you're updating
an existing
metrics configuration, note that this is a full replacement of the existing
metrics
configuration. If you don't include the elements you want to keep, they are
erased.
To use this operation, you must have permissions to perform the
`s3:PutMetricsConfiguration` action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about
permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon
CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
The following operations are related to
`PutBucketMetricsConfiguration`:
*
[DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
*
[GetBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
*
[ListBucketMetricsConfigurations](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
`PutBucketMetricsConfiguration` has the following special error:
*
Error code: `TooManyConfigurations`
*
Description: You are attempting to create a new configuration but have
already reached the 1,000-configuration limit.
*
HTTP Status Code: HTTP 400 Bad Request
"""
@spec put_bucket_metrics_configuration(
map(),
String.t(),
put_bucket_metrics_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_metrics_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?metrics"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"Id", "id"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Enables notifications of specified events for a bucket. For more information
about event
notifications, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
Using this API, you can replace an existing notification configuration. The
configuration is an XML file that defines the event types that you want Amazon
S3 to publish and
the destination where you want Amazon S3 to publish an event notification when
it detects an
event of the specified type.
By default, your bucket has no event notifications configured. That is, the
notification
configuration will be an empty `NotificationConfiguration`.
``
``
This action replaces the existing notification configuration with the
configuration you
include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple
Notification
Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination
exists, and
that the bucket owner has permission to publish to it by sending a test
notification. In
the case of Lambda destinations, Amazon S3 verifies that the Lambda function
permissions
grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For
more information,
see [Configuring Notifications for Amazon S3 Events](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
You can disable notifications by adding the empty NotificationConfiguration
element.
For more information about the number of event notification configurations that
you can
create per bucket, see [Amazon S3 service quotas](https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3) in
*Amazon Web Services
General Reference*.
By default, only the bucket owner can configure notifications on a bucket.
However,
bucket owners can use a bucket policy to grant permission to other users to set
this
configuration with the required `s3:PutBucketNotification` permission.
The PUT notification is an atomic operation. For example, suppose your
notification
configuration includes SNS topic, SQS queue, and Lambda function configurations.
When
you send a PUT request with this configuration, Amazon S3 sends test messages to
your SNS
topic. If the message fails, the entire PUT action will fail, and Amazon S3 will
not add the
configuration to your bucket.
If the configuration in the request body includes only one
`TopicConfiguration` specifying only the
`s3:ReducedRedundancyLostObject` event type, the response will also include
the `x-amz-sns-test-message-id` header containing the message ID of the test
notification sent to the topic.
The following action is related to
`PutBucketNotificationConfiguration`:
*
[GetBucketNotificationConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html)
"""
@spec put_bucket_notification_configuration(
map(),
String.t(),
put_bucket_notification_configuration_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_notification_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?notification"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"SkipDestinationValidation", "x-amz-skip-destination-validation"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Creates or modifies `OwnershipControls` for an Amazon S3 bucket. To use this
operation, you must have the `s3:PutBucketOwnershipControls` permission. For
more information about Amazon S3 permissions, see [Specifying permissions in a policy](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html).
For information about Amazon S3 Object Ownership, see [Using object ownership](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html).
The following operations are related to `PutBucketOwnershipControls`:
*
`GetBucketOwnershipControls`
*
`DeleteBucketOwnershipControls`
"""
@spec put_bucket_ownership_controls(
map(),
String.t(),
put_bucket_ownership_controls_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_ownership_controls(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?ownershipControls"
{headers, input} =
[
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
**Directory buckets ** - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
```
https://s3express-control.*region-code*.amazonaws.com/*bucket-name*
```
. Virtual-hosted-style requests aren't supported.
For more information about endpoints in Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
If you are using an identity other than the root user of the Amazon Web Services
account that
owns the bucket, the calling identity must both have the
`PutBucketPolicy` permissions on the specified bucket and belong to
the bucket owner's account in order to use this operation.
If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a
`403 Access Denied` error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's account, Amazon
S3
returns a `405 Method Not Allowed` error.
To ensure that bucket owners don't inadvertently lock themselves out of
their own buckets, the root principal in a bucket owner's Amazon Web Services
account can
perform the `GetBucketPolicy`, `PutBucketPolicy`, and
`DeleteBucketPolicy` API actions, even if their bucket policy
explicitly denies the root principal's access. Bucket owner root principals can
only be blocked from performing these API actions by VPC endpoint policies and
Amazon Web Services Organizations policies.
**General purpose bucket permissions** - The
`s3:PutBucketPolicy` permission is required in a policy. For
more information about general purpose buckets bucket policies, see [Using Bucket Policies and User
Policies](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** -
To grant access to this API operation, you must have the
`s3express:PutBucketPolicy` permission in
an IAM identity-based policy instead of a bucket policy. Cross-account access to
this API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource.
For more information about directory bucket policies and permissions, see
[Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html)
in the *Amazon S3 User Guide*.
### Example bucket policies
## General purpose buckets example bucket policies
- See [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html)
in the *Amazon S3 User Guide*.
## Directory bucket example bucket policies
- See [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)
in the
*Amazon S3 User Guide*.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
`s3express-control.*region-code*.amazonaws.com`.
The following operations are related to `PutBucketPolicy`:
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
"""
@spec put_bucket_policy(map(), String.t(), put_bucket_policy_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_policy(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?policy"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ConfirmRemoveSelfBucketAccess", "x-amz-confirm-remove-self-bucket-access"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Creates a replication configuration or replaces an existing one. For more
information,
see
[Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.
Specify the replication configuration in the request body. In the replication
configuration, you provide the name of the destination bucket or buckets where
you want
Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to
replicate objects on your
behalf, and other relevant information. You can invoke this request for a
specific Amazon Web Services
Region by using the [
`aws:RequestedRegion`
](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion)
condition key.
A replication configuration must include at least one rule, and can contain a
maximum of
1,000. Each rule identifies a subset of objects to replicate by filtering the
objects in
the source bucket. To choose additional subsets of objects to replicate, add a
rule for
each subset.
To specify a subset of the objects in the source bucket to apply a replication
rule to,
add the Filter element as a child of the Rule element. You can filter objects
based on an
object key prefix, one or more object tags, or both. When you add the Filter
element in the
configuration, you must also add the following elements:
`DeleteMarkerReplication`, `Status`, and
`Priority`.
If you are using an earlier version of the replication configuration, Amazon S3
handles
replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).
For information about enabling versioning on a bucket, see [Using Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html).
## Definitions
### Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using
server-side encryption with KMS keys. To replicate Amazon Web Services
KMS-encrypted objects,
add the following: `SourceSelectionCriteria`,
`SseKmsEncryptedObjects`, `Status`,
`EncryptionConfiguration`, and `ReplicaKmsKeyID`. For
information about replication configuration, see [Replicating Objects Created with SSE Using KMS
keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html).
For information on `PutBucketReplication` errors, see [List of replication-related error
codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList)
### Permissions
To create a `PutBucketReplication` request, you must have
`s3:PutReplicationConfiguration` permissions for the bucket.
By default, a resource owner, in this case the Amazon Web Services account that
created the
bucket, can perform this operation. The resource owner can also grant others
permissions to perform the operation. For more information about permissions,
see
[Specifying Permissions in a
Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
To perform this operation, the user or role performing the action must have
the
[iam:PassRole](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) permission.
The following operations are related to `PutBucketReplication`:
*
[GetBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html)
*
[DeleteBucketReplication](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html)
"""
@spec put_bucket_replication(map(), String.t(), put_bucket_replication_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_replication(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?replication"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"Token", "x-amz-bucket-object-lock-token"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets the request payment configuration for a bucket. By default, the bucket
owner pays
for downloads from the bucket. This configuration parameter enables the bucket
owner (only)
to specify that the person requesting the download will be charged for the
download. For
more information, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html).
The following operations are related to `PutBucketRequestPayment`:
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[GetBucketRequestPayment](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html)
"""
@spec put_bucket_request_payment(
map(),
String.t(),
put_bucket_request_payment_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_request_payment(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?requestPayment"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets the tags for a bucket.
Use tags to organize your Amazon Web Services bill to reflect your own cost
structure. To do this,
sign up to get your Amazon Web Services account bill with tag key values
included. Then, to see the cost
of combined resources, organize your billing information according to resources
with the
same tag key values. For example, you can tag several resources with a specific
application
name, and then organize your billing information to see the total cost of that
application
across several services. For more information, see [Cost Allocation and Tagging](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
and [Using Cost Allocation in Amazon S3 Bucket
Tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html).
When this operation sets the tags for a bucket, it will overwrite any current
tags
the bucket already has. You cannot use this operation to add tags to an existing
list of
tags.
To use this operation, you must have permissions to perform the
`s3:PutBucketTagging` action. The bucket owner has this permission by default
and can grant this permission to others. For more information about permissions,
see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3
Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
`PutBucketTagging` has the following special errors. For more Amazon S3 errors
see, [Error Responses](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html).
*
`InvalidTag` - The tag provided was not a valid tag. This error
can occur if the tag did not pass input validation. For more information, see
[Using Cost Allocation in Amazon S3 Bucket
Tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html).
*
`MalformedXML` - The XML provided does not match the
schema.
*
`OperationAborted` - A conflicting conditional action is
currently in progress against this resource. Please try again.
*
`InternalError` - The service was unable to apply the provided
tag to the bucket.
The following operations are related to `PutBucketTagging`:
*
[GetBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html)
*
[DeleteBucketTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html)
"""
@spec put_bucket_tagging(map(), String.t(), put_bucket_tagging_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_tagging(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?tagging"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
options =
Keyword.put(
options,
:append_sha256_content_hash,
true
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
When you enable versioning on a bucket for the first time, it might take a short
amount of time for the change to be fully propagated. While this change is
propagating,
you might encounter intermittent `HTTP 404 NoSuchKey` errors for requests to
objects created or updated after enabling versioning. We recommend that you wait
for 15
minutes after enabling versioning before issuing write operations (`PUT` or
`DELETE`) on objects in the bucket.
Sets the versioning state of an existing bucket.
You can set the versioning state with one of the following values:
**Enabled**—Enables versioning for the objects in the
bucket. All objects added to the bucket receive a unique version ID.
**Suspended**—Disables versioning for the objects in the
bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning
state; a
[GetBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) request does not return a versioning state value.
In order to enable MFA Delete, you must be the bucket owner. If you are the
bucket owner
and want to enable MFA Delete in the bucket versioning configuration, you must
include the
`x-amz-mfa request` header and the `Status` and the
`MfaDelete` request elements in a request to set the versioning state of the
bucket.
If you have an object expiration lifecycle configuration in your non-versioned
bucket
and you want to maintain the same permanent delete behavior when you enable
versioning,
you must add a noncurrent expiration policy. The noncurrent expiration lifecycle
configuration will manage the deletes of the noncurrent object versions in the
version-enabled bucket. (A version-enabled bucket maintains one current and zero
or more
noncurrent object versions.) For more information, see [Lifecycle and
Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config).
The following operations are related to `PutBucketVersioning`:
*
[CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
*
[DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
*
[GetBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html)
"""
@spec put_bucket_versioning(map(), String.t(), put_bucket_versioning_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_versioning(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?versioning"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"MFA", "x-amz-mfa"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets the configuration of the website that is specified in the `website`
subresource. To configure a bucket as a website, you can add this subresource on
the bucket
with website configuration information such as the file name of the index
document and any
redirect rules. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
This PUT action requires the `S3:PutBucketWebsite` permission. By default,
only the bucket owner can configure the website attached to a bucket; however,
bucket
owners can allow other users to set the website configuration by writing a
bucket policy
that grants them the `S3:PutBucketWebsite` permission.
To redirect all website requests sent to the bucket's website endpoint, you add
a
website configuration with the following elements. Because all requests are sent
to another
website, you don't need to provide index document name for the bucket.
*
`WebsiteConfiguration`
*
`RedirectAllRequestsTo`
*
`HostName`
*
`Protocol`
If you want granular control over redirects, you can use the following elements
to add
routing rules that describe conditions for redirecting requests and information
about the
redirect destination. In this case, the website configuration must provide an
index
document for the bucket, because some requests might not be redirected.
*
`WebsiteConfiguration`
*
`IndexDocument`
*
`Suffix`
*
`ErrorDocument`
*
`Key`
*
`RoutingRules`
*
`RoutingRule`
*
`Condition`
*
`HttpErrorCodeReturnedEquals`
*
`KeyPrefixEquals`
*
`Redirect`
*
`Protocol`
*
`HostName`
*
`ReplaceKeyPrefixWith`
*
`ReplaceKeyWith`
*
`HttpRedirectCode`
Amazon S3 has a limitation of 50 routing rules per website configuration. If you
require more
than 50 routing rules, you can use object redirect. For more information, see
[Configuring an Object
Redirect](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html)
in the *Amazon S3 User Guide*.
The maximum request length is limited to 128 KB.
"""
@spec put_bucket_website(map(), String.t(), put_bucket_website_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_bucket_website(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?website"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds an object to a bucket.
Amazon S3 never adds partial objects; if you receive a success response, Amazon
S3 added
the entire object to the bucket. You cannot use `PutObject` to only
update a single piece of metadata for an existing object. You must put the
entire
object with updated metadata if you want to update some values.
If your bucket uses the bucket owner enforced setting for Object Ownership,
ACLs are disabled and no longer affect permissions. All objects written to the
bucket by any account will be owned by the bucket owner.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
Amazon S3 is a distributed system. If it receives multiple write requests for
the same object
simultaneously, it overwrites all but the last object written. However, Amazon
S3 provides
features that can modify this behavior:
*
**S3 Object Lock** - To prevent objects from
being deleted or overwritten, you can use [Amazon S3 Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html) in
the *Amazon S3 User Guide*.
This functionality is not supported for directory buckets.
*
**If-None-Match** - Uploads the object only if the object key name does not
already exist in the specified bucket. Otherwise, Amazon S3 returns a `412
Precondition Failed` error. If a conflicting operation occurs during the upload,
S3 returns a `409 ConditionalRequestConflict` response. On a 409 failure, retry
the upload.
Expects the * character (asterisk).
For more information, see [Add preconditions to S3 operations with conditional requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html)
in the *Amazon S3 User Guide* or [RFC 7232](https://datatracker.ietf.org/doc/rfc7232/).
This functionality is not supported for S3 on Outposts.
*
**S3 Versioning** - When you enable versioning
for a bucket, if Amazon S3 receives multiple write requests for the same object
simultaneously, it stores all versions of the objects. For each write request
that is
made to the same object, Amazon S3 automatically generates a unique version ID
of that
object being stored in Amazon S3. You can retrieve, replace, or delete any
version of the
object. For more information about versioning, see [Adding Objects to Versioning-Enabled
Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html)
in the *Amazon S3 User
Guide*. For information about returning the versioning state of a
bucket, see
[GetBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html).
This functionality is not supported for directory buckets.
## Definitions
### Permissions
**General purpose bucket permissions## - The
following permissions are required in your policies when your
`PutObject` request includes specific headers.
`s3:PutObject`
## -
To successfully complete the `PutObject` request, you must
always have the `s3:PutObject` permission on a bucket to
add an object to it.
`s3:PutObjectAcl`
## - To successfully change the objects ACL of your
`PutObject` request, you must have the
`s3:PutObjectAcl`.
`s3:PutObjectTagging`
** - To successfully set the tag-set with your
`PutObject` request, you must have the
`s3:PutObjectTagging`.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
If the object is encrypted with SSE-KMS, you must also have the
`kms:GenerateDataKey` and `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the KMS
key.
### Data integrity with Content-MD5
**General purpose bucket** - To ensure that
data is not corrupted traversing the network, use the
`Content-MD5` header. When you use this header, Amazon S3 checks
the object against the provided MD5 value and, if they do not match, Amazon S3
returns an error. Alternatively, when the object's ETag is its MD5 digest,
you can calculate the MD5 while putting the object to Amazon S3 and compare the
returned ETag to the calculated MD5 value.
**Directory bucket** -
This functionality is not supported for directory buckets.
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
For more information about related Amazon S3 APIs, see the following:
*
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
*
[DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
"""
@spec put_object(map(), String.t(), String.t(), put_object_request(), list()) ::
{:ok, put_object_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_object_errors()}
def put_object(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=PutObject"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"GrantFullControl", "x-amz-grant-full-control"},
{"ACL", "x-amz-acl"},
{"ChecksumCRC32C", "x-amz-checksum-crc32c"},
{"ObjectLockRetainUntilDate", "x-amz-object-lock-retain-until-date"},
{"RequestPayer", "x-amz-request-payer"},
{"BucketKeyEnabled", "x-amz-server-side-encryption-bucket-key-enabled"},
{"ContentType", "Content-Type"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"},
{"ObjectLockLegalHoldStatus", "x-amz-object-lock-legal-hold"},
{"Tagging", "x-amz-tagging"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"WebsiteRedirectLocation", "x-amz-website-redirect-location"},
{"ContentLanguage", "Content-Language"},
{"ChecksumCRC64NVME", "x-amz-checksum-crc64nvme"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"ContentEncoding", "Content-Encoding"},
{"ChecksumSHA256", "x-amz-checksum-sha256"},
{"IfMatch", "If-Match"},
{"WriteOffsetBytes", "x-amz-write-offset-bytes"},
{"Expires", "Expires"},
{"ContentMD5", "Content-MD5"},
{"IfNoneMatch", "If-None-Match"},
{"GrantWriteACP", "x-amz-grant-write-acp"},
{"SSEKMSEncryptionContext", "x-amz-server-side-encryption-context"},
{"CacheControl", "Cache-Control"},
{"StorageClass", "x-amz-storage-class"},
{"GrantRead", "x-amz-grant-read"},
{"ContentLength", "Content-Length"},
{"ObjectLockMode", "x-amz-object-lock-mode"},
{"ContentDisposition", "Content-Disposition"},
{"ServerSideEncryption", "x-amz-server-side-encryption"},
{"SSEKMSKeyId", "x-amz-server-side-encryption-aws-kms-key-id"},
{"GrantReadACP", "x-amz-grant-read-acp"},
{"ChecksumCRC32", "x-amz-checksum-crc32"},
{"ChecksumSHA1", "x-amz-checksum-sha1"}
]
|> Request.build_params(input)
{custom_headers, input} =
[
{"Metadata", "x-amz-meta-"}
]
|> Request.build_params(input)
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"x-amz-checksum-crc32", "ChecksumCRC32"},
{"x-amz-checksum-crc32c", "ChecksumCRC32C"},
{"x-amz-checksum-crc64nvme", "ChecksumCRC64NVME"},
{"x-amz-checksum-sha1", "ChecksumSHA1"},
{"x-amz-checksum-sha256", "ChecksumSHA256"},
{"x-amz-checksum-type", "ChecksumType"},
{"ETag", "ETag"},
{"x-amz-expiration", "Expiration"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption-customer-algorithm", "SSECustomerAlgorithm"},
{"x-amz-server-side-encryption-customer-key-MD5", "SSECustomerKeyMD5"},
{"x-amz-server-side-encryption-context", "SSEKMSEncryptionContext"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-server-side-encryption", "ServerSideEncryption"},
{"x-amz-object-size", "Size"},
{"x-amz-version-id", "VersionId"}
]
)
options =
Keyword.put(
options,
:send_body_as_binary?,
true
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Uses the `acl` subresource to set the access control list (ACL) permissions
for a new or existing object in an S3 bucket. You must have the `WRITE_ACP`
permission to set the ACL of an object. For more information, see [What permissions can I
grant?](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions)
in the *Amazon S3 User Guide*.
This functionality is not supported for Amazon S3 on Outposts.
Depending on your application needs, you can choose to set the ACL on an object
using
either the request body or the headers. For example, if you have an existing
application
that updates a bucket ACL using the request body, you can continue to use that
approach.
For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html)
in the *Amazon S3 User Guide*.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
ACLs
are disabled and no longer affect permissions. You must use policies to grant
access to
your bucket and the objects in it. Requests to set ACLs or update ACLs fail and
return
the `AccessControlListNotSupported` error code. Requests to read ACLs are
still supported. For more information, see [Controlling object ownership](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
in the *Amazon S3 User Guide*.
## Definitions
### Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the `x-amz-acl` request header. Amazon S3
supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has
a predefined set of grantees and permissions. Specify the canned ACL name as
the value of `x-amz-ac`l. If you use this header, you cannot use
other access control-specific headers in your request. For more information,
see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
Specify access permissions explicitly with the
`x-amz-grant-read`, `x-amz-grant-read-acp`,
`x-amz-grant-write-acp`, and
`x-amz-grant-full-control` headers. When using these headers,
you specify explicit access permissions and grantees (Amazon Web Services
accounts or Amazon S3
groups) who will receive the permission. If you use these ACL-specific
headers, you cannot use `x-amz-acl` header to set a canned ACL.
These parameters map to the set of permissions that Amazon S3 supports in an
ACL.
For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
You specify each grantee as a type=value pair, where the type is one of
the following:
`id` – if the value specified is the canonical user ID
of an Amazon Web Services account
`uri` – if you are granting permissions to a predefined
group
`emailAddress` – if the value specified is the email
address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following
Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and
Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
in the Amazon Web Services General Reference.
For example, the following `x-amz-grant-read` header grants
list objects permission to the two Amazon Web Services accounts identified by
their email
addresses.
```
x-amz-grant-read: emailAddress="xyz@amazon.com",
emailAddress="abc@amazon.com"
```
You can use either a canned ACL or specify access permissions explicitly. You
cannot do both.
### Grantee Values
You can specify the person (grantee) to whom you're assigning access rights
(using request elements) in the following ways:
By the person's ID:
```
<>ID<><>GranteesEmail<>
```
DisplayName is optional and ignored in the request.
By URI:
`<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>`
By Email address:
`<>Grantees@email.com<>lt;/Grantee>`
The grantee is resolved to the CanonicalUser and, in a response to a GET
Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following
Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and
Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
in the Amazon Web Services General Reference.
### Versioning
The ACL of an object is set at the object version level. By default, PUT sets
the ACL of the current version of an object. To set the ACL of a different
version, use the `versionId` subresource.
The following operations are related to `PutObjectAcl`:
*
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
"""
@spec put_object_acl(map(), String.t(), String.t(), put_object_acl_request(), list()) ::
{:ok, put_object_acl_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_object_acl_errors()}
def put_object_acl(%Client{} = client, bucket, key, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?acl"
{headers, input} =
[
{"ACL", "x-amz-acl"},
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"GrantFullControl", "x-amz-grant-full-control"},
{"GrantRead", "x-amz-grant-read"},
{"GrantReadACP", "x-amz-grant-read-acp"},
{"GrantWrite", "x-amz-grant-write"},
{"GrantWriteACP", "x-amz-grant-write-acp"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Applies a legal hold configuration to the specified object. For more
information, see
[Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
This functionality is not supported for Amazon S3 on Outposts.
"""
@spec put_object_legal_hold(
map(),
String.t(),
String.t(),
put_object_legal_hold_request(),
list()
) ::
{:ok, put_object_legal_hold_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_object_legal_hold(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?legal-hold"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified
in the
Object Lock configuration will be applied by default to every new object placed
in the
specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
The `DefaultRetention` settings require both a mode and a
period.
The `DefaultRetention` period can be either `Days` or
`Years` but you must select one. You cannot specify
`Days` and `Years` at the same time.
You can enable Object Lock for new or existing buckets. For more information,
see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
"""
@spec put_object_lock_configuration(
map(),
String.t(),
put_object_lock_configuration_request(),
list()
) ::
{:ok, put_object_lock_configuration_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_object_lock_configuration(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?object-lock"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"RequestPayer", "x-amz-request-payer"},
{"Token", "x-amz-bucket-object-lock-token"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Places an Object Retention configuration on an object. For more information, see
[Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
Users or accounts require the `s3:PutObjectRetention` permission in order to
place an Object Retention configuration on objects. Bypassing a Governance
Retention
configuration requires the `s3:BypassGovernanceRetention` permission.
This functionality is not supported for Amazon S3 on Outposts.
"""
@spec put_object_retention(
map(),
String.t(),
String.t(),
put_object_retention_request(),
list()
) ::
{:ok, put_object_retention_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_object_retention(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?retention"
{headers, input} =
[
{"BypassGovernanceRetention", "x-amz-bypass-governance-retention"},
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-request-charged", "RequestCharged"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Sets the supplied tag-set to an object that already exists in a bucket. A tag is
a
key-value pair. For more information, see [Object Tagging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html).
You can associate tags with an object by sending a PUT request against the
tagging
subresource that is associated with the object. You can retrieve tags by sending
a GET
request. For more information, see
[GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html). For tagging-related restrictions related to characters and encodings, see [Tag
Restrictions](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html).
Note that Amazon S3 limits the maximum number of tags to 10 tags per
object.
To use this operation, you must have permission to perform the
`s3:PutObjectTagging` action. By default, the bucket owner has this
permission and can grant this permission to others.
To put tags of any other version, use the `versionId` query parameter. You
also need permission for the `s3:PutObjectVersionTagging` action.
`PutObjectTagging` has the following special errors. For more Amazon S3 errors
see, [Error Responses](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html).
*
`InvalidTag` - The tag provided was not a valid tag. This error
can occur if the tag did not pass input validation. For more information, see
[Object Tagging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html).
*
`MalformedXML` - The XML provided does not match the
schema.
*
`OperationAborted` - A conflicting conditional action is
currently in progress against this resource. Please try again.
*
`InternalError` - The service was unable to apply the provided
tag to the object.
The following operations are related to `PutObjectTagging`:
*
[GetObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
*
[DeleteObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html)
"""
@spec put_object_tagging(map(), String.t(), String.t(), put_object_tagging_request(), list()) ::
{:ok, put_object_tagging_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_object_tagging(%Client{} = client, bucket, key, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?tagging"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[{"x-amz-version-id", "VersionId"}]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Creates or modifies the `PublicAccessBlock` configuration for an Amazon S3
bucket.
To use this operation, you must have the `s3:PutBucketPublicAccessBlock`
permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a
Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
When Amazon S3 evaluates the `PublicAccessBlock` configuration for a bucket or
an object, it checks the `PublicAccessBlock` configuration for both the
bucket (or the bucket that contains the object) and the bucket owner's account.
If the
`PublicAccessBlock` configurations are different between the bucket and
the account, Amazon S3 uses the most restrictive combination of the bucket-level
and
account-level settings.
For more information about when Amazon S3 considers a bucket or an object
public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
The following operations are related to `PutPublicAccessBlock`:
*
[GetPublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
*
[DeletePublicAccessBlock](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
*
[GetBucketPolicyStatus](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html)
*
[Using Amazon S3 Block
Public
Access](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
"""
@spec put_public_access_block(map(), String.t(), put_public_access_block_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def put_public_access_block(%Client{} = client, bucket, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}?publicAccessBlock"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Restores an archived copy of an object back into Amazon S3
This functionality is not supported for Amazon S3 on Outposts.
This action performs the following types of requests:
*
`restore an archive` - Restore an archived object
For more information about the `S3` structure in the request body, see the
following:
*
[PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
*
[Managing Access with
ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) in
the
*Amazon S3 User Guide*
*
[Protecting Data Using Server-Side Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)
in the
*Amazon S3 User Guide*
## Definitions
### Permissions
To use this operation, you must have permissions to perform the
`s3:RestoreObject` action. The bucket owner has this permission by
default and can grant this permission to others. For more information about
permissions, see [Permissions Related to Bucket Subresource Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
and [Managing Access Permissions to Your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
in the
*Amazon S3 User Guide*.
### Restoring objects
Objects that you archive to the S3 Glacier Flexible Retrieval or S3 Glacier Deep
Archive storage class, and S3 Intelligent-Tiering Archive or
S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For
objects in the
S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
storage classes, you must first initiate a restore request, and then wait until
a
temporary copy of the object is available. If you want a permanent copy of the
object, create a copy of it in the Amazon S3 Standard storage class in your S3
bucket.
To access an archived object, you must restore the object for the duration
(number
of days) that you specify. For objects in the Archive Access or Deep Archive
Access tiers of S3 Intelligent-Tiering, you must first initiate a restore
request,
and then wait until the object is moved into the Frequent Access tier.
To restore a specific object version, you can provide a version ID. If you
don't provide a version ID, Amazon S3 restores the current version.
When restoring an archived object, you can specify one of the following data
access tier options in the `Tier` element of the request body:
`Expedited` - Expedited retrievals allow you to quickly access
your data stored in the S3 Glacier Flexible Retrieval storage class or S3
Intelligent-Tiering Archive tier when occasional urgent requests
for restoring archives are required. For all but the largest archived
objects (250 MB+), data accessed using Expedited retrievals is typically
made available within 1–5 minutes. Provisioned capacity ensures that
retrieval capacity for Expedited retrievals is available when you need it.
Expedited retrievals and provisioned capacity are not available for objects
stored in the S3 Glacier Deep Archive storage class or
S3 Intelligent-Tiering Deep Archive tier.
`Standard` - Standard retrievals allow you to access any of
your archived objects within several hours. This is the default option for
retrieval requests that do not specify the retrieval option. Standard
retrievals typically finish within 3–5 hours for objects stored in the
S3 Glacier Flexible Retrieval storage class or
S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for
objects stored in the S3 Glacier Deep Archive storage class or
S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for
objects stored
in S3 Intelligent-Tiering.
`Bulk` - Bulk retrievals free for objects stored in the
S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,
enabling you to retrieve large amounts, even petabytes, of data at no cost.
Bulk retrievals typically finish within 5–12 hours for objects stored in the
S3 Glacier Flexible Retrieval storage class or
S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost
retrieval option when restoring objects from
S3 Glacier Deep Archive. They typically finish within 48 hours for
objects stored in the S3 Glacier Deep Archive storage class or
S3 Intelligent-Tiering Deep Archive tier.
For more information about archive retrieval options and provisioned capacity
for `Expedited` data access, see [Restoring Archived Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html)
in the *Amazon S3 User Guide*.
You can use Amazon S3 restore speed upgrade to change the restore speed to a
faster
speed while it is in progress. For more information, see [ Upgrading the speed of an in-progress
restore](https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html)
in the
*Amazon S3 User Guide*.
To get the status of object restoration, you can send a `HEAD`
request. Operations return the `x-amz-restore` header, which provides
information about the restoration status, in the response. You can use Amazon S3
event
notifications to notify you when a restore is initiated or completed. For more
information, see [Configuring Amazon S3 Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
in the *Amazon S3 User Guide*.
After restoring an archived object, you can update the restoration period by
reissuing the request with a new period. Amazon S3 updates the restoration
period
relative to the current time and charges only for the request-there are no
data transfer charges. You cannot update the restoration period when Amazon S3
is
actively processing your current restore request for the object.
If your bucket has a lifecycle configuration with a rule that includes an
expiration action, the object expiration overrides the life span that you
specify
in a restore request. For example, if you restore an object copy for 10 days,
but
the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3
days.
For more information about lifecycle configuration, see
[PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) and [Object Lifecycle
Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)
in *Amazon S3 User Guide*.
### Responses
A successful action returns either the `200 OK` or
```
202
Accepted
```
status code.
If the object is not previously restored, then Amazon S3 returns
```
202
Accepted
```
in the response.
If the object is previously restored, Amazon S3 returns `200 OK` in
the response.
Special errors:
*Code: RestoreAlreadyInProgress*
*Cause: Object restore is already in progress.*
*HTTP Status Code: 409 Conflict*
*SOAP Fault Code Prefix: Client*
*Code: GlacierExpeditedRetrievalNotAvailable*
*Cause: expedited retrievals are currently not available.
Try again later. (Returned if there is insufficient capacity to
process the Expedited request. This error applies only to Expedited
retrievals and not to S3 Standard or Bulk retrievals.)*
*HTTP Status Code: 503*
*SOAP Fault Code Prefix: N/A*
The following operations are related to `RestoreObject`:
*
[PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
*
[GetBucketNotificationConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html)
"""
@spec restore_object(map(), String.t(), String.t(), restore_object_request(), list()) ::
{:ok, restore_object_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, restore_object_errors()}
def restore_object(%Client{} = client, bucket, key, input, options \\ []) do
url_path = "/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?restore"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"RequestPayer", "x-amz-request-payer"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"VersionId", "versionId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-restore-output-path", "RestoreOutputPath"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
This action filters the contents of an Amazon S3 object based on a simple
structured query
language (SQL) statement. In the request, along with the SQL expression, you
must also
specify a data serialization format (JSON, CSV, or Apache Parquet) of the
object. Amazon S3 uses
this format to parse object data into records, and returns only records that
match the
specified SQL expression. You must also specify the data serialization format
for the
response.
This functionality is not supported for Amazon S3 on Outposts.
For more information about Amazon S3 Select, see [Selecting Content from Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html)
and [SELECT Command](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html)
in the *Amazon S3 User Guide*.
## Definitions
### Permissions
You must have the `s3:GetObject` permission for this operation. Amazon S3
Select does not support anonymous access. For more information about
permissions,
see [Specifying Permissions in a
Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
in the *Amazon S3 User Guide*.
### Object Data Formats
You can use Amazon S3 Select to query objects that have the following format
properties:
*CSV, JSON, and Parquet* - Objects must be in CSV,
JSON, or Parquet format.
*UTF-8* - UTF-8 is the only encoding type Amazon S3 Select
supports.
*GZIP or BZIP2* - CSV and JSON files can be compressed
using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that
Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports
columnar
compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support
whole-object compression for Parquet objects.
*Server-side encryption* - Amazon S3 Select supports
querying objects that are protected with server-side encryption.
For objects that are encrypted with customer-provided encryption keys
(SSE-C), you must use HTTPS, and you must use the headers that are
documented in the
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html). For more
information about SSE-C, see [Server-Side Encryption (Using Customer-Provided
Encryption
Keys)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
in the *Amazon S3 User Guide*.
For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and
Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled
transparently,
so you don't need to specify anything. For more information about
server-side encryption, including SSE-S3 and SSE-KMS, see [Protecting Data Using Server-Side
Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)
in the
*Amazon S3 User Guide*.
### Working with the Response Body
Given the response size is unknown, Amazon S3 Select streams the response as a
series of messages and includes a `Transfer-Encoding` header with
`chunked` as its value in the response. For more information, see
[Appendix: SelectObjectContent
Response](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html).
### GetObject Support
The `SelectObjectContent` action does not support the following
`GetObject` functionality. For more information, see
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html).
`Range`: Although you can specify a scan range for an Amazon S3 Select
request (see [SelectObjectContentRequest -
ScanRange](https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange)
in the request
parameters), you cannot specify the range of bytes of an object to return.
The `GLACIER`, `DEEP_ARCHIVE`, and
`REDUCED_REDUNDANCY` storage classes, or the
`ARCHIVE_ACCESS` and `DEEP_ARCHIVE_ACCESS` access
tiers of the `INTELLIGENT_TIERING` storage class: You cannot
query objects in the `GLACIER`, `DEEP_ARCHIVE`, or
`REDUCED_REDUNDANCY` storage classes, nor objects in the
`ARCHIVE_ACCESS` or `DEEP_ARCHIVE_ACCESS` access
tiers of the `INTELLIGENT_TIERING` storage class. For more
information about storage classes, see [Using Amazon S3 storage
classes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html)
in the
*Amazon S3 User Guide*.
### Special Errors
For a list of special errors for this operation, see [List of SELECT Object Content Error
Codes](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList)
The following operations are related to `SelectObjectContent`:
*
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
*
[GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
*
[PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
"""
@spec select_object_content(
map(),
String.t(),
String.t(),
select_object_content_request(),
list()
) ::
{:ok, select_object_content_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def select_object_content(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?select&select-type=2"
{headers, input} =
[
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Uploads a part in a multipart upload.
In this operation, you provide new data as a part of an object in your request.
However, you have an option to specify your existing Amazon S3 object as a data
source for
the part you are uploading. To upload a part from an existing object, you use
the
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) operation.
You must initiate a multipart upload (see
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html))
before you can upload any part. In response to your initiate request, Amazon S3
returns an
upload ID, a unique identifier that you must include in your upload part
request.
Part numbers can be any number from 1 to 10,000, inclusive. A part number
uniquely
identifies a part and also defines its position within the object being created.
If you
upload a new part using the same part number that was used with a previous part,
the
previously uploaded part is overwritten.
For information about maximum and minimum part sizes and other multipart upload
specifications, see [Multipart upload limits](https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) in
the *Amazon S3 User Guide*.
After you initiate multipart upload and upload one or more parts, you must
either
complete or abort multipart upload in order to stop getting charged for storage
of the
uploaded parts. Only after you either complete or abort multipart upload, Amazon
S3 frees up
the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to [Multipart Upload Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) in
the
*Amazon S3 User Guide *.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Permissions
**General purpose bucket permissions** - To
perform a multipart upload with encryption using an Key Management Service key,
the
requester must have permission to the `kms:Decrypt` and
`kms:GenerateDataKey` actions on the key. The requester must
also have permissions for the `kms:GenerateDataKey` action for
the `CreateMultipartUpload` API. Then, the requester needs
permissions for the `kms:Decrypt` action on the
`UploadPart` and `UploadPartCopy` APIs.
These permissions are required because Amazon S3 must decrypt and read data
from the encrypted file parts before it completes the multipart upload. For
more information about KMS permissions, see [Protecting data using server-side encryption with
KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)
in the
*Amazon S3 User Guide*. For information about the
permissions required to use the multipart upload API, see [Multipart upload and permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
and [Multipart upload API and permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions** - To grant access to this API operation on a
directory bucket, we recommend that you use the [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) API
operation for session-based authorization. Specifically, you grant the
`s3express:CreateSession` permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the `CreateSession` API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another `CreateSession` API call to generate a new session
token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more
information about authorization, see [
`CreateSession`
](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html).
If the object is encrypted with SSE-KMS, you must also have the
`kms:GenerateDataKey` and `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the KMS
key.
### Data integrity
**General purpose bucket** - To ensure that data
is not corrupted traversing the network, specify the `Content-MD5`
header in the upload part request. Amazon S3 checks the part data against the
provided
MD5 value. If they do not match, Amazon S3 returns an error. If the upload
request is
signed with Signature Version 4, then Amazon Web Services S3 uses the
`x-amz-content-sha256` header as a checksum instead of
`Content-MD5`. For more information see [Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature
Version
4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html).
**Directory buckets** - MD5 is not supported by directory buckets. You can use
checksum algorithms to check object integrity.
### Encryption
**General purpose bucket** - Server-side
encryption is for data encryption at rest. Amazon S3 encrypts your data as it
writes it to disks in its data centers and decrypts it when you access it.
You have mutually exclusive options to protect data using server-side
encryption in Amazon S3, depending on how you choose to manage the encryption
keys. Specifically, the encryption key options are Amazon S3 managed keys
(SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys
(SSE-C).
Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys
(SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest
using server-side encryption with other key options. The option you use
depends on whether you want to use KMS keys (SSE-KMS) or provide your own
encryption key (SSE-C).
Server-side encryption is supported by the S3 Multipart Upload
operations. Unless you are using a customer-provided encryption key (SSE-C),
you don't need to specify the encryption parameters in each UploadPart
request. Instead, you only need to specify the server-side encryption
parameters in the initial Initiate Multipart request. For more information,
see
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html). If you request server-side encryption using a customer-provided
encryption key (SSE-C) in your initiate multipart upload request, you must
provide identical encryption information in each part upload using the
following request headers.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information, see [Using
Server-Side
Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html)
in the
*Amazon S3 User Guide*.
**Directory buckets ** -
For directory buckets, there are only two supported options for server-side
encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)
(`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`).
### Special errors
Error Code: `NoSuchUpload`
Description: The specified multipart upload does not exist. The
upload ID might be invalid, or the multipart upload might have been
aborted or completed.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `UploadPart`:
*
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
[CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
[AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
[ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
"""
@spec upload_part(map(), String.t(), String.t(), upload_part_request(), list()) ::
{:ok, upload_part_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def upload_part(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=UploadPart"
{headers, input} =
[
{"ChecksumAlgorithm", "x-amz-sdk-checksum-algorithm"},
{"ChecksumCRC32", "x-amz-checksum-crc32"},
{"ChecksumCRC32C", "x-amz-checksum-crc32c"},
{"ChecksumCRC64NVME", "x-amz-checksum-crc64nvme"},
{"ChecksumSHA1", "x-amz-checksum-sha1"},
{"ChecksumSHA256", "x-amz-checksum-sha256"},
{"ContentLength", "Content-Length"},
{"ContentMD5", "Content-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"RequestPayer", "x-amz-request-payer"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"PartNumber", "partNumber"},
{"UploadId", "uploadId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"x-amz-checksum-crc32", "ChecksumCRC32"},
{"x-amz-checksum-crc32c", "ChecksumCRC32C"},
{"x-amz-checksum-crc64nvme", "ChecksumCRC64NVME"},
{"x-amz-checksum-sha1", "ChecksumSHA1"},
{"x-amz-checksum-sha256", "ChecksumSHA256"},
{"ETag", "ETag"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption-customer-algorithm", "SSECustomerAlgorithm"},
{"x-amz-server-side-encryption-customer-key-MD5", "SSECustomerKeyMD5"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-server-side-encryption", "ServerSideEncryption"}
]
)
options =
Keyword.put(
options,
:send_body_as_binary?,
true
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Uploads a part by copying data from an existing object as data source.
To specify the
data source, you add the request header `x-amz-copy-source` in your request. To
specify a byte range, you add the request header `x-amz-copy-source-range` in
your request.
For information about maximum and minimum part sizes and other multipart upload
specifications, see [Multipart upload limits](https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) in
the *Amazon S3 User Guide*.
Instead of copying data from an existing object as part data, you might use the
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) action to upload new data as a part of an object in your
request.
You must initiate a multipart upload before you can upload any part. In response
to your
initiate request, Amazon S3 returns the upload ID, a unique identifier that you
must include in
your upload part request.
For conceptual information about multipart uploads, see [Uploading Objects Using
Multipart
Upload](https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)
in the *Amazon S3 User Guide*. For information about
copying objects using a single atomic action vs. a multipart upload, see
[Operations on Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html)
in the *Amazon S3 User Guide*.
**Directory buckets** -
For directory buckets, you must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the
format
```
https://*amzn-s3-demo-bucket*.s3express-*zone-id*.*region-code*.amazonaws.com/*key-name*
```
. Path-style requests are not supported. For more information about endpoints in
Availability Zones, see [Regional and Zonal endpoints for directory buckets in Availability
Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html)
in the
*Amazon S3 User Guide*. For more information about endpoints in Local Zones, see
[Concepts for directory buckets in Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html)
in the
*Amazon S3 User Guide*.
## Definitions
### Authentication and authorization
All `UploadPartCopy` requests must be authenticated and signed by
using IAM credentials (access key ID and secret access key for the IAM
identities). All headers with the `x-amz-` prefix, including
`x-amz-copy-source`, must be signed. For more information, see
[REST Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
**Directory buckets** - You must use IAM
credentials to authenticate and authorize your access to the
`UploadPartCopy` API operation, instead of using the temporary
security credentials through the `CreateSession` API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your
behalf.
### Permissions
You must have `READ` access to the source object and
`WRITE` access to the destination bucket.
**General purpose bucket permissions## - You
must have the permissions in a policy based on the bucket types of your
source bucket and destination bucket in an `UploadPartCopy`
operation.
If the source object is in a general purpose bucket, you must have the
`s3:GetObject`
##
permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have the
`s3:PutObject`
**
permission to write the object copy to the destination bucket.
To perform a multipart upload with encryption using an Key Management Service
key, the requester must have permission to the
`kms:Decrypt` and `kms:GenerateDataKey`
actions on the key. The requester must also have permissions for the
`kms:GenerateDataKey` action for the
`CreateMultipartUpload` API. Then, the requester needs
permissions for the `kms:Decrypt` action on the
`UploadPart` and `UploadPartCopy` APIs. These
permissions are required because Amazon S3 must decrypt and read data from
the encrypted file parts before it completes the multipart upload. For
more information about KMS permissions, see [Protecting data using server-side encryption with
KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)
in the
*Amazon S3 User Guide*. For information about the
permissions required to use the multipart upload API, see [Multipart upload and
permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
and [Multipart upload API and permissions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)
in the
*Amazon S3 User Guide*.
**Directory bucket permissions## -
You must have permissions in a bucket policy or an IAM identity-based policy
based on the
source and destination bucket types in an `UploadPartCopy`
operation.
If the source object that you want to copy is in a
directory bucket, you must have the
`s3express:CreateSession`
## permission in
the `Action` element of a policy to read the object. By
default, the session is in the `ReadWrite` mode. If you
want to restrict the access, you can explicitly set the
`s3express:SessionMode` condition key to
`ReadOnly` on the copy source bucket.
If the copy destination is a directory bucket, you must have the
`s3express:CreateSession`
** permission in the
`Action` element of a policy to write the object to the
destination. The `s3express:SessionMode` condition key
cannot be set to `ReadOnly` on the copy destination.
If the object is encrypted with SSE-KMS, you must also have the
`kms:GenerateDataKey` and `kms:Decrypt` permissions
in IAM identity-based policies and KMS key policies for the KMS
key.
For example policies, see [Example bucket policies for S3 Express One Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html)
and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for
S3 Express One
Zone](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html)
in the *Amazon S3 User Guide*.
### Encryption
**General purpose buckets ** -
For information about using
server-side encryption with customer-provided encryption keys with the
`UploadPartCopy` operation, see
[CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) and
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html).
**Directory buckets ** -
For directory buckets, there are only two supported options for server-side
encryption: server-side encryption with Amazon S3 managed keys (SSE-S3)
(`AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). For
more
information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html)
in the *Amazon S3 User Guide*.
For directory buckets, when you perform a
`CreateMultipartUpload` operation and an
`UploadPartCopy` operation, the request headers you provide
in the `CreateMultipartUpload` request must match the default
encryption configuration of the destination bucket.
S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from
general purpose buckets
to directory buckets, from directory buckets to general purpose buckets, or
between directory buckets, through
[UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html). In this case, Amazon S3 makes a call to KMS every time a copy request is made
for a KMS-encrypted object.
### Special errors
Error Code: `NoSuchUpload`
Description: The specified multipart upload does not exist. The
upload ID might be invalid, or the multipart upload might have been
aborted or completed.
HTTP Status Code: 404 Not Found
Error Code: `InvalidRequest`
Description: The specified copy source is not supported as a
byte-range copy source.
HTTP Status Code: 400 Bad Request
### HTTP Host header syntax
**Directory buckets ** - The HTTP Host header syntax is
```
*Bucket-name*.s3express-*zone-id*.*region-code*.amazonaws.com
```
.
The following operations are related to `UploadPartCopy`:
*
[CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
*
[UploadPart](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
*
[CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
*
[AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
*
[ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
*
[ListMultipartUploads](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
"""
@spec upload_part_copy(map(), String.t(), String.t(), upload_part_copy_request(), list()) ::
{:ok, upload_part_copy_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def upload_part_copy(%Client{} = client, bucket, key, input, options \\ []) do
url_path =
"/#{AWS.Util.encode_uri(bucket)}/#{AWS.Util.encode_multi_segment_uri(key)}?x-id=UploadPartCopy"
{headers, input} =
[
{"CopySource", "x-amz-copy-source"},
{"CopySourceIfMatch", "x-amz-copy-source-if-match"},
{"CopySourceIfModifiedSince", "x-amz-copy-source-if-modified-since"},
{"CopySourceIfNoneMatch", "x-amz-copy-source-if-none-match"},
{"CopySourceIfUnmodifiedSince", "x-amz-copy-source-if-unmodified-since"},
{"CopySourceRange", "x-amz-copy-source-range"},
{"CopySourceSSECustomerAlgorithm",
"x-amz-copy-source-server-side-encryption-customer-algorithm"},
{"CopySourceSSECustomerKey", "x-amz-copy-source-server-side-encryption-customer-key"},
{"CopySourceSSECustomerKeyMD5",
"x-amz-copy-source-server-side-encryption-customer-key-MD5"},
{"ExpectedBucketOwner", "x-amz-expected-bucket-owner"},
{"ExpectedSourceBucketOwner", "x-amz-source-expected-bucket-owner"},
{"RequestPayer", "x-amz-request-payer"},
{"SSECustomerAlgorithm", "x-amz-server-side-encryption-customer-algorithm"},
{"SSECustomerKey", "x-amz-server-side-encryption-customer-key"},
{"SSECustomerKeyMD5", "x-amz-server-side-encryption-customer-key-MD5"}
]
|> Request.build_params(input)
custom_headers = []
{query_params, input} =
[
{"PartNumber", "partNumber"},
{"UploadId", "uploadId"}
]
|> Request.build_params(input)
options =
Keyword.put(
options,
:response_header_parameters,
[
{"x-amz-server-side-encryption-bucket-key-enabled", "BucketKeyEnabled"},
{"x-amz-copy-source-version-id", "CopySourceVersionId"},
{"x-amz-request-charged", "RequestCharged"},
{"x-amz-server-side-encryption-customer-algorithm", "SSECustomerAlgorithm"},
{"x-amz-server-side-encryption-customer-key-MD5", "SSECustomerKeyMD5"},
{"x-amz-server-side-encryption-aws-kms-key-id", "SSEKMSKeyId"},
{"x-amz-server-side-encryption", "ServerSideEncryption"}
]
)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This operation is not supported for directory buckets.
Passes transformed objects to a `GetObject` operation when using Object Lambda
access points. For
information about Object Lambda access points, see [Transforming objects with Object Lambda access
points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html)
in the *Amazon S3 User Guide*.
This operation supports metadata that can be returned by
[GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html), in addition to
`RequestRoute`, `RequestToken`, `StatusCode`,
`ErrorCode`, and `ErrorMessage`. The `GetObject`
response metadata is supported so that the `WriteGetObjectResponse` caller,
typically an Lambda function, can provide the same metadata when it internally
invokes
`GetObject`. When `WriteGetObjectResponse` is called by a
customer-owned Lambda function, the metadata returned to the end user
`GetObject` call might differ from what Amazon S3 would normally return.
You can include any number of metadata headers. When including a metadata
header, it
should be prefaced with `x-amz-meta`. For example,
`x-amz-meta-my-custom-header: MyCustomValue`. The primary use case for this
is to forward `GetObject` metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use
with S3 Object Lambda to
detect and redact personally identifiable information (PII) and decompress S3
objects.
These Lambda functions are available in the Amazon Web Services Serverless
Application Repository, and
can be selected through the Amazon Web Services Management Console when you
create your Object Lambda access point.
Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a
natural language processing (NLP) service using machine learning to find
insights and
relationships in text. It automatically detects personally identifiable
information (PII)
such as names, addresses, dates, credit card numbers, and social security
numbers from
documents in your Amazon S3 bucket.
Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a
natural
language processing (NLP) service using machine learning to find insights and
relationships
in text. It automatically redacts personally identifiable information (PII) such
as names,
addresses, dates, credit card numbers, and social security numbers from
documents in your
Amazon S3 bucket.
Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is
equipped to decompress objects stored in S3 in one of six compressed file
formats including
bzip2, gzip, snappy, zlib, zstandard and ZIP.
For information on how to view and use these functions, see [Using Amazon Web
Services built Lambda
functions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html)
in the *Amazon S3 User Guide*.
"""
@spec write_get_object_response(map(), write_get_object_response_request(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def write_get_object_response(%Client{} = client, input, options \\ []) do
url_path = "/WriteGetObjectResponse"
{headers, input} =
[
{"ErrorMessage", "x-amz-fwd-error-message"},
{"ChecksumCRC32C", "x-amz-fwd-header-x-amz-checksum-crc32c"},
{"DeleteMarker", "x-amz-fwd-header-x-amz-delete-marker"},
{"ObjectLockRetainUntilDate", "x-amz-fwd-header-x-amz-object-lock-retain-until-date"},
{"RequestToken", "x-amz-request-token"},
{"Restore", "x-amz-fwd-header-x-amz-restore"},
{"RequestRoute", "x-amz-request-route"},
{"StatusCode", "x-amz-fwd-status"},
{"BucketKeyEnabled", "x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled"},
{"ContentType", "x-amz-fwd-header-Content-Type"},
{"SSECustomerKeyMD5", "x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5"},
{"ObjectLockLegalHoldStatus", "x-amz-fwd-header-x-amz-object-lock-legal-hold"},
{"VersionId", "x-amz-fwd-header-x-amz-version-id"},
{"AcceptRanges", "x-amz-fwd-header-accept-ranges"},
{"ContentLanguage", "x-amz-fwd-header-Content-Language"},
{"ChecksumCRC64NVME", "x-amz-fwd-header-x-amz-checksum-crc64nvme"},
{"SSECustomerAlgorithm",
"x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm"},
{"ContentEncoding", "x-amz-fwd-header-Content-Encoding"},
{"ChecksumSHA256", "x-amz-fwd-header-x-amz-checksum-sha256"},
{"ETag", "x-amz-fwd-header-ETag"},
{"LastModified", "x-amz-fwd-header-Last-Modified"},
{"ErrorCode", "x-amz-fwd-error-code"},
{"ContentRange", "x-amz-fwd-header-Content-Range"},
{"Expires", "x-amz-fwd-header-Expires"},
{"TagCount", "x-amz-fwd-header-x-amz-tagging-count"},
{"Expiration", "x-amz-fwd-header-x-amz-expiration"},
{"ReplicationStatus", "x-amz-fwd-header-x-amz-replication-status"},
{"CacheControl", "x-amz-fwd-header-Cache-Control"},
{"StorageClass", "x-amz-fwd-header-x-amz-storage-class"},
{"MissingMeta", "x-amz-fwd-header-x-amz-missing-meta"},
{"ContentLength", "Content-Length"},
{"ObjectLockMode", "x-amz-fwd-header-x-amz-object-lock-mode"},
{"ContentDisposition", "x-amz-fwd-header-Content-Disposition"},
{"RequestCharged", "x-amz-fwd-header-x-amz-request-charged"},
{"ServerSideEncryption", "x-amz-fwd-header-x-amz-server-side-encryption"},
{"PartsCount", "x-amz-fwd-header-x-amz-mp-parts-count"},
{"SSEKMSKeyId", "x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id"},
{"ChecksumCRC32", "x-amz-fwd-header-x-amz-checksum-crc32"},
{"ChecksumSHA1", "x-amz-fwd-header-x-amz-checksum-sha1"}
]
|> Request.build_params(input)
{custom_headers, input} =
[
{"Metadata", "x-amz-meta-"}
]
|> Request.build_params(input)
query_params = []
options =
Keyword.put(
options,
:send_body_as_binary?,
true
)
meta = metadata() |> Map.put_new(:host_prefix, "{RequestRoute}.")
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
